DefaultPerm - Manage Quay Container Registry default repository permissions

The DefaultPerm 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 DefaultPerm 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: DefaultPerm
metadata:
  name: defaultperm-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 defaultperm resource, but you can specify a different namespace.
    # namespace: mynamespace

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

  organization: production
  name: production+robotprod1
  type: user
  role: write

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 DefaultPerm resource.

Type: string

Required: False

Default value: None

creator

Quay applies the default permission only when repositories are created by the user that you define in creator. By default, if you do not provide that creator parameter, then Quay applies the default permission to all new repositories, whoever creates them. You cannot use robot accounts or teams for the creator parameter. You can only use regular user accounts.

Type: string

Required: False

Default value: None

name

Name of the user or team that gets permission to new created repositories in the organization. For robot accounts use the namespace+shortrobotname format.

Type: string

Required: True

Default value: None

organization

Name of the organization for the default permission. This organization must exist.

Type: string

Required: True

Default value: None

preserveInQuayOnDeletion

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

Type: boolean

Required: False

Default value: False

role

Permission that Quay automatically grants to the user or team on new created repositories in the organization. If you do not provide that parameter, then the resource uses read by default.

Type: string

Required: False

Default value: None

type

Type of the account defined in name. Choose user for both user and robot accounts.

Type: string

Required: False

Default value: user

Listing the DefaultPerm Resources

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

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