Skip to content

Commit

Permalink
GITBOOK-8489: AL - Merged - Container registry integrations: update i…
Browse files Browse the repository at this point in the history
…mages
  • Loading branch information
aluca3 authored and gitbook-bot committed Nov 19, 2024
1 parent df024b2 commit 463e659
Show file tree
Hide file tree
Showing 26 changed files with 57 additions and 96 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ Log in to your account and navigate to the relevant Group and Organization you w
5. When the import ends, a notification of success or failure appears at the top of the page. Click **Refresh Page** to view the **Projects** page with the newly imported images.\
Images are grouped by repository and linked individually to a detailed **Projects** page.
6. You can now connect your Git repo to this Project to use your Dockerfile for enriched fix advice.\
For more information, see [Detect vulnerable base images from your Dockerfile](../../../../scan-with-snyk/snyk-container/scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md).
For more information, see [Detect vulnerable base images from your Dockerfile](../../scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md).

You can filter to view only ECR Projects, which are marked with a unique icon.

<figure><img src="../../../../.gitbook/assets/List_of_ECR_Projects (4).png" alt="ECR Project" width="375"><figcaption><p>ECR Project</p></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/projects_filter_integrations_ecr.png" alt="" width="284"><figcaption><p>Filtering by ECR Project</p></figcaption></figure>

Amazon ECR integration works like other Snyk integration. To continue to monitor, fix, and manage your Projects, see the relevant pages in the Snyk user documentation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ An example follows:

Snyk tests the connection values, and the page reloads, now displaying Amazon ECR integration details as you entered them. A confirmation message that the details were saved also appears in green at the top of the screen.

<figure><img src="../../../../.gitbook/assets/uuid-49671392-b5d5-389d-66c8-86b3daf9a2e1-en.png" alt="ECR integration was updated"><figcaption><p>ECR integration was updated</p></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/uuid-49671392-b5d5-389d-66c8-86b3daf9a2e1-en.png" alt="Confirmation message"><figcaption><p>Confirmation message that ECR integration was updated</p></figcaption></figure>

If the connection to AWS fails, a notification appears under the **Connected to Amazon ECR** section.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This page explains how to enable integration between one Amazon ECR registry and

You can establish cross-account access to enable Snyk's Amazon ECR integration as a one-click deployment using an [AWS Quick Start](https://github.com/aws-quickstart/quickstart-snyk-security), This eliminates the need for manual configuration.

<figure><img src="../../../../.gitbook/assets/quickstart-snyk-security-ecr (1) (1).png" alt="AWS ECR and Snyk integration cross-account IAM role"><figcaption><p>AWS ECR and Snyk integration cross-account IAM role</p></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/configure_integration_Amazon_ecr.png" alt=""><figcaption><p>AWS ECR and Snyk integration cross-account IAM role</p></figcaption></figure>

You must have your Snyk **Organization ID** and AWS IAM [role ARN](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference\_identifiers.html#identifiers-arns) to complete the integration. The role ARN is provided in the AWS CloudFormation Console's Output tab.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ This process explains how to set up a resource role in AWS and the necessary pol
2. Click **Edit trust relationship**.
3. In the **Policy Document**, select and delete the entire script and then copy and paste the following script as it is displayed from the UI in your Snyk account, in the Harden usability scope field of the Account credentials.

![](../../../../.gitbook/assets/uuid-4b683f44-0a5e-0d13-f369-f7edecf98ce9-en.gif)
<figure><img src="../../../../.gitbook/assets/uuid-4b683f44-0a5e-0d13-f369-f7edecf98ce9-en.gif" alt="Steps to enable permissions to access Amazon Elastic Container Registry"><figcaption><p>Enabling Snyk permissions to access Amazon Elastic Container Registry (ECR)</p></figcaption></figure>
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This page explains how to set up DigitalOcean integration in Snyk and start mana
2. In the **Account credentials** section, enter your DigitalOcean personal access token as the login credential. You can find detailed instructions for creating the access token on the integration page.
3. To finish, click **Save**.

<figure><img src="../../../.gitbook/assets/mceclip0-10-.png" alt="DigitalOcean account credentials"><figcaption><p>DigitalOcean account credentials</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/mceclip0-10-.png" alt="Account credentials for DigitalOcean"><figcaption><p>DigitalOcean account credentials</p></figcaption></figure>

If you are using self-hosted DigitalOcean, contact [Snyk Support](https://support.snyk.io/hc/en-us/requests/new) to provide you with a token. For more information, see [Snyk Container for self-hosted container registries (with Broker)](../../../enterprise-setup/snyk-broker/snyk-broker-container-registry-agent/integrate-with-self-hosted-container-registries-broker.md).

Expand Down Expand Up @@ -58,12 +58,12 @@ The steps follow to add images from DigitalOcean to Snyk.
6. When the import ends:
1. You can view the newly imported image, marked with a **NEW** tag, on the **Projects** page. Images are grouped by repository and are each linked individually to a detailed **Project** page.
2. An **import log** becomes available; you can reach it at the top of the Projects list.
3. To enrich the data and get recommendations regarding your base image, under **Settings**, you can connect your Dockerfile to the image Project. For more information, see [Adding your Dockerfile and testing your base image](../../../scan-with-snyk/snyk-container/scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md).
3. To enrich the data and get recommendations regarding your base image, under **Settings**, you can connect your Dockerfile to the image Project. For more information, see [Adding your Dockerfile and testing your base image](../scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md).

DigitalOcean imports are indicated with a unique icon. You can filter the integration in the **Projects** view to see DigitalOcean Projects only:

<figure><img src="../../../.gitbook/assets/mceclip0-11-.png" alt="DigitalOcean Projects in Projects listing"><figcaption><p>DigitalOcean Projects in Projects listing</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/mceclip0-11-.png" alt="Example of DigitalOcean Projects"><figcaption><p>DigitalOcean Projects in Projects listing</p></figcaption></figure>

{% hint style="info" %}
For **application vulnerabilities within container images**, any changes to the application will not be reflected with a manual or recurring retest. A re-import of the image is required. For more information, see [Detecting application vulnerabilities in container images](../use-snyk-container/detect-application-vulnerabilities-in-container-images.md).
For application vulnerabilities within container images, any changes to the application will not be reflected with a manual or recurring retest. A re-import of the image is required. For more information, see [Detecting application vulnerabilities in container images](../use-snyk-container/detect-application-vulnerabilities-in-container-images.md).
{% endhint %}
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To install and run the Snyk Docker Desktop Extension:
1. On the Docker Desktop home screen, click the three dots next to **Extensions**, and select **Marketplace**.\


<figure><img src="../../../.gitbook/assets/Docker_Desktop_Marketplace.png" alt="Marketplace on Docker Desktop"><figcaption><p>Marketplace on Docker Desktop</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Docker_Desktop_Marketplace.png" alt=""><figcaption><p>Marketplace on Docker Desktop</p></figcaption></figure>
2. In the **Marketplace** window, navigate to the Snyk Extension and click **Install**.\


Expand All @@ -19,11 +19,11 @@ To install and run the Snyk Docker Desktop Extension:

3. After installation, launch the Snyk Extension and click **Settings**.

<figure><img src="../../../.gitbook/assets/Snyk_Ext_page_Docker_Deskop.png" alt=""><figcaption><p>Snyk Extension page on Docker Desktop</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Snyk_Ext_page_Docker_Deskop.png" alt="Settings button on Docker Desktop"><figcaption><p>Snyk Extension page on Docker Desktop</p></figcaption></figure>
4. In the **Settings** window, add your API token or service account token and click **Save**.\


<figure><img src="../../../.gitbook/assets/Add_token_Docker_Desktop.png" alt="Add authorization token in the Settings window"><figcaption><p>Add authorization token in the Settings window</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Add_token_Docker_Desktop.png" alt="Save button on the Docker Desktop settings page"><figcaption><p>Add authorization token in the Settings window</p></figcaption></figure>

You can now select the local image you want to scan with Snyk by clicking **Test image**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ This page explains how to enable and configure the integration between Docker Hu
2. Click **Docker Hub**.
3. Enter your Docker Hub username and Access Token. For details, see [Generate Docker Hub Access Token](configure-the-integration-with-docker-hub.md#generate-docker-hub-access-token).
4. Click **Save**.\
The page reloads with new options. The Access Token field is blank.\
The page reloads with new options. The **Access Token** field is blank.\
A confirmation message that the details were saved also appears in green at the top of the screen.

<figure><img src="../../../../.gitbook/assets/Screen Shot 2022-01-21 at 9.48.27 AM.png" alt="Successful connection with Docker Hub"><figcaption><p>Successful connection with Docker Hub</p></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/confirmation_message_connected_docker_hub.png" alt=""><figcaption><p>Confirmation message for successful connection to Docker Hub</p></figcaption></figure>

If the connection to Docker Hub fails, an error notification appears:

<figure><img src="../../../../.gitbook/assets/Screen Shot 2022-01-21 at 9.48.50 AM.png" alt="Failed connection, Could not connect to Docker Hub"><figcaption><p>Failed connection, Could not connect to Docker Hub</p></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screen Shot 2022-01-21 at 9.48.50 AM.png" alt=""><figcaption><p>Error notification that the connection to Docker Hub has failed</p></figcaption></figure>

## Troubleshooting with the Docker Hub integration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,21 @@ Snyk tests and monitors Docker Hub repositories and images by evaluating root fo

1. Log in to your Snyk account and navigate to the relevant Group and Organization you want to manage.
2. Navigate to the **Projects** page and click **Add Projects**.\
The list of integrations that are already configured on your account opens.\
The view **Which images do you want to test?** opens, displaying all of the available images for the registry to which you connected, grouped by each of your repositories.
3. Select one or multiple images using any or all of the following methods:
The list of integrations that are already configured on your account opens.
3. The view **Which images do you want to test?** opens, displaying all of the available images for the registry to which you connected, grouped by each of your repositories.
4. Select one or multiple images using any or all of the following methods:
* Type the name of a single image for import in the **Image Name** field.
* Select any of the repositories if you want to import all of the associated images.
* Expand and collapse repositories to select multiple images.
4. Click **Add selected repositories**.
5. Click **Add selected repositories**.

On the **Projects** page, a status bar appears at the top of the page as the images are imported; you can continue working in the meantime.
5. When the import ends, a notification of success or failure appears at the top of the **Projects** page.\
6. When the import ends, a notification of success or failure appears at the top of the **Projects** page.\
Click **Refresh** to view the **Projects** page with the newly imported images.\
Images are grouped by repository and are each linked individually to a detailed **Projects** page.
6. You can now connect your Git repository to this Project in order to use your Dockerfile for enriched fix advice. For more information, see [Detect vulnerable base images from your Dockerfile](../../../../scan-with-snyk/snyk-container/scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md).
7. You can now connect your Git repository to this Project in order to use your Dockerfile for enriched fix advice. For more information, see [Detect vulnerable base images from your Dockerfile](../../scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md).

You can now also filter to view only Docker Hub Projects:

<figure><img src="../../../../.gitbook/assets/uuid-ce306bb8-1d6d-c895-bdb5-3a7cd551977b-en (1) (1) (1) (1) (1) (1) (1) (1) (8) (7).png" alt="Docker Hub projects"><figcaption><p>Docker Hub projects</p></figcaption></figure>
You can also filter to view only Docker Hub Projects.

When repositories and images are imported, a confirmation appears in green at the top of the screen. Docker Hub files are indicated with a unique icon .

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ This page explains how to set up GitHub Container registry integration in Snyk a
2. Enter your GitHub Container registry username and password login credentials in the Account credentials section.
3. In the **container registry name** fill in the full URL to the registry you want to integrate with. To finish, click **Save**.

<figure><img src="../../../.gitbook/assets/mceclip1-4-.png" alt="GitHub Container registry Account credentials"><figcaption><p>GitHub Container registry Account credentials</p></figcaption></figure>

If you are using a self-hosted GitHub Container registry, [contact Snyk Support](https://support.snyk.io/hc/en-us/requests/new) to provide you with a token. For more information, see [Snyk Container for self-hosted container registries (with Broker)](../../../enterprise-setup/snyk-broker/snyk-broker-container-registry-agent/integrate-with-self-hosted-container-registries-broker.md).

Snyk tests the connection values, and the page reloads, now displaying GitHub Container registry integration information. The **Add your GitHub container registry images to Snyk** button becomes available.
Expand Down Expand Up @@ -59,11 +57,11 @@ Follow these steps to add images from the GitHub container registry to Snyk.
7. When the import ends:
* You can view the newly imported image, marked with a **NEW** tag, on the **Projects** page. Images are grouped by repository and are each linked individually to a detailed **Project** page.
* An **import log** becomes available; you can reach it at the top of the Projects list.
* To enrich the data and get recommendations regarding your base image, you can connect your Dockerfile to the image Project under **Settings**. For more information, see [Adding your Dockerfile and testing your base image](../../../scan-with-snyk/snyk-container/scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md).
* To enrich the data and get recommendations regarding your base image, you can connect your Dockerfile to the image Project under **Settings**. For more information, see [Adding your Dockerfile and testing your base image](../scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md).

GitHub container registry imports are designated with a unique icon. You can filter the integration in the **Projects** view to see GitHub container registry Projects only:
GitHub container registry imports are designated with a unique icon. You can filter the integration in the **Projects** view to see GitHub container registry Projects only.

<figure><img src="../../../.gitbook/assets/mceclip1-5-.png" alt="GitHub Project in Projects listing"><figcaption><p>GitHub Project in Projects listing</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/projects_github_container_registry.png" alt=""><figcaption><p>Example of a GitHub Project </p></figcaption></figure>

{% hint style="info" %}
For **application vulnerabilities within container images**, any changes to the application will not be reflected with a manual or recurring retest. A re-import of the image is required. For more information, see [Detecting application vulnerabilities in container images](../use-snyk-container/detect-application-vulnerabilities-in-container-images.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ This page explains how to set up GitLab Container Registry integration in Snyk a
3. In the **Container registry name** fill in the full URL to the registry you want to integrate with.
4. To finish, click **Save**.

<figure><img src="../../../.gitbook/assets/mceclip1-6-.png" alt="GitLab Container Registry Account credentials"><figcaption><p>GitLab Container Registry Account credentials</p></figcaption></figure>

If you are using a self-hosted GitLab Container Registry, [contact Snyk Support](https://support.snyk.io/hc/en-us/requests/new) to provide you with a token. For more information, see [Snyk Container for self-hosted container registries (with Broker)](../../../enterprise-setup/snyk-broker/snyk-broker-container-registry-agent/integrate-with-self-hosted-container-registries-broker.md).

Snyk tests the connection values, and the page reloads, now displaying GitLab Container Registry integration information. The **Add your GitLab container registry images to Snyk** button becomes available.&#x20;
Expand Down Expand Up @@ -58,11 +56,11 @@ The steps follow for adding images from GitLab Container Registry to Snyk.
7. When the import ends:
* You can view the newly imported image, marked with a **NEW** tag, on the **Projects** page. Images are grouped by repository and are each linked individually to a detailed **Project** page.
* An **import log** becomes available; you can reach it at the top of the Projects list.
* To enrich the data and get recommendations regarding your base image, under **Settings**, you can connect your Dockerfile to the image Project. For more information, see[ Adding your Dockerfile and testing your base image.](../../../scan-with-snyk/snyk-container/scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md)
* To enrich the data and get recommendations regarding your base image, under **Settings**, you can connect your Dockerfile to the image Project. For more information, see[ Adding your Dockerfile and testing your base image.](../scan-your-dockerfile/detect-vulnerable-base-images-from-your-dockerfile.md)

GitLab Container Registry imports are designated with a unique icon. You can filter the integration in the **Projects** view to see GitLab Container Registry Projects only.

<figure><img src="../../../.gitbook/assets/mceclip0-14-.png" alt="GitLab Container Registry Project in Projects listing"><figcaption><p>GitLab Container Registry Project in Projects listing</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/mceclip0-14-.png" alt=""><figcaption><p>GitLab Container Registry Project in Projects listing</p></figcaption></figure>

{% hint style="info" %}
For **application vulnerabilities within container images**, any changes to the application will not be reflected with a manual or recurring retest. A re-import of the image is required. For more information, see [Detecting application vulnerabilities in container images](../use-snyk-container/detect-application-vulnerabilities-in-container-images.md).
Expand Down
Loading

0 comments on commit 463e659

Please sign in to comment.