Skip to content

Commit 8faddbc

Browse files
Support common_repository for google_artifact_registry_repository (#12290) (#8681)
[upstream:817990220aced261b121b0e32dca4ab160e72c55] Signed-off-by: Modular Magician <[email protected]>
1 parent 029aef6 commit 8faddbc

File tree

4 files changed

+167
-6
lines changed

4 files changed

+167
-6
lines changed

.changelog/12290.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```release-note:enhancement
2+
artifactregistry: added `common_repository` field to `google_artifact_registry_repository` resource
3+
```

google-beta/services/artifactregistry/resource_artifact_registry_repository.go

Lines changed: 73 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,25 @@ snapshot versions.`,
339339
},
340340
},
341341
},
342-
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository"},
342+
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository", "remote_repository_config.0.common_repository"},
343+
},
344+
"common_repository": {
345+
Type: schema.TypeList,
346+
Optional: true,
347+
ForceNew: true,
348+
Description: `Specific settings for an Artifact Registory remote repository.`,
349+
MaxItems: 1,
350+
Elem: &schema.Resource{
351+
Schema: map[string]*schema.Schema{
352+
"uri": {
353+
Type: schema.TypeString,
354+
Required: true,
355+
ForceNew: true,
356+
Description: `Specific uri to the Artifact Registory repository, e.g. 'projects/UPSTREAM_PROJECT_ID/locations/REGION/repositories/UPSTREAM_REPOSITORY'`,
357+
},
358+
},
359+
},
360+
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository", "remote_repository_config.0.common_repository"},
343361
},
344362
"description": {
345363
Type: schema.TypeString,
@@ -390,7 +408,7 @@ not be validated.`,
390408
},
391409
},
392410
},
393-
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository"},
411+
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository", "remote_repository_config.0.common_repository"},
394412
},
395413
"maven_repository": {
396414
Type: schema.TypeList,
@@ -429,7 +447,7 @@ not be validated.`,
429447
},
430448
},
431449
},
432-
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository"},
450+
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository", "remote_repository_config.0.common_repository"},
433451
},
434452
"npm_repository": {
435453
Type: schema.TypeList,
@@ -468,7 +486,7 @@ not be validated.`,
468486
},
469487
},
470488
},
471-
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository"},
489+
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository", "remote_repository_config.0.common_repository"},
472490
},
473491
"python_repository": {
474492
Type: schema.TypeList,
@@ -507,7 +525,7 @@ not be validated.`,
507525
},
508526
},
509527
},
510-
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository"},
528+
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository", "remote_repository_config.0.common_repository"},
511529
},
512530
"upstream_credentials": {
513531
Type: schema.TypeList,
@@ -579,7 +597,7 @@ remote repository. Must be in the format of
579597
},
580598
},
581599
},
582-
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository"},
600+
ExactlyOneOf: []string{"remote_repository_config.0.apt_repository", "remote_repository_config.0.docker_repository", "remote_repository_config.0.maven_repository", "remote_repository_config.0.npm_repository", "remote_repository_config.0.python_repository", "remote_repository_config.0.yum_repository", "remote_repository_config.0.common_repository"},
583601
},
584602
},
585603
},
@@ -1407,6 +1425,8 @@ func flattenArtifactRegistryRepositoryRemoteRepositoryConfig(v interface{}, d *s
14071425
flattenArtifactRegistryRepositoryRemoteRepositoryConfigPythonRepository(original["pythonRepository"], d, config)
14081426
transformed["yum_repository"] =
14091427
flattenArtifactRegistryRepositoryRemoteRepositoryConfigYumRepository(original["yumRepository"], d, config)
1428+
transformed["common_repository"] =
1429+
flattenArtifactRegistryRepositoryRemoteRepositoryConfigCommonRepository(original["commonRepository"], d, config)
14101430
transformed["upstream_credentials"] =
14111431
flattenArtifactRegistryRepositoryRemoteRepositoryConfigUpstreamCredentials(original["upstreamCredentials"], d, config)
14121432
transformed["disable_upstream_validation"] =
@@ -1649,6 +1669,23 @@ func flattenArtifactRegistryRepositoryRemoteRepositoryConfigYumRepositoryPublicR
16491669
return v
16501670
}
16511671

1672+
func flattenArtifactRegistryRepositoryRemoteRepositoryConfigCommonRepository(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
1673+
if v == nil {
1674+
return nil
1675+
}
1676+
original := v.(map[string]interface{})
1677+
if len(original) == 0 {
1678+
return nil
1679+
}
1680+
transformed := make(map[string]interface{})
1681+
transformed["uri"] =
1682+
flattenArtifactRegistryRepositoryRemoteRepositoryConfigCommonRepositoryUri(original["uri"], d, config)
1683+
return []interface{}{transformed}
1684+
}
1685+
func flattenArtifactRegistryRepositoryRemoteRepositoryConfigCommonRepositoryUri(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
1686+
return v
1687+
}
1688+
16521689
func flattenArtifactRegistryRepositoryRemoteRepositoryConfigUpstreamCredentials(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
16531690
if v == nil {
16541691
return nil
@@ -2075,6 +2112,13 @@ func expandArtifactRegistryRepositoryRemoteRepositoryConfig(v interface{}, d tpg
20752112
transformed["yumRepository"] = transformedYumRepository
20762113
}
20772114

2115+
transformedCommonRepository, err := expandArtifactRegistryRepositoryRemoteRepositoryConfigCommonRepository(original["common_repository"], d, config)
2116+
if err != nil {
2117+
return nil, err
2118+
} else if val := reflect.ValueOf(transformedCommonRepository); val.IsValid() && !tpgresource.IsEmptyValue(val) {
2119+
transformed["commonRepository"] = transformedCommonRepository
2120+
}
2121+
20782122
transformedUpstreamCredentials, err := expandArtifactRegistryRepositoryRemoteRepositoryConfigUpstreamCredentials(original["upstream_credentials"], d, config)
20792123
if err != nil {
20802124
return nil, err
@@ -2414,6 +2458,29 @@ func expandArtifactRegistryRepositoryRemoteRepositoryConfigYumRepositoryPublicRe
24142458
return v, nil
24152459
}
24162460

2461+
func expandArtifactRegistryRepositoryRemoteRepositoryConfigCommonRepository(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
2462+
l := v.([]interface{})
2463+
if len(l) == 0 || l[0] == nil {
2464+
return nil, nil
2465+
}
2466+
raw := l[0]
2467+
original := raw.(map[string]interface{})
2468+
transformed := make(map[string]interface{})
2469+
2470+
transformedUri, err := expandArtifactRegistryRepositoryRemoteRepositoryConfigCommonRepositoryUri(original["uri"], d, config)
2471+
if err != nil {
2472+
return nil, err
2473+
} else if val := reflect.ValueOf(transformedUri); val.IsValid() && !tpgresource.IsEmptyValue(val) {
2474+
transformed["uri"] = transformedUri
2475+
}
2476+
2477+
return transformed, nil
2478+
}
2479+
2480+
func expandArtifactRegistryRepositoryRemoteRepositoryConfigCommonRepositoryUri(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
2481+
return v, nil
2482+
}
2483+
24172484
func expandArtifactRegistryRepositoryRemoteRepositoryConfigUpstreamCredentials(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
24182485
l := v.([]interface{})
24192486
if len(l) == 0 || l[0] == nil {

google-beta/services/artifactregistry/resource_artifact_registry_repository_generated_test.go

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -775,6 +775,56 @@ resource "google_artifact_registry_repository" "my-repo" {
775775
`, context)
776776
}
777777

778+
func TestAccArtifactRegistryRepository_artifactRegistryRepositoryRemoteCommonRepositoryWithDockerExample(t *testing.T) {
779+
t.Parallel()
780+
781+
context := map[string]interface{}{
782+
"random_suffix": acctest.RandString(t, 10),
783+
}
784+
785+
acctest.VcrTest(t, resource.TestCase{
786+
PreCheck: func() { acctest.AccTestPreCheck(t) },
787+
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
788+
CheckDestroy: testAccCheckArtifactRegistryRepositoryDestroyProducer(t),
789+
Steps: []resource.TestStep{
790+
{
791+
Config: testAccArtifactRegistryRepository_artifactRegistryRepositoryRemoteCommonRepositoryWithDockerExample(context),
792+
},
793+
{
794+
ResourceName: "google_artifact_registry_repository.my-repo",
795+
ImportState: true,
796+
ImportStateVerify: true,
797+
ImportStateVerifyIgnore: []string{"labels", "location", "remote_repository_config.0.disable_upstream_validation", "repository_id", "terraform_labels"},
798+
},
799+
},
800+
})
801+
}
802+
803+
func testAccArtifactRegistryRepository_artifactRegistryRepositoryRemoteCommonRepositoryWithDockerExample(context map[string]interface{}) string {
804+
return acctest.Nprintf(`
805+
resource "google_artifact_registry_repository" "upstream_repo" {
806+
location = "us-central1"
807+
repository_id = "tf-test-example-upstream-repo%{random_suffix}"
808+
description = "example upstream repository%{random_suffix}"
809+
format = "DOCKER"
810+
}
811+
812+
resource "google_artifact_registry_repository" "my-repo" {
813+
location = "us-central1"
814+
repository_id = "tf-test-example-common-remote%{random_suffix}"
815+
description = "example remote common repository with docker upstream%{random_suffix}"
816+
format = "DOCKER"
817+
mode = "REMOTE_REPOSITORY"
818+
remote_repository_config {
819+
description = "pull-through cache of another Artifact Registry repository"
820+
common_repository {
821+
uri = google_artifact_registry_repository.upstream_repo.id
822+
}
823+
}
824+
}
825+
`, context)
826+
}
827+
778828
func testAccCheckArtifactRegistryRepositoryDestroyProducer(t *testing.T) func(s *terraform.State) error {
779829
return func(s *terraform.State) error {
780830
for name, rs := range s.RootModule().Resources {

website/docs/r/artifact_registry_repository.html.markdown

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -512,6 +512,36 @@ resource "google_artifact_registry_repository" "my-repo" {
512512
}
513513
}
514514
```
515+
<div class = "oics-button" style="float: right; margin: 0 0 -15px">
516+
<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_docker&open_in_editor=main.tf" target="_blank">
517+
<img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
518+
</a>
519+
</div>
520+
## Example Usage - Artifact Registry Repository Remote Common Repository With Docker
521+
522+
523+
```hcl
524+
resource "google_artifact_registry_repository" "upstream_repo" {
525+
location = "us-central1"
526+
repository_id = "example-upstream-repo"
527+
description = "example upstream repository"
528+
format = "DOCKER"
529+
}
530+
531+
resource "google_artifact_registry_repository" "my-repo" {
532+
location = "us-central1"
533+
repository_id = "example-common-remote"
534+
description = "example remote common repository with docker upstream"
535+
format = "DOCKER"
536+
mode = "REMOTE_REPOSITORY"
537+
remote_repository_config {
538+
description = "pull-through cache of another Artifact Registry repository"
539+
common_repository {
540+
uri = google_artifact_registry_repository.upstream_repo.id
541+
}
542+
}
543+
}
544+
```
515545

516546
## Argument Reference
517547

@@ -743,6 +773,11 @@ The following arguments are supported:
743773
Specific settings for an Yum remote repository.
744774
Structure is [documented below](#nested_yum_repository).
745775

776+
* `common_repository` -
777+
(Optional)
778+
Specific settings for an Artifact Registory remote repository.
779+
Structure is [documented below](#nested_common_repository).
780+
746781
* `upstream_credentials` -
747782
(Optional)
748783
The credentials used to access the remote repository.
@@ -872,6 +907,12 @@ The following arguments are supported:
872907
(Required)
873908
Specific repository from the base, e.g. `"pub/rocky/9/BaseOS/x86_64/os"`
874909

910+
<a name="nested_common_repository"></a>The `common_repository` block supports:
911+
912+
* `uri` -
913+
(Required)
914+
Specific uri to the Artifact Registory repository, e.g. `projects/UPSTREAM_PROJECT_ID/locations/REGION/repositories/UPSTREAM_REPOSITORY`
915+
875916
<a name="nested_upstream_credentials"></a>The `upstream_credentials` block supports:
876917

877918
* `username_password_credentials` -

0 commit comments

Comments
 (0)