Merge pull request #930 from jackywong-amazon/d-improve-awscc_ecr_rep…

…ository docs - awscc_ecr_repository
hashicorp · May 11, 2023 · 062160a · 062160a
2 parents 325469b + 82b6962
commit 062160a
Show file tree

Hide file tree

Showing 5 changed files with 189 additions and 2 deletions.
diff --git a/docs/resources/ecr_repository.md b/docs/resources/ecr_repository.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "awscc_ecr_repository Resource - terraform-provider-awscc"
 subcategory: ""
 description: |-
@@ -10,7 +9,91 @@ description: |-
 
 The AWS::ECR::Repository resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html
 
+## Example Usage
 
+### ECR Repository with scan on push
+To create ECR Repository with scan on push:
+
+```terraform
+resource "awscc_ecr_repository" "this" {
+  repository_name      = "example-ecr"
+  image_tag_mutability = "MUTABLE"
+  image_scanning_configuration = {
+    scan_on_push = true
+  }
+
+}
+```
+
+### ECR Repository with lifecycle policy
+To create ECR Repository with lifecycle policy that expires untagged images older than 14 days:
+
+```terraform
+resource "awscc_ecr_repository" "lifecycle_policy_example" {
+  repository_name      = "example-ecr-lifecycle-policy"
+  image_tag_mutability = "MUTABLE"
+
+  lifecycle_policy = {
+    lifecycle_policy_text = <<EOF
+        {
+            "rules": [
+                {
+                    "rulePriority": 1,
+                    "description": "Expire images older than 14 days",
+                    "selection": {
+                        "tagStatus": "untagged",
+                        "countType": "sinceImagePushed",
+                        "countUnit": "days",
+                        "countNumber": 14
+                    },
+                    "action": {
+                        "type": "expire"
+                    }
+                }
+            ]
+        }
+        EOF
+  }
+}
+```
+
+### ECR Repository with repository policy
+To create ECR Repository with repository policy that allows AWS CodeBuild access to the Amazon ECR API actions:
+
+```terraform
+resource "awscc_ecr_repository" "repo_policy_example" {
+  repository_name      = "example-ecr-repository-policy"
+  image_tag_mutability = "MUTABLE"
+
+  repository_policy_text = jsonencode(
+    {
+      "Version" : "2012-10-17",
+      "Statement" : [
+        {
+          "Sid" : "CodeBuildAccess",
+          "Effect" : "Allow",
+          "Principal" : {
+            "Service" : "codebuild.amazonaws.com"
+          },
+          "Action" : [
+            "ecr:BatchGetImage",
+            "ecr:GetDownloadUrlForLayer"
+          ],
+          "Condition" : {
+            "ArnLike" : {
+              "aws:SourceArn" : "arn:aws:codebuild:region:123456789012:project/project-name"
+            },
+            "StringEquals" : {
+              "aws:SourceAccount" : "123456789012"
+            }
+          }
+        }
+      ]
+    }
+  )
+
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
@@ -78,4 +161,4 @@ Import is supported using the following syntax:
 
 ```shell
 $ terraform import awscc_ecr_repository.example <resource ID>
-```
+```
diff --git a/examples/resources/awscc_ecr_repository/ecr_repository.tf b/examples/resources/awscc_ecr_repository/ecr_repository.tf
@@ -0,0 +1,8 @@
+resource "awscc_ecr_repository" "this" {
+  repository_name      = "example-ecr"
+  image_tag_mutability = "MUTABLE"
+  image_scanning_configuration = {
+    scan_on_push = true
+  }
+
+}
diff --git a/examples/resources/awscc_ecr_repository/ecr_repository_lifecycle_policy.tf b/examples/resources/awscc_ecr_repository/ecr_repository_lifecycle_policy.tf
@@ -0,0 +1,26 @@
+resource "awscc_ecr_repository" "lifecycle_policy_example" {
+  repository_name      = "example-ecr-lifecycle-policy"
+  image_tag_mutability = "MUTABLE"
+
+  lifecycle_policy = {
+    lifecycle_policy_text = <<EOF
+        {
+            "rules": [
+                {
+                    "rulePriority": 1,
+                    "description": "Expire images older than 14 days",
+                    "selection": {
+                        "tagStatus": "untagged",
+                        "countType": "sinceImagePushed",
+                        "countUnit": "days",
+                        "countNumber": 14
+                    },
+                    "action": {
+                        "type": "expire"
+                    }
+                }
+            ]
+        }
+        EOF
+  }
+}
diff --git a/examples/resources/awscc_ecr_repository/ecr_repository_repository_policy.tf b/examples/resources/awscc_ecr_repository/ecr_repository_repository_policy.tf
@@ -0,0 +1,32 @@
+resource "awscc_ecr_repository" "repo_policy_example" {
+  repository_name      = "example-ecr-repository-policy"
+  image_tag_mutability = "MUTABLE"
+
+  repository_policy_text = jsonencode(
+    {
+      "Version" : "2012-10-17",
+      "Statement" : [
+        {
+          "Sid" : "CodeBuildAccess",
+          "Effect" : "Allow",
+          "Principal" : {
+            "Service" : "codebuild.amazonaws.com"
+          },
+          "Action" : [
+            "ecr:BatchGetImage",
+            "ecr:GetDownloadUrlForLayer"
+          ],
+          "Condition" : {
+            "ArnLike" : {
+              "aws:SourceArn" : "arn:aws:codebuild:region:123456789012:project/project-name"
+            },
+            "StringEquals" : {
+              "aws:SourceAccount" : "123456789012"
+            }
+          }
+        }
+      ]
+    }
+  )
+
+}
diff --git a/templates/resources/ecr_repository.md.tmpl b/templates/resources/ecr_repository.md.tmpl
@@ -0,0 +1,38 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: ""
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+### ECR Repository with scan on push
+To create ECR Repository with scan on push:
+
+{{ tffile (printf "examples/resources/%s/ecr_repository.tf" .Name)}}
+
+### ECR Repository with lifecycle policy
+To create ECR Repository with lifecycle policy that expires untagged images older than 14 days:
+
+{{ tffile (printf "examples/resources/%s/ecr_repository_lifecycle_policy.tf" .Name)}}
+
+### ECR Repository with repository policy
+To create ECR Repository with repository policy that allows AWS CodeBuild access to the Amazon ECR API actions:
+
+{{ tffile (printf "examples/resources/%s/ecr_repository_repository_policy.tf" .Name)}}
+
+{{ .SchemaMarkdown | trimspace }}
+{{- if .HasImport }}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" .ImportFile }}
+
+{{- end }}