Files
Ludovico Magnocavallo 48fdf03233 artifact-registry: support common_repository in maven, npm, and python remote formats (#3944)
Add `common_repository` support to `maven`, `npm`, and `python` remote repository configurations in the `artifact-registry` module. This replaces the deprecated `custom_repository` feature which is now discouraged by the provider.

Existing README example `registry-mirror` has been updated to use `common_repository`. A legacy test case `legacy_custom_repo` has been added to the bottom of `README.md` to ensure backward compatibility for `custom_repository` continues to work.

TAG=agy
CONV=ffe77e65-ccef-4701-95e6-4ba2d2446f1b
2026-05-07 12:00:40 +02:00

258 lines
9.0 KiB
HCL

/**
* Copyright 2026 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
locals {
ctx = {
for k, v in var.context : k => {
for kk, vv in v : "${local.ctx_p}${k}:${kk}" => vv
} if !endswith(k, "_vars")
}
ctx_p = "$"
_tag_bindings = {
for k, v in var.tag_bindings : k => lookup(local.ctx.tag_values, v, v)
}
format_obj = one([for k, v in var.format : v if v != null])
format_string = one([for k, v in var.format : k if v != null])
location = lookup(local.ctx.locations, var.location, var.location)
mode_string = one([for k, v in local.format_obj : k if v != null && v != false])
project_id = lookup(local.ctx.project_ids, var.project_id, var.project_id)
}
resource "google_artifact_registry_repository" "registry" {
provider = google-beta
project = local.project_id
location = local.location
description = var.description
format = upper(local.format_string)
labels = var.labels
repository_id = var.name
mode = "${upper(local.mode_string)}_REPOSITORY"
kms_key_name = var.encryption_key == null ? null : lookup(
local.ctx.kms_keys, var.encryption_key, var.encryption_key
)
cleanup_policy_dry_run = var.cleanup_policy_dry_run
vulnerability_scanning_config {
enablement_config = (
var.enable_vulnerability_scanning == true
? "INHERITED"
: var.enable_vulnerability_scanning == false ? "DISABLED" : null
)
}
dynamic "cleanup_policies" {
for_each = var.cleanup_policies == null ? {} : var.cleanup_policies
content {
id = cleanup_policies.key
action = cleanup_policies.value.action
dynamic "condition" {
for_each = (cleanup_policies.value.condition != null) ? [""] : []
content {
tag_state = cleanup_policies.value.condition.tag_state
tag_prefixes = cleanup_policies.value.condition.tag_prefixes
version_name_prefixes = cleanup_policies.value.condition.version_name_prefixes
package_name_prefixes = cleanup_policies.value.condition.package_name_prefixes
newer_than = cleanup_policies.value.condition.newer_than
older_than = cleanup_policies.value.condition.older_than
}
}
dynamic "most_recent_versions" {
for_each = (cleanup_policies.value.most_recent_versions != null) ? [""] : []
content {
package_name_prefixes = cleanup_policies.value.most_recent_versions.package_name_prefixes
keep_count = cleanup_policies.value.most_recent_versions.keep_count
}
}
}
}
dynamic "docker_config" {
# TODO: open a bug on the provider for this permadiff
for_each = (
local.format_string == "docker" && try(local.format_obj.standard.immutable_tags, null) != null
? [""] : []
)
content {
immutable_tags = local.format_obj.standard.immutable_tags
}
}
dynamic "maven_config" {
for_each = local.format_string == "maven" ? [""] : []
content {
allow_snapshot_overwrites = try(local.format_obj.standard.allow_snapshot_overwrites, null)
version_policy = try(local.format_obj.standard.version_policy, null)
}
}
dynamic "remote_repository_config" {
for_each = local.mode_string == "remote" ? [""] : []
content {
disable_upstream_validation = local.format_obj.remote.disable_upstream_validation
dynamic "upstream_credentials" {
for_each = local.format_obj.remote.upstream_credentials != null ? [""] : []
content {
username_password_credentials {
username = local.format_obj.remote.upstream_credentials.username
password_secret_version = lookup(
local.ctx.secrets,
local.format_obj.remote.upstream_credentials.password_secret_version,
local.format_obj.remote.upstream_credentials.password_secret_version
)
}
}
}
dynamic "apt_repository" {
for_each = local.format_string == "apt" ? [""] : []
content {
public_repository {
repository_base = split(" ", local.format_obj.remote.public_repository)[0]
repository_path = split(" ", local.format_obj.remote.public_repository)[1]
}
# dynamic "custom_repository" {
# for_each = local.format_obj.remote.custom_repository != null ? [""] : []
# content {
# uri = local.format_obj.remote.custom_repository
# }
# }
}
}
dynamic "common_repository" {
for_each = (
contains(["docker", "maven", "npm", "python"], local.format_string) &&
try(local.format_obj.remote.common_repository, null) != null
? [""] : []
)
content {
uri = local.format_obj.remote.common_repository
}
}
dynamic "docker_repository" {
for_each = (
local.format_string == "docker" && try(local.format_obj.remote.common_repository, null) == null
? [""] : []
)
content {
public_repository = local.format_obj.remote.public_repository
dynamic "custom_repository" {
for_each = local.format_obj.remote.custom_repository != null ? [""] : []
content {
uri = local.format_obj.remote.custom_repository
}
}
}
}
dynamic "maven_repository" {
for_each = (
local.format_string == "maven" && try(local.format_obj.remote.common_repository, null) == null
? [""] : []
)
content {
public_repository = local.format_obj.remote.public_repository
dynamic "custom_repository" {
for_each = local.format_obj.remote.custom_repository != null ? [""] : []
content {
uri = local.format_obj.remote.custom_repository
}
}
}
}
dynamic "npm_repository" {
for_each = (
local.format_string == "npm" && try(local.format_obj.remote.common_repository, null) == null
? [""] : []
)
content {
public_repository = local.format_obj.remote.public_repository
dynamic "custom_repository" {
for_each = local.format_obj.remote.custom_repository != null ? [""] : []
content {
uri = local.format_obj.remote.custom_repository
}
}
}
}
dynamic "python_repository" {
for_each = (
local.format_string == "python" && try(local.format_obj.remote.common_repository, null) == null
? [""] : []
)
content {
public_repository = local.format_obj.remote.public_repository
dynamic "custom_repository" {
for_each = local.format_obj.remote.custom_repository != null ? [""] : []
content {
uri = local.format_obj.remote.custom_repository
}
}
}
}
dynamic "yum_repository" {
for_each = local.format_string == "yum" ? [""] : []
content {
public_repository {
repository_base = split(" ", local.format_obj.remote.public_repository)[0]
repository_path = split(" ", local.format_obj.remote.public_repository)[1]
}
# dynamic "custom_repository" {
# for_each = local.format_obj.remote.custom_repository != null ? [""] : []
# content {
# uri = local.format_obj.remote.custom_repository
# }
# }
}
}
}
}
dynamic "virtual_repository_config" {
for_each = local.mode_string == "virtual" ? [""] : []
content {
dynamic "upstream_policies" {
for_each = local.format_obj.virtual
content {
id = upstream_policies.key
repository = lookup(
local.ctx.artifact_registries,
upstream_policies.value.repository,
upstream_policies.value.repository
)
priority = upstream_policies.value.priority
}
}
}
}
lifecycle {
precondition {
condition = local.mode_string != "remote" || contains(
["apt", "docker", "maven", "npm", "python", "yum"], local.format_string
)
error_message = "Invalid format for remote repository."
}
}
}
resource "google_tags_location_tag_binding" "binding" {
for_each = var.tag_bindings
parent = "//artifactregistry.googleapis.com/${google_artifact_registry_repository.registry.id}"
location = local.location
tag_value = templatestring(local._tag_bindings[each.key], var.context.tag_vars)
}