artifactregistry: fix comments, more examples for common remote repositories (#12312) (#8713)

[upstream:e7cf93b18ad0eca820b889cd4dae4b88cb5a9ddc]

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

Diff for: .changelog/12312.txt

@@ -0,0 +1,3 @@
+```release-note:none
+
+```

Diff for: google-beta/services/artifactregistry/resource_artifact_registry_repository.go

@@ -350,10 +350,13 @@ snapshot versions.`,
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
 									"uri": {
-										Type:        schema.TypeString,
-										Required:    true,
-										ForceNew:    true,
-										Description: `Specific uri to the Artifact Registory repository, e.g. 'projects/UPSTREAM_PROJECT_ID/locations/REGION/repositories/UPSTREAM_REPOSITORY'`,
+										Type:     schema.TypeString,
+										Required: true,
+										ForceNew: true,
+										Description: `One of:
+a. Artifact Registry Repository resource, e.g. 'projects/UPSTREAM_PROJECT_ID/locations/REGION/repositories/UPSTREAM_REPOSITORY'
+b. URI to the registry, e.g. '"https://registry-1.docker.io"'
+c. URI to Artifact Registry Repository, e.g. '"https://REGION-docker.pkg.dev/UPSTREAM_PROJECT_ID/UPSTREAM_REPOSITORY"'`,
 									},
 								},
 							},
@@ -383,7 +386,7 @@ not be validated.`,
 										Type:        schema.TypeList,
 										Optional:    true,
 										ForceNew:    true,
-										Description: `Settings for a remote repository with a custom uri.`,
+										Description: `[Deprecated, please use commonRepository instead] Settings for a remote repository with a custom uri.`,
 										MaxItems:    1,
 										Elem: &schema.Resource{
 											Schema: map[string]*schema.Schema{
@@ -422,7 +425,7 @@ not be validated.`,
 										Type:        schema.TypeList,
 										Optional:    true,
 										ForceNew:    true,
-										Description: `Settings for a remote repository with a custom uri.`,
+										Description: `[Deprecated, please use commonRepository instead] Settings for a remote repository with a custom uri.`,
 										MaxItems:    1,
 										Elem: &schema.Resource{
 											Schema: map[string]*schema.Schema{
@@ -461,7 +464,7 @@ not be validated.`,
 										Type:        schema.TypeList,
 										Optional:    true,
 										ForceNew:    true,
-										Description: `Settings for a remote repository with a custom uri.`,
+										Description: `[Deprecated, please use commonRepository instead] Settings for a remote repository with a custom uri.`,
 										MaxItems:    1,
 										Elem: &schema.Resource{
 											Schema: map[string]*schema.Schema{
@@ -500,7 +503,7 @@ not be validated.`,
 										Type:        schema.TypeList,
 										Optional:    true,
 										ForceNew:    true,
-										Description: `Settings for a remote repository with a custom uri.`,
+										Description: `[Deprecated, please use commonRepository instead] Settings for a remote repository with a custom uri.`,
 										MaxItems:    1,
 										Elem: &schema.Resource{
 											Schema: map[string]*schema.Schema{

Diff for: google-beta/services/artifactregistry/resource_artifact_registry_repository_generated_test.go

@@ -825,6 +825,128 @@ resource "google_artifact_registry_repository" "my-repo" {
 `, context)
 }
 
+func TestAccArtifactRegistryRepository_artifactRegistryRepositoryRemoteCommonRepositoryWithArtifactRegistryUriExample(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"random_suffix": acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckArtifactRegistryRepositoryDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccArtifactRegistryRepository_artifactRegistryRepositoryRemoteCommonRepositoryWithArtifactRegistryUriExample(context),
+			},
+			{
+				ResourceName:            "google_artifact_registry_repository.my-repo",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"labels", "location", "remote_repository_config.0.disable_upstream_validation", "repository_id", "terraform_labels"},
+			},
+		},
+	})
+}
+
+func testAccArtifactRegistryRepository_artifactRegistryRepositoryRemoteCommonRepositoryWithArtifactRegistryUriExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+data "google_project" "project" {}
+
+resource "google_artifact_registry_repository" "upstream_repo" {
+  location      = "us-central1"
+  repository_id = "tf-test-example-upstream-repo%{random_suffix}"
+  description   = "example upstream repository%{random_suffix}"
+  format        = "DOCKER"
+}
+
+resource "google_artifact_registry_repository" "my-repo" {
+  location      = "us-central1"
+  repository_id = "tf-test-example-common-remote%{random_suffix}"
+  description   = "example remote common repository with docker upstream%{random_suffix}"
+  format        = "DOCKER"
+  mode          = "REMOTE_REPOSITORY"
+  remote_repository_config {
+    description = "pull-through cache of another Artifact Registry repository by URL"
+    common_repository {
+      uri         = "https://us-central1-docker.pkg.dev//tf-test-example-upstream-repo%{random_suffix}"
+    }
+  }
+}
+`, context)
+}
+
+func TestAccArtifactRegistryRepository_artifactRegistryRepositoryRemoteCommonRepositoryWithCustomUpstreamExample(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"random_suffix": acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckArtifactRegistryRepositoryDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccArtifactRegistryRepository_artifactRegistryRepositoryRemoteCommonRepositoryWithCustomUpstreamExample(context),
+			},
+			{
+				ResourceName:            "google_artifact_registry_repository.my-repo",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"labels", "location", "remote_repository_config.0.disable_upstream_validation", "repository_id", "terraform_labels"},
+			},
+		},
+	})
+}
+
+func testAccArtifactRegistryRepository_artifactRegistryRepositoryRemoteCommonRepositoryWithCustomUpstreamExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+data "google_project" "project" {}
+
+resource "google_secret_manager_secret" "tf-test-example-remote-secret%{random_suffix}" {
+  secret_id = "tf-test-example-secret%{random_suffix}"
+  replication {
+    auto {}
+  }
+}
+
+resource "google_secret_manager_secret_version" "tf-test-example-remote-secret%{random_suffix}_version" {
+  secret = google_secret_manager_secret.tf-test-example-remote-secret%{random_suffix}.id
+  secret_data = "tf-test-remote-password%{random_suffix}"
+}
+
+resource "google_secret_manager_secret_iam_member" "secret-access" {
+  secret_id = google_secret_manager_secret.tf-test-example-remote-secret%{random_suffix}.id
+  role      = "roles/secretmanager.secretAccessor"
+  member    = "serviceAccount:service-${data.google_project.project.number}@gcp-sa-artifactregistry.iam.gserviceaccount.com"
+}
+
+resource "google_artifact_registry_repository" "my-repo" {
+  location      = "us-central1"
+  repository_id = "tf-test-example-docker-custom-remote%{random_suffix}"
+  description   = "example remote custom docker repository with credentia%{random_suffix}"
+  format        = "DOCKER"
+  mode          = "REMOTE_REPOSITORY"
+  remote_repository_config {
+    description = "custom common docker remote with credentials"
+    disable_upstream_validation = true
+    common_repository {
+      uri = "https://registry-1.docker.io"
+    }
+    upstream_credentials {
+      username_password_credentials {
+        username = "tf-test-remote-username%{random_suffix}"
+        password_secret_version = google_secret_manager_secret_version.tf-test-example-remote-secret%{random_suffix}_version.name
+      }
+    }
+  }
+}
+`, context)
+}
+
 func testAccCheckArtifactRegistryRepositoryDestroyProducer(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
 		for name, rs := range s.RootModule().Resources {

Diff for: website/docs/r/artifact_registry_repository.html.markdown

@@ -542,6 +542,88 @@ resource "google_artifact_registry_repository" "my-repo" {
   }
 }
 ```
+<div class = "oics-button" style="float: right; margin: 0 0 -15px">
+  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md&cloudshell_working_dir=artifact_registry_repository_remote_common_repository_with_artifact_registry_uri&open_in_editor=main.tf" target="_blank">
+    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
+  </a>
+</div>
+## Example Usage - Artifact Registry Repository Remote Common Repository With Artifact Registry Uri
+
+
+```hcl
+data "google_project" "project" {}
+
+resource "google_artifact_registry_repository" "upstream_repo" {
+  location      = "us-central1"
+  repository_id = "example-upstream-repo"
+  description   = "example upstream repository"
+  format        = "DOCKER"
+}
+
+resource "google_artifact_registry_repository" "my-repo" {
+  location      = "us-central1"
+  repository_id = "example-common-remote"
+  description   = "example remote common repository with docker upstream"
+  format        = "DOCKER"
+  mode          = "REMOTE_REPOSITORY"
+  remote_repository_config {
+    description = "pull-through cache of another Artifact Registry repository by URL"
+    common_repository {
+      uri         = "https://us-central1-docker.pkg.dev//example-upstream-repo"
+    }
+  }
+}
+```
+<div class = "oics-button" style="float: right; margin: 0 0 -15px">
+  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md&cloudshell_working_dir=artifact_registry_repository_remote_common_repository_with_custom_upstream&open_in_editor=main.tf" target="_blank">
+    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
+  </a>
+</div>
+## Example Usage - Artifact Registry Repository Remote Common Repository With Custom Upstream
+
+
+```hcl
+data "google_project" "project" {}
+
+resource "google_secret_manager_secret" "example-remote-secret" {
+  secret_id = "example-secret"
+  replication {
+    auto {}
+  }
+}
+
+resource "google_secret_manager_secret_version" "example-remote-secret_version" {
+  secret = google_secret_manager_secret.example-remote-secret.id
+  secret_data = "remote-password"
+}
+
+resource "google_secret_manager_secret_iam_member" "secret-access" {
+  secret_id = google_secret_manager_secret.example-remote-secret.id
+  role      = "roles/secretmanager.secretAccessor"
+  member    = "serviceAccount:service-${data.google_project.project.number}@gcp-sa-artifactregistry.iam.gserviceaccount.com"
+}
+
+resource "google_artifact_registry_repository" "my-repo" {
+  location      = "us-central1"
+  repository_id = "example-docker-custom-remote"
+  description   = "example remote custom docker repository with credentials"
+  format        = "DOCKER"
+  mode          = "REMOTE_REPOSITORY"
+  remote_repository_config {
+    description = "custom common docker remote with credentials"
+    disable_upstream_validation = true
+    common_repository {
+      uri = "https://registry-1.docker.io"
+    }
+    upstream_credentials {
+      username_password_credentials {
+        username = "remote-username"
+        password_secret_version = google_secret_manager_secret_version.example-remote-secret_version.name
+      }
+    }
+  }
+}
+```
 
 ## Argument Reference
 
@@ -818,7 +900,7 @@ The following arguments are supported:
 
 * `custom_repository` -
   (Optional)
-  Settings for a remote repository with a custom uri.
+  [Deprecated, please use commonRepository instead] Settings for a remote repository with a custom uri.
   Structure is [documented below](#nested_custom_repository).
 
 
@@ -838,7 +920,7 @@ The following arguments are supported:
 
 * `custom_repository` -
   (Optional)
-  Settings for a remote repository with a custom uri.
+  [Deprecated, please use commonRepository instead] Settings for a remote repository with a custom uri.
   Structure is [documented below](#nested_custom_repository).
 
 
@@ -858,7 +940,7 @@ The following arguments are supported:
 
 * `custom_repository` -
   (Optional)
-  Settings for a remote repository with a custom uri.
+  [Deprecated, please use commonRepository instead] Settings for a remote repository with a custom uri.
   Structure is [documented below](#nested_custom_repository).
 
 
@@ -878,7 +960,7 @@ The following arguments are supported:
 
 * `custom_repository` -
   (Optional)
-  Settings for a remote repository with a custom uri.
+  [Deprecated, please use commonRepository instead] Settings for a remote repository with a custom uri.
   Structure is [documented below](#nested_custom_repository).
 
 
@@ -911,7 +993,10 @@ The following arguments are supported:
 
 * `uri` -
   (Required)
-  Specific uri to the Artifact Registory repository, e.g. `projects/UPSTREAM_PROJECT_ID/locations/REGION/repositories/UPSTREAM_REPOSITORY`
+  One of:
+  a. Artifact Registry Repository resource, e.g. `projects/UPSTREAM_PROJECT_ID/locations/REGION/repositories/UPSTREAM_REPOSITORY`
+  b. URI to the registry, e.g. `"https://registry-1.docker.io"`
+  c. URI to Artifact Registry Repository, e.g. `"https://REGION-docker.pkg.dev/UPSTREAM_PROJECT_ID/UPSTREAM_REPOSITORY"`
 
 <a name="nested_upstream_credentials"></a>The `upstream_credentials` block supports: