You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 11, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: README.rst
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,20 +54,24 @@ Artifacts
54
54
=============
55
55
56
56
This project supports discovery of custom artifacts.
57
-
Each artifact is represented by a folder in the ``.\Artifacts`` subdirectory, containing two PowerShell script files:
57
+
Each artifact is represented by a folder that is contained within the ``.\Functions\Private\Artifacts`` subdirectory, containing at least two PowerShell script files that contain :
58
58
59
-
- ``Discover.ps1`` - This script performs discovery of the desired artifact and creates a manifest file. This script *must* accept the following input parameters: ``[string] $MountPath`` and ``[string] $OutputPath``. The script should write an arbitrary JSON "manifest" to the ``$OutputPath``.
60
-
- ``Generate.ps1`` - This script generates the Dockerfile contents for the artifact. This should be the only output emitted from the command. Any output that is emitted from this command will be appended to the ``Dockerfile``. This script *must* support the input parameter: ``[string] $ManifestPath``. The script should read a JSON "manifest" to the ``$ManifestPath``.
59
+
- ``Discover_<artifact>.ps1`` - This script should contain a function by the same name as the filename which will perform the discovery of the desired artifact and create a resulting manifest file. The function *must* accept the following input parameters: ``[string] $MountPath`` and ``[string] $OutputPath``. The script should write an arbitrary JSON "manifest" to the ``$OutputPath``.
60
+
- ``Generate_<artifact>.ps1`` - This script should contain a function by the same name as the filename which will generate the Dockerfile contents for the artifact. This should be the only output emitted from the command. Any output that is emitted from this command will be appended to the ``Dockerfile``. This function *must* support the input parameter: ``[string] $ManifestPath``. The script should read a JSON "manifest" contained within the ``$ManifestPath``.
61
61
62
-
You can add your own discovery artifacts to this project, by issuing a pull request. If you don't wish to share the artifacts publicly, you can simply place them into the module's ``.\Artifacts`` directory on each system that will perform image scans.
62
+
It is also recommended that you also include within the Artifact directory a test script that validates the output from both the Discover and Generate functions for the artifact.
63
+
64
+
You can also include any files within the Artifact directory that may be used to aid in discovering, generating or validating the output for the Artifact.
65
+
66
+
You can add your own discovery artifacts to this project, by issuing a pull request. If you don't wish to share the artifacts publicly, you can simply place them into the module's ``.\Functions\Private\Artifacts`` directory on each system that will perform image scans.
63
67
64
68
Supported Artifacts
65
69
===================
66
70
67
71
This project currently supports discovery of the following artifacts:
68
72
73
+
- Microsoft Windows Server Roles and Features
69
74
- Microsoft Windows Add/Remove Programs (ARP)
70
-
- Microsoft Windows Server Active Directory Domain Services (ADDS)
71
75
- Microsoft Windows Server Domain Name Server (DNS)
72
76
- Microsoft Windows Internet Information Services (IIS)
0 commit comments