Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3

...

Update the configuration file (whitesource-fs-agent.config) that you downloaded in step 2 according to your specific requirements.
Enable the relevant lines by removing the '#' symbol at the beginning of the lines. You can find a description about each line and its meaning here.
Example of values for uncommented lines:

Code Block
languagejava
ddockerdocker.includes=.*alpine.*
docker.excludes=.*2017.10.01.* .*2017.06.01.*
docker.scanImages=true
docker.pull.enable=true
docker.pull.images=.*.*
docker.pull.tags=.*.*
docker.pull.digest=.*.*
docker.delete.force=false
docker.azure.enable=false
docker.azure.registryIds=XXXXXXXXXXXX
docker.pull.maxImages=10
docker.login.sudo=true

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.

...