mirror of https://github.com/docker/docs.git
scout: update external links
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
parent
a4dd782e2d
commit
1c203b3ab4
|
@ -38,20 +38,16 @@ To integrate Docker Scout with SonarQube, ensure that:
|
|||
|
||||
## Enable the SonarQube integration
|
||||
|
||||
1. Go to [Integrations](https://scout.docker.com/settings/integrations/) on the
|
||||
Docker Scout Dashboard.
|
||||
2. Select the **See all integration options** filter.
|
||||
3. Find the SonarQube integration in the **Code quality** section, and
|
||||
select **Integrate**.
|
||||
4. In the **How to integrate** section, enter a configuration name for this
|
||||
1. Go to the [SonarQube integrations page](https://scout.docker.com/settings/integrations/sonarqube/)
|
||||
on the Docker Scout Dashboard.
|
||||
2. In the **How to integrate** section, enter a configuration name for this
|
||||
integration. Docker Scout uses this label as a display name for the
|
||||
integration, and to name the webhook.
|
||||
5. Select **Next**.
|
||||
6. Enter the configuration details for your SonarQube instance. Docker Scout
|
||||
3. Select **Next**.
|
||||
4. Enter the configuration details for your SonarQube instance. Docker Scout
|
||||
uses this information to create SonarQube webhook.
|
||||
|
||||
In SonarQube, [generate a new **User
|
||||
token**](https://docs.sonarsource.com/sonarqube/9.8/user-guide/user-account/generating-and-using-tokens/#generating-a-token).
|
||||
In SonarQube, [generate a new **User token**](https://docs.sonarsource.com/sonarqube/latest/user-guide/user-account/generating-and-using-tokens/#generating-a-token).
|
||||
The token requires 'Administer' permission on the specified project, or
|
||||
global 'Administer' permission.
|
||||
|
||||
|
@ -59,12 +55,12 @@ To integrate Docker Scout with SonarQube, ensure that:
|
|||
organization. The SonarQube organization is required if you're using
|
||||
SonarCloud.
|
||||
|
||||
7. Select **Enable configuration**.
|
||||
5. Select **Enable configuration**.
|
||||
|
||||
Docker Scout performs a connection test to verify that the provided details
|
||||
are correct, and that the token has the necessary permissions.
|
||||
|
||||
8. After a successful connection test, you're redirected to the SonarQube
|
||||
6. After a successful connection test, you're redirected to the SonarQube
|
||||
integration overview, which lists all your SonarQube integrations and their
|
||||
statuses.
|
||||
|
||||
|
|
|
@ -42,33 +42,29 @@ image.
|
|||
## Prerequisites
|
||||
|
||||
- Install the Sysdig Agent in the cluster that you want to integrate, see [Install Sysdig Agent (Sysdig docs)](https://docs.sysdig.com/en/docs/installation/sysdig-monitor/install-sysdig-agent/).
|
||||
- Enable profiling for Risk Spotlight Integrations in Sysdig, see [Profiling (Sysdig docs)](https://docs.sysdig.com/en/docs/sysdig-secure/policies/image-profiles/#enable-for-risk-spotlight-integrations-or-for-the-in-use-column).
|
||||
- Enable profiling for Risk Spotlight Integrations in Sysdig, see [Profiling (Sysdig docs)](https://docs.sysdig.com/en/docs/sysdig-secure/policies/profiling/#enablement).
|
||||
- You must be an organization owner to enable the integration in the Docker Scout Dashboard.
|
||||
|
||||
## Integrate an environment
|
||||
|
||||
1. Go to [Integrations](https://scout.docker.com/settings/integrations/) on the
|
||||
Docker Scout Dashboard.
|
||||
2. Select the **Detect images running in my environments** filter.
|
||||
3. Find Sysdig in the list, and select **Integrate**.
|
||||
|
||||
4. In the **How to integrate** section, enter a configuration name for this
|
||||
1. Go to the [Sysdig integration page](https://scout.docker.com/settings/integrations/sysdig/)
|
||||
on the Docker Scout Dashboard.
|
||||
2. In the **How to integrate** section, enter a configuration name for this
|
||||
integration. Docker Scout uses this label as a display name for the
|
||||
integration.
|
||||
|
||||
5. Select **Next**.
|
||||
3. Select **Next**.
|
||||
|
||||
6. Enter a Risk Spotlight API token and select the region in the drop-down
|
||||
list.
|
||||
4. Enter a Risk Spotlight API token and select the region in the drop-down list.
|
||||
|
||||
The Risk Spotlight API token is the Sysdig token that Docker Scout needs to
|
||||
integrate with Sysdig. For more instructions on how to generate a Risk
|
||||
Spotlight token, See [Risk Spotlight Integrations (Sysdig docs)](https://docs.sysdig.com/en/docs/sysdig-secure/integrations-for-sysdig-secure/risk-spotlight-integrations/#generate-a-token-for-the-integration).
|
||||
Spotlight token, See [Risk Spotlight Integrations (Sysdig docs)](https://docs.sysdig.com/en/docs/sysdig-secure/integrations-for-sysdig-secure/risk-spotlight-integrations/docker-scout/#generate-a-token-for-the-integration).
|
||||
|
||||
The region corresponds to the `global.sysdig.region` configuration parameter
|
||||
set when deploying the Sysdig Agent.
|
||||
|
||||
7. Select **Next**.
|
||||
5. Select **Next**.
|
||||
|
||||
After selecting **Next**, Docker Scout connects to Sysdig and retrieves the
|
||||
cluster names for your Sysdig account. Cluster names correspond to the
|
||||
|
@ -79,15 +75,15 @@ image.
|
|||
provided token. If there's an error, you won't be able to continue the
|
||||
integration. Go back and verify that the configuration details are correct.
|
||||
|
||||
8. Select a cluster name in the drop-down list.
|
||||
6. Select a cluster name in the drop-down list.
|
||||
|
||||
9. Select **Next**.
|
||||
7. Select **Next**.
|
||||
|
||||
10. Assign an environment name for this cluster.
|
||||
8. Assign an environment name for this cluster.
|
||||
|
||||
You can reuse an existing environment or create a new one.
|
||||
|
||||
11. Select **Enable integration**.
|
||||
9. Select **Enable integration**.
|
||||
|
||||
After enabling the integration, Docker Scout automatically detects images
|
||||
running in the cluster, and assigns those images to the environment associated
|
||||
|
@ -103,5 +99,5 @@ monitoring](./_index.md).
|
|||
> If you created a new environment for this integration, the environment
|
||||
> appears in Docker Scout when at least one image has been analyzed.
|
||||
|
||||
To integrate more clusters, go to the [Integrations](https://scout.docker.com/settings/integrations/ecr),
|
||||
page, select **Sysdig** > **Manage** and select the **Add** button.
|
||||
To integrate more clusters, go to the [Sysdig integrations page](https://scout.docker.com/settings/integrations/sysdig/),
|
||||
select **Sysdig** > **Manage** and select the **Add** button.
|
||||
|
|
|
@ -109,7 +109,7 @@ redirected to the Azure registry summary page, which shows you all your Azure
|
|||
integrations for the current organization.
|
||||
|
||||
Next, activate Docker Scout for the repositories that you want to analyze in
|
||||
[repository settings](../../dashboard.md#repository-settings).
|
||||
[repository settings](https://scout.docker.com/settings/repos/).
|
||||
|
||||
After activating repositories, images that you push are analyzed by Docker
|
||||
Scout. The analysis results appear in the Docker Scout Dashboard.
|
||||
|
@ -126,14 +126,12 @@ latest image version automatically.
|
|||
|
||||
To remove an ACR integration:
|
||||
|
||||
1. Go to [Integrations](https://scout.docker.com/settings/integrations/) on the
|
||||
Docker Scout Dashboard.
|
||||
2. Select the **Analyze my images from another registry** filter option.
|
||||
3. Find **Azure Container Registry** in the list, and select **Manage**.
|
||||
4. Find the ACR integration that you want to remove, and select the **Remove**
|
||||
1. Go to the [ACR integration page](https://scout.docker.com/settings/integrations/azure/)
|
||||
on the Docker Scout Dashboard.
|
||||
2. Find the ACR integration that you want to remove, and select the **Remove**
|
||||
button.
|
||||
5. In the dialog that opens, confirm by selecting **Remove**.
|
||||
6. After removing the integration in the Docker Scout Dashboard, also remove
|
||||
3. In the dialog that opens, confirm by selecting **Remove**.
|
||||
4. After removing the integration in the Docker Scout Dashboard, also remove
|
||||
the Azure resources related to the integration:
|
||||
|
||||
- The `docker-scout-readonly-token` token for the container registry.
|
||||
|
|
|
@ -65,10 +65,9 @@ Prerequisites:
|
|||
|
||||
To create the stack:
|
||||
|
||||
1. Go to [Integrations](https://scout.docker.com/settings/integrations/) on the
|
||||
Docker Scout Dashboard.
|
||||
2. Select **Integrate** on **Elastic Container Registry**.
|
||||
3. Select the **Create on AWS** button.
|
||||
1. Go to the [ECR integration page](https://scout.docker.com/settings/integrations/ecr/)
|
||||
on the Docker Scout Dashboard.
|
||||
2. Select the **Create on AWS** button.
|
||||
|
||||
This opens the **Create stack** wizard in the AWS CloudFormation console in
|
||||
a new browser tab. If you're not already signed in to AWS, you're redirected
|
||||
|
@ -77,14 +76,14 @@ To create the stack:
|
|||
If the button is grayed-out, it means you're lacking the necessary
|
||||
permissions in the Docker organization.
|
||||
|
||||
4. Follow the steps in the **Create stack** wizard until the end. Choose the
|
||||
3. Follow the steps in the **Create stack** wizard until the end. Choose the
|
||||
AWS region you want to integrate. Complete the procedure by creating the
|
||||
resources.
|
||||
|
||||
The fields in the wizard are pre-populated by the CloudFormation template,
|
||||
so you don't need to edit any of the fields.
|
||||
|
||||
5. When the resources have been created (the CloudFormation status shows
|
||||
4. When the resources have been created (the CloudFormation status shows
|
||||
`CREATE_COMPLETE` in the AWS console), return to the ECR integrations page
|
||||
in the Docker Scout Dashboard.
|
||||
|
||||
|
@ -93,8 +92,8 @@ To create the stack:
|
|||
is **Connected**.
|
||||
|
||||
The ECR integration is now active. For Docker Scout to start analyzing images
|
||||
in the registry, you need to activate it for each repository. Refer to
|
||||
[repository settings](../../dashboard.md#repository-settings).
|
||||
in the registry, you need to activate it for each repository in
|
||||
[Repository settings](https://scout.docker.com/settings/repos/).
|
||||
|
||||
After activating repositories, images that you push are analyzed by Docker
|
||||
Scout. The analysis results appear in the Docker Scout Dashboard.
|
||||
|
@ -105,12 +104,11 @@ latest image version automatically.
|
|||
|
||||
To add additional registries:
|
||||
|
||||
1. Go to [Integrations](https://scout.docker.com/settings/integrations/) on the
|
||||
Docker Scout Dashboard.
|
||||
2. Select **Manage** on **Elastic Container Registry**.
|
||||
3. Select the **Add** button at the top of the list.
|
||||
4. Complete the steps for creating the AWS resources.
|
||||
5. When the resources have been created, return to the ECR integrations page in
|
||||
1. Go to the [ECR integration page](https://scout.docker.com/settings/integrations/ecr/)
|
||||
on the Docker Scout Dashboard.
|
||||
2. Select the **Add** button at the top of the list.
|
||||
3. Complete the steps for creating the AWS resources.
|
||||
4. When the resources have been created, return to the ECR integrations page in
|
||||
the Docker Scout Dashboard.
|
||||
|
||||
The **Integrated registries** list shows the account ID and region for the
|
||||
|
@ -118,23 +116,22 @@ To add additional registries:
|
|||
is **Connected**.
|
||||
|
||||
Next, activate Docker Scout for the repositories that you want to analyze in
|
||||
[repository settings](../../dashboard.md#repository-settings).
|
||||
[repository settings](https://scout.docker.com/settings/repos/).
|
||||
|
||||
## Remove integration
|
||||
|
||||
To remove an integrated ECR registry, you must be an owner of the Docker
|
||||
organization.
|
||||
|
||||
1. Go to [Integrations](https://scout.docker.com/settings/integrations/) on
|
||||
the Docker Scout Dashboard.
|
||||
2. Select **Manage** on **Elastic Container Registry**.
|
||||
3. Find the registry that you want to remove in the list of integrated
|
||||
1. Go to the [ECR integration page](https://scout.docker.com/settings/integrations/ecr/)
|
||||
on the Docker Scout Dashboard.
|
||||
2. Find the registry that you want to remove in the list of integrated
|
||||
registries, and select the remove icon in the **Actions** column.
|
||||
|
||||
If the remove icon is disabled, it means that you're lacking the necessary
|
||||
permissions in the Docker organization.
|
||||
|
||||
4. In the dialog that opens, confirm by selecting **Remove**.
|
||||
3. In the dialog that opens, confirm by selecting **Remove**.
|
||||
|
||||
> **Important**
|
||||
>
|
||||
|
@ -150,12 +147,8 @@ organization.
|
|||
|
||||
### Unable to integrate registry
|
||||
|
||||
Check the **Status** of the integration on the ECR integrations page in the
|
||||
Docker Scout Dashboard:
|
||||
|
||||
1. Go to [Integrations](https://scout.docker.com/settings/integrations/) on the
|
||||
Docker Scout Dashboard.
|
||||
2. Select **Manage** on **Elastic Container Registry**.
|
||||
Check the **Status** of the integration on the [ECR integration page](https://scout.docker.com/settings/integrations/ecr/)
|
||||
in the Docker Scout Dashboard.
|
||||
|
||||
- If the status is **Pending** for a prolonged period of time, it's an
|
||||
indication that the integration was not yet completed on the AWS side. Select
|
||||
|
@ -172,7 +165,7 @@ If image analysis results for your ECR images aren't showing up in the Docker
|
|||
Scout Dashboard:
|
||||
|
||||
- Ensure that you've activated Docker Scout for the repository. View and manage
|
||||
active repositories in [Repository settings](../../dashboard.md#repository-settings).
|
||||
active repositories in [Repository settings](https://scout.docker.com/settings/repos/).
|
||||
|
||||
- Ensure that the AWS account ID and region for your registry is listed on the
|
||||
ECR integrations page.
|
||||
|
|
|
@ -44,16 +44,13 @@ see [Remediation](../../policy/remediation.md).
|
|||
|
||||
To integrate Docker Scout with your GitHub organization:
|
||||
|
||||
1. Go to [Integrations](https://scout.docker.com/settings/integrations/) on the
|
||||
Docker Scout Dashboard.
|
||||
2. Find the **GitHub** integration under the **Source code management**
|
||||
section, and select **Integrate**.
|
||||
3. On the integration page that opens, select the
|
||||
**Integrate GitHub app** button to open GitHub.
|
||||
4. Select the organization that you want to integrate.
|
||||
5. Select whether you want to integrate all repositories in the GitHub
|
||||
1. Go to [GitHub integration](https://scout.docker.com/settings/integrations/github/)
|
||||
on the Docker Scout Dashboard.
|
||||
2. Select the **Integrate GitHub app** button to open GitHub.
|
||||
3. Select the organization that you want to integrate.
|
||||
4. Select whether you want to integrate all repositories in the GitHub
|
||||
organization or a manual selection of repositories.
|
||||
6. Select **Install & Authorize** to add the Docker Scout app to the
|
||||
5. Select **Install & Authorize** to add the Docker Scout app to the
|
||||
organization.
|
||||
|
||||
This redirects you back to the Docker Scout Dashboard, which lists your
|
||||
|
|
Loading…
Reference in New Issue