Skip to content
This repository was archived by the owner on Mar 11, 2020. It is now read-only.

Commit dbe0f2a

Browse files
committed
Updated readme
1 parent 5a5103d commit dbe0f2a

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,20 +54,24 @@ Artifacts
5454
=============
5555

5656
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 :
5858

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``.
6161

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.
6367

6468
Supported Artifacts
6569
===================
6670

6771
This project currently supports discovery of the following artifacts:
6872

73+
- Microsoft Windows Server Roles and Features
6974
- Microsoft Windows Add/Remove Programs (ARP)
70-
- Microsoft Windows Server Active Directory Domain Services (ADDS)
7175
- Microsoft Windows Server Domain Name Server (DNS)
7276
- Microsoft Windows Internet Information Services (IIS)
7377
- HTTP Handlers in IIS configuration

0 commit comments

Comments
 (0)