Tag - Manage Quay Container Registry image tags

The Tag custom resource relies on a Secret resource to provide the connection parameters to the Quay instance. This Secret resource must include the following data:

  • host: URL for accessing the Quay API, such as https://quay.example.com:8443 for example.
  • validateCerts: Whether to allow insecure connections to the API. By default, insecure connections are refused.
  • token: OAuth access token for authenticating against the API. To create such a token see the Creating an OAuth Access Token documentation. You can also use the ApiToken custom resource to create this token.
  • username: The username to use for authenticating against the API. If token is set, then username is ignored.
  • password: The password to use for authenticating against the API. If token is set, then password is ignored.

You can create the secret by using the kubectl create secret command:

kubectl create secret generic quay-credentials --from-literal host=https://quay.example.com:8443 --from-literal validateCerts=false --from-literal token=vFYyU2D0fHYXvcA3Y5TYfMrIMyVIH9YmxoVLsmku

Or you can create the secret from a resource file:

---
apiVersion: v1
kind: Secret
metadata:
  name: quay-credentials
stringData:
  host: https://quay.example.com:8443
  validateCerts: "false"
  token: vFYyU2D0fHYXvcA3Y5TYfMrIMyVIH9YmxoVLsmku

You refer to this secret in your Tag custom resource by using the connSecretRef property. See the usage example.

Warning

Do not delete the Secret resource if a Quay custom resource still references it. If you delete the Secret resource, then the Operator cannot connect to the Quay API anymore, and cannot synchronize the Quay custom resource with its corresponding object in Quay. In addition, deleting the Quay custom resource does not complete because the Operator cannot delete the corresponding object in Quay.

If you face this issue, then edit the custom resource (kubectl edit), and set the .spec.preserveInQuayOnDeletion property to true. Alternatively, you can remove the .metadata.finalizers section. In both case, you must manually delete the corresponding object in Quay.

Usage Example

---
apiVersion: quay.herve4m.github.io/v1alpha1
kind: Tag
metadata:
  name: tag-sample
spec:
  # Connection parameters in a Secret resource
  connSecretRef:
    name: quay-credentials
    # By default, the operator looks for the secret in the same namespace as
    # the tag resource, but you can specify a different namespace.
    # namespace: mynamespace

  # Whether to preserve the corresponding Quay object when you
  # delete the Tag resource.
  preserveInQuayOnDeletion: false

  image: production/smallimage:v1.4.3
  tag: v1
  expirationFormat: "%Y-%m-%d"
  expiration: "2025-05-25"

Properties

connSecretRef

Reference to the secret resource that stores the connection parameters to the Quay Container Registry API. The secret must include the host, token (or username and password), and optionally the validateCerts keys.

Type: object (see the following properties)

Required: True

Default value: None

connSecretRef.name

Name of the secret resource.

Type: string

Required: True

Default value: None

connSecretRef.namespace

Namespace of the secret resource. By default, the secret resource is retrieved from the same namespace as the current Tag resource.

Type: string

Required: False

Default value: None

expiration

Expiration date and time for the tag. The format is YYYYMMDDHHMM.SS but you can change it by setting the expirationFormat parameter. You cannot set an expiration date more that two years in the future. If you do so, then Quay forces the date at that two years boundary. You cannot set an expiration date in the past.

Type: string

Required: False

Default value: None

expirationFormat

Indicate the time format used in the expiration parameter. Based on default Python format (see https://docs.python.org/3/library/time.html#time.strftime).

Type: string

Required: False

Default value: %Y%m%d%H%M.%S

image

Name of the existing image. The format is namespace/repository:tag or namespace/repository@digest. The namespace can be an organization or a personal namespace. If you omit the namespace part, then the resource looks for the repository in your personal namespace. If you omit the tag and the digest part, then latest is assumed.

Type: string

Required: True

Default value: None

preserveInQuayOnDeletion

Whether to preserve the corresponding Quay object when you delete the Tag resource. When set to false (the default), the object is deleted from Quay.

Type: boolean

Required: False

Default value: False

tag

When state=present, the tag parameter provides the new tag to add to the image. If another image already uses that tag, then the resource removes the tag from that other image first. When state=absent, the tag parameter indicates the tag to remove. If you do not set that tag parameter, then the resource removes the tag that you give in the image name with the image parameter. When you specify the image by its digest, in the image parameter, then that tag parameter is mandatory.

Type: string

Required: False

Default value: None

Listing the Tag Resources

You can retrieve the list of the Tag custom resources in a namespace by using the kubectl get command:

kubectl get tags.quay.herve4m.github.io -n <namespace>