From 58bfdfb94f01d052d5b281105f01a6f701c3374c Mon Sep 17 00:00:00 2001 From: Marc Capell Date: Fri, 8 Sep 2023 16:11:43 +0200 Subject: [PATCH 1/2] feat(scout-ecr): changes to AWS resource names --- content/scout/integrations/registry/ecr.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/content/scout/integrations/registry/ecr.md b/content/scout/integrations/registry/ecr.md index f330d833e7..36f14d20bf 100644 --- a/content/scout/integrations/registry/ecr.md +++ b/content/scout/integrations/registry/ecr.md @@ -47,7 +47,7 @@ The following table describes the configuration resources. | `AWS::SecretsManager::Secret` | `ScoutAPICredentials` | Stores the credentials used by EventBridge to fire events to Scout. | $0.42 | | `AWS::Events::ApiDestination` | `ApiDestination` | Sets up the EventBridge connection to Docker Scout for sending ECR push and delete events. | $0.01 | | `AWS::Events::Connection` | `Connection` | EventBridge connection credentials to Scout. | Free | -| `AWS::Events::Rule` | `Rule` | Defines the rule to send ECR pushes and deletes to Scout. | Free | +| `AWS::Events::Rule` | `DockerScoutEcrRule` | Defines the rule to send ECR pushes and deletes to Scout. | Free | | `AWS::IAM::Role` | `InvokeApiRole` | Internal role to grant the event access to `ApiDestination`. | Free | | `AWS::IAM::Role` | `AssumeRoleEcrAccess` | This role has access to `ScoutAPICredentials` for setting up the Docker Scout integration. | Free | @@ -79,8 +79,9 @@ 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, and complete - the procedure by creating the resources. +4. 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. @@ -146,7 +147,7 @@ organization. > AWS resources in your account. > > After removing the integration in Docker Scout, go to the AWS console and -> delete the **ScoutECRIntegration** CloudFormation stack for the integraiton +> delete the **DockerScoutECRIntegration** CloudFormation stack for the integration > that you want to remove. { .important } From 4c5874154c30dd0f9acfbdfebdb067f1fc6e18c8 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Sun, 10 Sep 2023 12:25:51 +0200 Subject: [PATCH 2/2] chore: format with prettier Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/scout/integrations/registry/ecr.md | 24 +++++++++++----------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/content/scout/integrations/registry/ecr.md b/content/scout/integrations/registry/ecr.md index 36f14d20bf..d66a4fff84 100644 --- a/content/scout/integrations/registry/ecr.md +++ b/content/scout/integrations/registry/ecr.md @@ -40,21 +40,21 @@ The following table describes the configuration resources. > The **Cost** column in the table represents an estimated monthly cost of the > resources, when integrating an ECR registry that gets 100 images pushed per day. -| Resource type | Resource name | Description | Cost | -| ----------------------------- | ---------------------- | -------------------------------------------------------------------------------------------- | ----- | -| `AWS::SNSTopic::Topic` | `SNSTopic` | SNS topic for notifying Docker Scout when the AWS resources have been created. | Free | -| `AWS::SNS::TopicPolicy` | `TopicPolicy` | Defines the topic for the initial setup notification. | Free | -| `AWS::SecretsManager::Secret` | `ScoutAPICredentials` | Stores the credentials used by EventBridge to fire events to Scout. | $0.42 | -| `AWS::Events::ApiDestination` | `ApiDestination` | Sets up the EventBridge connection to Docker Scout for sending ECR push and delete events. | $0.01 | -| `AWS::Events::Connection` | `Connection` | EventBridge connection credentials to Scout. | Free | -| `AWS::Events::Rule` | `DockerScoutEcrRule` | Defines the rule to send ECR pushes and deletes to Scout. | Free | -| `AWS::IAM::Role` | `InvokeApiRole` | Internal role to grant the event access to `ApiDestination`. | Free | -| `AWS::IAM::Role` | `AssumeRoleEcrAccess` | This role has access to `ScoutAPICredentials` for setting up the Docker Scout integration. | Free | +| Resource type | Resource name | Description | Cost | +| ----------------------------- | --------------------- | ------------------------------------------------------------------------------------------ | ----- | +| `AWS::SNSTopic::Topic` | `SNSTopic` | SNS topic for notifying Docker Scout when the AWS resources have been created. | Free | +| `AWS::SNS::TopicPolicy` | `TopicPolicy` | Defines the topic for the initial setup notification. | Free | +| `AWS::SecretsManager::Secret` | `ScoutAPICredentials` | Stores the credentials used by EventBridge to fire events to Scout. | $0.42 | +| `AWS::Events::ApiDestination` | `ApiDestination` | Sets up the EventBridge connection to Docker Scout for sending ECR push and delete events. | $0.01 | +| `AWS::Events::Connection` | `Connection` | EventBridge connection credentials to Scout. | Free | +| `AWS::Events::Rule` | `DockerScoutEcrRule` | Defines the rule to send ECR pushes and deletes to Scout. | Free | +| `AWS::IAM::Role` | `InvokeApiRole` | Internal role to grant the event access to `ApiDestination`. | Free | +| `AWS::IAM::Role` | `AssumeRoleEcrAccess` | This role has access to `ScoutAPICredentials` for setting up the Docker Scout integration. | Free | ## Integrate your first registry Create the CloudFormation stack in your AWS account to enable the Docker Scout -integration. +integration. Prerequisites: @@ -181,7 +181,7 @@ Scout Dashboard, run the following checks: The account ID and region are included in the registry hostname: `.dkr.ecr..amazonaws.com/` -- Docker Scout only analyzes images that were pushed *after* the integration +- Docker Scout only analyzes images that were pushed _after_ the integration was created. If you want to analyze images created before the registry was integrated, you can push the images to the registry again.