diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/_category_.json new file mode 100644 index 0000000000..8c4706b77d --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Amazon Elastic Container Registry (ECR)", + "position": 3 +} + diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/amazon-elastic-container-registry.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/amazon-elastic-container-registry.md new file mode 100644 index 0000000000..97dd09585a --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/amazon-elastic-container-registry.md @@ -0,0 +1,31 @@ +# Amazon Elastic Container Registry (ECR) + +import EcrRepositoryBlueprint from './aws-ecr-repository/_ecr_repository_blueprint.mdx' +import EcrRepositoryConfig from './aws-ecr-repository/_ecr_repository_port_app_config.mdx' + +## AWS::ECR::Repository + +The following example demonstrates how to ingest your AWS ECR repositories to Port. + +#### ECR Repository supported actions + +The table below summarizes the available actions for ingesting Amazon ECR Repository resources in Port: + +| Action | Description | Type | Required AWS Permission | +|--------------------------|--------------------------------------------------------------------|----------|------------------------------------| +| [DescribeRepositoriesAction](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeRepositories.html) | Discover ECR repositories and retrieve detailed configuration data. | Default | `ecr:DescribeRepositories` | +| [GetRepositoryPolicyAction](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetRepositoryPolicy.html) | Retrieve the repository policy for ECR repositories. | Optional | `ecr:GetRepositoryPolicy` | +| [GetLifecyclePolicyAction](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetLifecyclePolicy.html) | Retrieve the lifecycle policy for ECR repositories. | Optional | `ecr:GetLifecyclePolicy` | +| [ListTagsForResourceAction](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ListTagsForResource.html) | Retrieve tags associated with ECR repositories. | Optional | `ecr:ListTagsForResource` | + +:::info Optional Properties Note +Properties of optional actions will not appear in the response unless you explicitly include the action that provides them in your configuration. +::: + +You can use the following Port blueprint definitions and integration configuration: + + + + + +For more details about ECR repository properties, refer to the [AWS ECR API documentation](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.html). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/aws-ecr-repository/_ecr_repository_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/aws-ecr-repository/_ecr_repository_blueprint.mdx new file mode 100644 index 0000000000..3af082db6d --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/aws-ecr-repository/_ecr_repository_blueprint.mdx @@ -0,0 +1,76 @@ +
+ECR Repository blueprint (click to expand) + +```json showLineNumbers +{ + "identifier": "ecrRepository", + "description": "This blueprint represents an AWS ECR repository in our software catalog", + "title": "ECR Repository", + "icon": "AWS", + "schema": { + "properties": { + "repositoryUri": { + "type": "string", + "title": "Repository URI" + }, + "registryId": { + "type": "string", + "title": "Registry ID" + }, + "createdAt": { + "type": "string", + "title": "Created At" + }, + "imageTagMutability": { + "type": "string", + "title": "Image Tag Mutability" + }, + "imageScanningConfiguration": { + "type": "object", + "title": "Image Scanning Configuration" + }, + "encryptionConfiguration": { + "type": "object", + "title": "Encryption Configuration" + }, + "lifecyclePolicy": { + "type": "object", + "title": "Lifecycle Policy" + }, + "repositoryPolicyText": { + "type": "string", + "title": "Repository Policy Text" + }, + "tags": { + "type": "array", + "title": "Tags", + "items": { + "type": "object", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + } + } + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "account": { + "title": "Account", + "target": "awsAccount", + "required": true, + "many": false + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/aws-ecr-repository/_ecr_repository_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/aws-ecr-repository/_ecr_repository_port_app_config.mdx new file mode 100644 index 0000000000..b56744d8ae --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-registry/aws-ecr-repository/_ecr_repository_port_app_config.mdx @@ -0,0 +1,34 @@ +
+ECR Repository mapping configuration (click to expand) + +```json showLineNumbers +resources: + - kind: AWS::ECR::Repository + selector: + query: 'true' + includeActions: + # Optional: Include additional actions for more properties + # - GetRepositoryPolicyAction + # - GetLifecyclePolicyAction + # - ListTagsForResourceAction + port: + entity: + mappings: + identifier: .Properties.RepositoryArn + title: .Properties.RepositoryName + blueprint: '"ecrRepository"' + properties: + repositoryUri: .Properties.RepositoryUri + registryId: .Properties.RegistryId + createdAt: .Properties.CreatedAt + imageTagMutability: .Properties.ImageTagMutability + imageScanningConfiguration: .Properties.ImageScanningConfiguration + encryptionConfiguration: .Properties.EncryptionConfiguration + lifecyclePolicy: .Properties.LifecyclePolicy + repositoryPolicyText: .Properties.RepositoryPolicyText + tags: .Properties.Tags + relations: + account: .__ExtraContext.AccountId +``` + +