Files
hunfabric/modules/artifact-registry/variables.tf
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

266 lines
7.9 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.
*/
variable "cleanup_policies" {
description = "Object containing details about the cleanup policies for an Artifact Registry repository."
type = map(object({
action = string
condition = optional(object({
tag_state = optional(string)
tag_prefixes = optional(list(string))
older_than = optional(string)
newer_than = optional(string)
package_name_prefixes = optional(list(string))
version_name_prefixes = optional(list(string))
}))
most_recent_versions = optional(object({
package_name_prefixes = optional(list(string))
keep_count = optional(number)
}))
}))
default = null
}
variable "cleanup_policy_dry_run" {
description = "If true, the cleanup pipeline is prevented from deleting versions in this repository."
type = bool
default = null
}
variable "context" {
description = "Context-specific interpolations."
type = object({
artifact_registries = optional(map(string), {})
condition_vars = optional(map(map(string)), {})
custom_roles = optional(map(string), {})
iam_principals = optional(map(string), {})
kms_keys = optional(map(string), {})
locations = optional(map(string), {})
project_ids = optional(map(string), {})
secrets = optional(map(string), {})
tag_values = optional(map(string), {})
tag_vars = optional(object({
projects = optional(map(map(string)), {})
organization = optional(map(string), {})
}), {})
})
default = {}
nullable = false
}
variable "description" {
description = "An optional description for the repository."
type = string
default = "Terraform-managed registry"
}
variable "enable_vulnerability_scanning" {
description = "Whether vulnerability scanning should be enabled in the repository."
type = bool
default = null
}
variable "encryption_key" {
description = "The KMS key name to use for encryption at rest."
type = string
default = null
}
variable "format" {
description = "Repository format."
type = object({
apt = optional(object({
remote = optional(object({
# custom_repository = optional(string) # still not available in provider
public_repository = string # "BASE path"
disable_upstream_validation = optional(bool)
upstream_credentials = optional(object({
username = string
password_secret_version = string
}))
}))
standard = optional(bool)
}))
docker = optional(object({
remote = optional(object({
public_repository = optional(string)
common_repository = optional(string)
custom_repository = optional(string)
disable_upstream_validation = optional(bool)
upstream_credentials = optional(object({
username = string
password_secret_version = string
}))
}))
standard = optional(object({
immutable_tags = optional(bool)
}))
virtual = optional(map(object({
repository = string
priority = number
})))
}))
kfp = optional(object({
standard = optional(bool)
}))
generic = optional(object({
standard = optional(bool)
}))
go = optional(object({
standard = optional(bool)
}))
googet = optional(object({
standard = optional(bool)
}))
maven = optional(object({
remote = optional(object({
public_repository = optional(string)
common_repository = optional(string)
custom_repository = optional(string)
disable_upstream_validation = optional(bool)
upstream_credentials = optional(object({
username = string
password_secret_version = string
}))
}))
standard = optional(object({
allow_snapshot_overwrites = optional(bool)
version_policy = optional(string)
}))
virtual = optional(map(object({
repository = string
priority = number
})))
}))
npm = optional(object({
remote = optional(object({
public_repository = optional(string)
common_repository = optional(string)
custom_repository = optional(string)
disable_upstream_validation = optional(bool)
upstream_credentials = optional(object({
username = string
password_secret_version = string
}))
}))
standard = optional(bool)
virtual = optional(map(object({
repository = string
priority = number
})))
}))
python = optional(object({
remote = optional(object({
public_repository = optional(string)
common_repository = optional(string)
custom_repository = optional(string)
disable_upstream_validation = optional(bool)
upstream_credentials = optional(object({
username = string
password_secret_version = string
}))
}))
standard = optional(bool)
virtual = optional(map(object({
repository = string
priority = number
})))
}))
yum = optional(object({
remote = optional(object({
# custom_repository = optional(string) # still not available in provider
public_repository = string # "BASE path"
disable_upstream_validation = optional(bool)
upstream_credentials = optional(object({
username = string
password_secret_version = string
}))
}))
standard = optional(bool)
}))
})
nullable = false
validation {
condition = (
length([for k, v in var.format : k if v != null]) == 1
)
error_message = "Multiple or zero formats are not supported."
}
validation {
condition = alltrue([
for k, v in var.format :
length([for kk, vv in v : k if vv != null]) == 1
if v != null
])
error_message = "Repository can only be one of standard, remote or virtual."
}
validation {
condition = alltrue([
for k, v in var.format : (
(try(v.remote.public_repository, null) == null ? 0 : 1) +
(try(v.remote.custom_repository, null) == null ? 0 : 1) +
(try(v.remote.common_repository, null) == null ? 0 : 1)
) == 1
if try(v.remote, null) != null
])
error_message = "Remote repositories must specify exactly one of public_repository, custom_repository and common_repository."
}
}
variable "labels" {
description = "Labels to be attached to the registry."
type = map(string)
default = {}
}
variable "location" {
description = "Registry location. Use `gcloud beta artifacts locations list' to get valid values."
type = string
}
variable "name" {
description = "Registry name."
type = string
}
variable "project_id" {
description = "Registry project id."
type = string
}
variable "tag_bindings" {
description = "Tag bindings for this repository, in key => tag value id format."
type = map(string)
nullable = false
default = {}
}
variable "universe" {
description = "GCP universe where to deploy the project. The prefix will be prepended to the project id."
type = object({
package_domain = string
prefix = string
})
default = null
}