IBM Container Registry module

You can use this module to provision and configure an IBM Container Registry namespace and optionally, a container registry retention policy.

Overview

• terraform-ibm-container-registry
• Submodules
  • endpoint
  • plan
  • quotas
• Examples ℹ️ Ctrl/Cmd+Click or right-click on the Schematics deploy button to open in a new tab
  • IBM Container Registry namespace example
• Deployable Architectures
  • Cloud automation for Container Registry (Fully configurable)
• Contributing

terraform-ibm-container-registry

Usage

module "namespace" {
  source            = "terraform-ibm-modules/container-registry/ibm"
  version           = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
  namespace_name    = "my-namespace"
  resource_group_id = "xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX"
  images_per_repo   = 2
}

module "upgrade-plan" {
  source  = "terraform-ibm-modules/container-registry/ibm//modules/plan"
  version = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
}

module "set_quota" {
  source  = "terraform-ibm-modules/container-registry/ibm//modules/quotas"
  version = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
  storage_megabytes = 5 * 1024 # 5GiB
  traffic_megabytes = 500 # 500 MB
  # Issue 324: Upgrade plan before setting quota
  depends_on        = [module.upgrade_plan]
}

Required IAM access policies

• Account Management
  • IBM Cloud Container Registry service
    • Writer, Manager service access

Access roles for using Container Registry

Requirements

Name	Version
terraform	>= 1.9.0
ibm	>= 1.79.0, < 2.0.0
time	>= 0.9.1, < 1.0.0

Modules

Name	Source	Version
namespace_cbr_rules	terraform-ibm-modules/cbr/ibm//modules/cbr-rule-module	1.35.13

Resources

Name	Type
ibm_cr_namespace.cr_namespace	resource
ibm_cr_retention_policy.cr_retention_policy	resource
ibm_resource_tag.access_tag	resource
ibm_resource_tag.resource_tag	resource
time_sleep.wait_for_namespace	resource
ibm_cr_namespaces.existing_cr_namespaces	data source

Inputs

Name	Description	Type	Default	Required
access_tags	Optional list of access management tags to be added to the IBM container namespace.	list(string)	[]	no
cbr_rules	The list of context-based restriction rules to create for the namespace.	list(object({ description = string account_id = string rule_contexts = list(object({ attributes = optional(list(object({ name = string value = string }))) })) enforcement_mode = string tags = optional(list(object({ name = string value = string })), []) operations = optional(list(object({ api_types = list(object({ api_type_id = string })) }))) }))	[]	no
existing_namespace_name	The name of an existing namespace. Required if 'namespace_name' is not provided.	string	null	no
images_per_repo	(Optional, Integer) Determines how many images are retained in each repository when the retention policy is processed. The value -1 denotes Unlimited (all images are retained). The value 0 denotes no retention policy will be created (default)	number	0	no
namespace_name	Name of the container registry namespace, if var.existing_namespace_name is not inputted, a new namespace will be created in a region set by provider.	string	n/a	yes
resource_group_id	The resource group ID where the IBM container namespace will be created.	string	n/a	yes
retain_untagged	(Optional, Bool) Determines whether untagged images are retained when the retention policy is processed. Default value is false, means untagged images can be deleted when the policy runs.	bool	false	no
tags	Optional list of user tags to be added to the IBM container namespace.	list(string)	[]	no

Outputs

Name	Description
namespace_crn	CRN representing the namespace
namespace_name	Name of ICR namespace
retention_policy_id	ID of retentation policy

Contributing

You can report issues and request features for this module in GitHub issues in the module repo. See Report an issue or request a feature.

To set up your local development environment, see Local development setup in the project documentation.