Automatic Docker image scans on push using the management console, CLI, and API
Note
You can enable auto scans of Docker images for vulnerabilities on push to Yandex Container Registry in the vulnerability scanner settings without creating any Yandex Cloud Functions functions and triggers.
To configure automatic vulnerability scans of Docker images on push to Yandex Container Registry:
- Prepare your cloud.
- Prepare the environment.
- Create a function.
- Create a trigger.
- Push the Docker image.
- Check the result.
If you no longer need the resources you created, delete them.
Getting started
Sign up for Yandex Cloud and create a billing account:
- Go to the management console
and log in to Yandex Cloud or create an account if you do not have one yet. - On the Yandex Cloud Billing
page, make sure you have a billing account linked and it has theACTIVE
orTRIAL_ACTIVE
status. If you do not have a billing account, create one.
If you have an active billing account, you can go to the cloud page
Learn more about clouds and folders.
Required paid resources
The infrastructure support costs include:
- Fee for storing a Docker image in the registry, a vulnerability scanner, and outgoing traffic (see Yandex Container Registry pricing).
- Fee for invoking functions (see Yandex Cloud Functions pricing).
Prepare the environment
If you do not have the Yandex Cloud CLI yet, install and initialize it.
-
Install and configure Docker.
-
Create a registry to push a Docker image to.
Management consoleCLIAPI- In the management console
, select the folder to create a registry in. - In the list of services, select Container Registry.
- Click Create registry.
- Specify a name for the registry.
- Click Create registry.
Run this command:
yc container registry create --name my-reg
Result:
done id: crpd50616s9a******** folder_id: b1g88tflru0e******** name: my-reg status: ACTIVE created_at: "2019-01-09T14:34:06.601Z"
- In the management console
-
Create a service account named
scanner
and assign it thecontainer-registry.images.scanner
role for the folder where you created the registry.Management consoleCLIAPI- In the management console
, select a folder where you want to create a service account. - At the top of the screen, go to the Service accounts tab.
- Click Create service account.
- Enter a name for the service account.
- Click Add role and select the
container-registry.images.scanner
role. - Click Create.
-
Create a service account:
yc iam service-account create --name service-acc
Result:
id: ajelabcde12f******** folder_id: b0g12ga82bcv******** created_at: "2021-05-17T14:32:18.900092Z" name: service-acc
-
Assign the role to the service account:
yc resource-manager folder add-access-binding <folder_ID> \ --role container-registry.images.scanner \ --subject serviceAccount:<service_account_ID>
Use the create method for the ServiceAccount resource and updateAccessBindings for Folder.
- In the management console
-
Repeat the steps to create a service account named
invoker
and assign it thefunctions.functionInvoker
role for the folder where you created the registry.
Create a function
In Cloud Functions, create a function named scan-on-push
that will run the Docker image scan:
- In the management console
, select the folder where you want to create a function. - Select Cloud Functions.
- Click Create function.
- Enter a name, e.g.,
scan-on-push
, and description for the function. - Click Create.
- Go to Editor and create a version of the function:
- Under Function code:
-
Select the
Bash
runtime environment and click Continue. -
Select how you want to edit the function:
Code editor
. -
In the function edit window, click Create file. In the window that opens, enter
handler.sh
as the file name and click Create. -
Copy the following code to the
handler.sh
file:DATA=$(cat | jq -sr '.[0].messages[0].details') ID=$(echo $DATA | jq -r '.image_id') NAME=$(echo $DATA | jq -r '.repository_name') TAG=$(echo $DATA | jq -r '.tag') yc container image scan --id ${ID} --async 1>&2
-
Specify the entry point:
handler.sh
.
-
- Under Parameters, specify:
- Timeout:
60
- Memory:
128 MB
- Service account:
scanner
- Timeout:
- Click Save changes.
- Under Function code:
-
Create a function named
scan-on-push
:yc serverless function create --name=scan-on-push
Result:
id: d4ejb1799eko******** folder_id: aoek49ghmknn******** created_at: "2021-17-05T14:07:32.134Z" name: scan-on-push log_group_id: eolm8aoq9vcp******** http_invoke_url: https://functions.yandexcloud.net/d4ejb1799eko******** status: ACTIVE
-
Create the
handler.sh
file and paste the following code to it:DATA=$(cat | jq -sr '.[0].messages[0].details') ID=$(echo $DATA | jq -r '.image_id') NAME=$(echo $DATA | jq -r '.repository_name') TAG=$(echo $DATA | jq -r '.tag') yc container image scan --id ${ID} --async 1>&2
-
Create a version of the
scan-on-push
function:yc serverless function version create \ --function-name=scan-on-push \ --runtime bash \ --entrypoint handler.sh \ --memory 128m \ --execution-timeout 60s \ --source-path handler.sh \ --service-account-id <service_account_ID>
Where:
--function-name
: Name of the function whose version you want to create.--runtime
: Runtime environment.--entrypoint
: Entry point in<function_file_name>.<handler_name>
format.--memory
: Amount of RAM.--execution-timeout
: Maximum function running time before the timeout is reached.--source-path
: File with the function code.--service-account-id
: Service account ID.
Result:
done (1s) id: d4egi3pmsd1q******** function_id: d4e275oj7jtp******** ... tags: - $latest log_group_id: ckg6nb0c7uf1********
Use the create and the createVersion methods for the Function resource.
Create a trigger
Create a trigger that will invoke your function when creating a Docker image tag.
- In the management console
, select the folder where you want to create a trigger. - Select Cloud Functions.
- Go to the Triggers tab.
- Click Create trigger.
- Under Basic settings:
- Enter a name and description for the trigger.
- In the Type field, select
Container Registry
.
- Under Container Registry settings:
- In the Registry field, select the registry to push the Docker image to.
- In the Event types field, select the event
Create Docker image tag
.
- Under Function settings:
- Select the
scan-on-push
function. - Specify the
$latest
function version tag. - Specify the
invoker
service account which will invoke the function.
- Select the
- Click Create trigger.
To create a trigger, run the command:
yc serverless trigger create container-registry \
--name <trigger_name> \
--registry-id <registry_ID> \
--events 'create-image-tag' \
--invoke-function-id <function_ID> \
--invoke-function-service-account-id <service_account_ID>
Where:
--name
: Trigger name.--registry-id
: ID of the registry to push the Docker image to.--events
: Events activating the trigger.--invoke-function-id
: Function ID.--invoke-function-service-account-id
: ID of the service account with the permissions to invoke the function.
Result:
id: a1spt834cjmk********
folder_id: b1g86q4m5vej********
created_at: "2021-05-18T20:42:54.898949653Z"
...
function_tag: $latest
service_account_id: aje1insoe23e********
status: ACTIVE
Push the Docker image
-
Run Docker Desktop.
-
Log in to the registry under your username with:
Docker credential helperOAuth tokenIAM token-
Configure Docker to use
docker-credential-yc
:yc container registry configure-docker
Result:
Credential helper is configured in '/home/<user>/.docker/config.json'
Settings are saved in the current user's profile.
Warning
The credential helper only works if you use Docker without
sudo
. To learn how to configure Docker to run under the current user withoutsudo
, see the official Docker documentation . -
Make sure that Docker is configured.
The following line must appear in the
/home/<user>/.docker/config.json
configuration file:"cr.yandex": "yc"
-
You can now use Docker, for example, to push Docker images. You do not need to run the
docker login
command for that.
-
If you do not have an OAuth token yet, get one at this link
. -
Run this command:
echo <OAuth_token> | docker login --username oauth --password-stdin cr.yandex
Result:
Login Succeeded
-
-
Pull a Docker image from Docker Hub
:docker pull ubuntu:20.04
Result:
20.04: Pulling from library/ubuntu Digest: sha256:cf31af331f38d1d7158470e095b132acd126a7180a54f263d386da88******** Status: Image is up to date for ubuntu:20.04 docker.io/library/ubuntu:20.04
-
Assign a tag to the Docker image:
docker tag ubuntu:20.04 cr.yandex/<registry_ID>/ubuntu:20.04
-
Push the Docker image to Container Registry:
docker push cr.yandex/<registry_ID>/ubuntu:20.04
Result:
The push refers to repository [cr.yandex/crpu20rpdc2f********/ubuntu] 2f140462f3bc: Layer already exists 63c99163f472: Layer already exists ccdbb80308cc: Layer already exists 20.04: digest: sha256:86ac87f73641c920fb42cc9612d4fb57b5626b56ea2a19b894d0673f******** size: 943
Check the result
-
View the logs of the
scan-on-push
function and make sure it has executed.Management consoleCLI- In the management console
, select Cloud Functions. - Go to the Functions section and select the
scan-on-push
function. - In the window that opens, go to Logs and specify the time period. The default time period is one hour.
To find out the name or unique ID of a function, get a list of functions in the folder.
View the function execution log:
yc serverless function logs scan-on-push
Result:
2021-05-18 09:27:43 START RequestID: 34dc9533-ed6e-4468-b9f2-2aa0******** Version: b09i2s85a0c1******** 2021-05-18 09:27:43 END RequestID: 34dc9533-ed6e-4468-b9f2-2aa0******** 2021-05-18 09:27:43 REPORT RequestID: 34dc9533-ed6e-4468-b9f2-2aa0******** Duration: 538.610 ms Billed Duration: 538.700 ms Memory Size: 128 MB Max Memory Used: 13 MB 2021-05-18 09:29:25 START RequestID: 5b6a3779-dcc8-44ec-8ee2-2e7f******** Version: b09i2s85a0c1******** 2021-05-18 09:29:26 END RequestID: 5b6a3779-dcc8-44ec-8ee2-2e7f******** 2021-05-18 09:29:26 REPORT RequestID: 5b6a3779-dcc8-44ec-8ee2-2e7f******** Duration: 554.904 ms Billed Duration: 555.000 ms Memory Size: 128 MB Max Memory Used: 13 MB ...
- In the management console
-
Make sure that a new scan started when you pushed the Docker image.
Management consoleCLI- In the management console
, select the parent folder of the registry containing the Docker image. - Select Container Registry.
- Select the registry where you pushed your Docker image.
- Open the repository with the Docker image.
- Select the relevant Docker image and check the Date of last scan parameter value.
To view scans by Docker image, run the command:
yc container image list-scan-results --repository-name=<registry_ID>/<Docker_image_name>
Result:
+----------------------+----------------------+---------------------+--------+--------------------------------+ | ID | IMAGE | SCANNED AT | STATUS | VULNERABILITIES | +----------------------+----------------------+---------------------+--------+--------------------------------+ | crpu20rpdc2f******** | crpqmsqp5mtb******** | 2021-05-18 14:34:02 | READY | medium:6, low:13, negligible:3 | +----------------------+----------------------+---------------------+--------+--------------------------------+
- In the management console
How to delete the resources you created
To stop paying for the resources you created:
- Delete the Docker image stored in Yandex Container Solution, as well as the registry.
- Delete the Cloud Functions function.
- Delete the Cloud Functions trigger.