oci_artifacts_container_repository

This resource provides the Container Repository resource in Oracle Cloud Infrastructure Artifacts service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/registry/latest/ContainerRepository

Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/artifacts

Create a new empty container repository. Avoid entering confidential information.

Example Usage

resource "oci_artifacts_container_repository" "test_container_repository" {
	#Required
	compartment_id = var.compartment_id
	display_name = var.container_repository_display_name

	#Optional
	defined_tags = {"Operations.CostCenter"= "42"}
	freeform_tags = {"Department"= "Finance"}
	is_immutable = var.container_repository_is_immutable
	is_public = var.container_repository_is_public
	is_top_level = var.container_repository_is_top_level
	multi_region_peers = var.container_repository_multi_region_peers
	readme {
		#Required
		content = var.container_repository_readme_content
		format = var.container_repository_readme_format
	}
	repository_type = var.container_repository_repository_type
	upstream_secret_id = var.container_repository_upstream_secret_id
	upstream_url = var.container_repository_upstream_url
	upstream_username = var.container_repository_upstream_username
}

Argument Reference

The following arguments are supported:

• compartment_id - (Required) (Updatable) The OCID of the compartment in which to create the resource.

• defined_tags - (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

• display_name - (Required) The container repository name.

• freeform_tags - (Optional) (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

• is_immutable - (Optional) (Updatable) Whether the repository is immutable. Images cannot be overwritten in an immutable repository. Currently, setting this flag is not supported yet and is set to false by default.

• is_public - (Optional) (Updatable) Whether the repository is public. A public repository allows unauthenticated access.

• is_top_level - (Optional) Whether the repository is top-level. A top-level repository reserves its name in namespace as a prefix and allows images to be hosted under child paths of that prefix.

• multi_region_peers - (Optional) List of peer regions that define the multi-region group. Peer regions must be specified using canonical region names (for example, us-phoenix-1). The peer set must match a supported multi-region endpoint group and MUST include the local OCIR region where the repository is created. Required when repositoryType is MULTI_REGION.

• readme - (Optional) (Updatable) Container repository readme.

  • content - (Required) (Updatable) Readme content. Avoid entering confidential information.
  • format - (Required) (Updatable) Readme format. Supported formats are text/plain and text/markdown.

• repository_type - (Optional) The type of container repository. This determines the repository behavior and required settings.

• upstream_secret_id - (Optional) (Updatable) The OCID of the Oracle Cloud Infrastructure Vault secret that contains the upstream registry password as base64 encoded string for a pull-through cache repository. Required when repositoryType is PULL_THROUGH. Example: ocid1.vaultsecret.oc1..exampleuniqueID

• upstream_url - (Optional) The upstream registry URL for a pull-through cache repository. Required when repositoryType is PULL_THROUGH. The value must include the registry endpoint and repository path, and must not include a tag or digest.

  If isTopLevel is false, the value must be an exact upstream image full path. Example: iad.ocir.io/<upstreamNamespace>/library/ubuntu

  If isTopLevel is true, the value must be an upstream repository path prefix, allowing OCIR to pull multiple repositories under that prefix. Example: iad.ocir.io/<upstreamNamespace>/library or iad.ocir.io/<upstreamNamespace>

• upstream_username - (Optional) (Updatable) The upstream registry username for a pull-through cache repository. Required when repositoryType is PULL_THROUGH.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Attributes Reference

The following attributes are exported:

• billable_size_in_gbs - Total storage size in GBs that will be charged.
• compartment_id - The OCID of the compartment in which the container repository exists.
• created_by - The id of the user or principal that created the resource.
• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
• display_name - The container repository name.
• freeform_tags - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
• id - The OCID of the container repository. Example: ocid1.containerrepo.oc1..exampleuniqueID
• image_count - Total number of images.
• is_immutable - Whether the repository is immutable. Images cannot be overwritten in an immutable repository.
• is_public - Whether the repository is public. A public repository allows unauthenticated access.
• is_top_level - Whether the repository is top-level. A top-level repository reserves its name in namespace as a prefix and allows images to be hosted under child paths of that prefix.
• layer_count - Total number of layers.
• layers_size_in_bytes - Total storage in bytes consumed by layers.
• multi_region_peers - List of peer regions that define the multi-region group. Peer regions must be specified using canonical region names (for example, us-phoenix-1). The peer set must match a supported multi-region endpoint group and MUST include the local OCIR region where the repository is created.
• namespace - The tenancy namespace used in the container repository path.
• readme - Container repository readme.
  • content - Readme content. Avoid entering confidential information.
  • format - Readme format. Supported formats are text/plain and text/markdown.
• repository_type - The type of container repository. This determines the repository behavior and required settings.
• state - The current state of the container repository.
• system_tags - The system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
• time_created - An RFC 3339 timestamp indicating when the repository was created.
• time_last_pushed - An RFC 3339 timestamp indicating when an image was last pushed to the repository.
• upstream_secret_id - The OCID of the Oracle Cloud Infrastructure Vault secret that contains the upstream registry password as base64 encoded string for a pull-through cache repository.
• upstream_url - The upstream registry URL for a pull-through cache repository.
• upstream_username - The upstream registry username for a pull-through cache repository.

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 20 minutes), when creating the Container Repository * update - (Defaults to 20 minutes), when updating the Container Repository * delete - (Defaults to 20 minutes), when destroying the Container Repository

Import

ContainerRepositories can be imported using the id, e.g.

$ terraform import oci_artifacts_container_repository.test_container_repository "{repositoryId}"