| Table of Contents | ||
|---|---|---|
|
...
Downloading the Unified Agent & Configuration File
| Info |
|---|
It is advised to use the below commands only once a week to download the latest version of the Unified Agent for performance reasons and not as part of every build. You can do this using a scheduler task, such as cron. |
...
This configuration sets the Unified Agent to scan all the docker repositories named *alpine.* except for the two image tags in the 'exclude' section.
Alternatively, you can leave the docker.excludes parameter commented if you want to scan all your image containers.
Configuration Parameters
Attribute | Type | Description | Required |
|---|---|---|---|
docker.azure.enable | Boolean | Enables pulling Docker Images from Azure Container registry. Note: Verify that the 'docker.scanImages' and 'docker.pull.enable' parameter values are also set to 'true' | Yes |
docker.azure.userName | String | Username for Azure Container registry | Yes |
docker.azure.userPassword | String | Password for Azure Container registry | Yes. Not mandatory if you already logged in manually to your Azure account via the Azure Client CLI. |
docker.azure.registryNames | String | Docker repository names in Azure Container registry separated by a space | Yes |
docker.azure.authenticationType | String | Authentication Type for Azure Container registry. Either “containerRegistry” or "userAccount". | Yes. Default is "userAccount" - case insensitive. |
docker.azure.registryAuthenticationParameters | String | Used in case login is by acr "docker.azure.authenticationType =containerRegistry. Format: “<acr-username>:<acr-password>". | Only if login is by acr "docker.azure.authenticationType =containerRegistry. |
...
| Code Block |
|---|
$ az login -u <username> -p <password> |
| Info |
|---|
Parameters 'docker.scanImages' and 'docker.pull.enable' should be set to true. |
Run the Unified Agent:
...
Scanning Information
The scanner saves your required images and scans all the file system and installed packages. It scans all the image layers and handles archive files in the layers based on the value in the property 'archiveExtractionDepth'.
The Docker image is saved to the temporary directory defined in your environment and is deleted immediately after the scan. The scanning results are presented in a new WhiteSource project identified by the name of the image in the following format: <image <image id> <repository> <tag>.
The project is created in the WhiteSource product specified in the configuration file or command line.
...