×
Description

CRIOCredentialProviderConfig holds cluster-wide singleton resource configurations for CRI-O credential provider, the name of this instance is "cluster". CRI-O credential provider is a binary shipped with CRI-O that provides a way to obtain container image pull credentials from external sources. For example, it can be used to fetch mirror registry credentials from secrets resources in the cluster within the same namespace the pod will be running in. CRIOCredentialProviderConfig configuration specifies the pod image sources registries that should trigger the CRI-O credential provider execution, which will resolve the CRI-O mirror configurations and obtain the necessary credentials for pod creation. Note: Configuration changes will only take effect after the kubelet restarts, which is automatically managed by the cluster during rollout.

The resource is a singleton named "cluster".

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

object

Required
  • spec

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec defines the desired configuration of the CRI-O Credential Provider. This field is required and must be provided when creating the resource.

status

object

status represents the current state of the CRIOCredentialProviderConfig. When omitted or nil, it indicates that the status has not yet been set by the controller. The controller will populate this field with validation conditions and operational state.

.spec

Description

spec defines the desired configuration of the CRI-O Credential Provider. This field is required and must be provided when creating the resource.

Type

object

Property Type Description

matchImages

array (string)

matchImages is a list of string patterns used to determine whether the CRI-O credential provider should be invoked for a given image. This list is passed to the kubelet CredentialProviderConfig, and if any pattern matches the requested image, CRI-O credential provider will be invoked to obtain credentials for pulling that image or its mirrors. Depending on the platform, the CRI-O credential provider may be installed alongside an existing platform specific provider. Conflicts between the existing platform specific provider image match configuration and this list will be handled by the following precedence rule: credentials from built-in kubelet providers (e.g., ECR, GCR, ACR) take precedence over those from the CRIOCredentialProviderConfig when both match the same image. To avoid uncertainty, it is recommended to avoid configuring your private image patterns to overlap with existing platform specific provider config(e.g., the entries from https://github.com/openshift/machine-config-operator/blob/main/templates/common/aws/files/etc-kubernetes-credential-providers-ecr-credential-provider.yaml). You can check the resource’s Status conditions to see if any entries were ignored due to exact matches with known built-in provider patterns.

This field is optional, the items of the list must contain between 1 and 50 entries. The list is treated as a set, so duplicate entries are not allowed.

For more details, see: https://kubernetes.io/docs/tasks/administer-cluster/kubelet-credential-provider/ https://github.com/cri-o/crio-credential-provider#architecture

Each entry in matchImages is a pattern which can optionally contain a port and a path. Each entry must be no longer than 512 characters. Wildcards ('') are supported for full subdomain labels, such as '.k8s.io' or 'k8s..io', and for top-level domains, such as 'k8s.' (which matches 'k8s.io' or 'k8s.net'). A global wildcard '' (matching any domain) is not allowed. Wildcards may replace an entire hostname label (e.g., *.example.com), but they cannot appear within a label (e.g., f*oo.example.com) and are not allowed in the port or path. For example, 'example..com' is valid, but 'exa*mple..com' is not. Each wildcard matches only a single domain label, so '.io' does not match '.k8s.io'.

A match exists between an image and a matchImage when all of the below are true: Both contain the same number of domain parts and each part matches. The URL path of an matchImages must be a prefix of the target image URL path. If the matchImages contains a port, then the port must match in the image as well.

Example values of matchImages: - 123456789.dkr.ecr.us-east-1.amazonaws.com - *.azurecr.io - gcr.io - *..registry.io - registry.io:8080/path

.status

Description

status represents the current state of the CRIOCredentialProviderConfig. When omitted or nil, it indicates that the status has not yet been set by the controller. The controller will populate this field with validation conditions and operational state.

Type

object

Property Type Description

conditions

array

conditions represent the latest available observations of the configuration state. When omitted, it indicates that no conditions have been reported yet. The maximum number of conditions is 16. Conditions are stored as a map keyed by condition type, ensuring uniqueness.

Expected condition types include: "Validated": indicates whether the matchImages configuration is valid

conditions[]

object

Condition contains details for one aspect of the current state of this API Resource.

.status.conditions

Description

conditions represent the latest available observations of the configuration state. When omitted, it indicates that no conditions have been reported yet. The maximum number of conditions is 16. Conditions are stored as a map keyed by condition type, ensuring uniqueness.

Expected condition types include: "Validated": indicates whether the matchImages configuration is valid

Type

array

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource.

Type

object

Required
  • lastTransitionTime

  • message

  • reason

  • status

  • type

Property Type Description

lastTransitionTime

string

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status

string

status of the condition, one of True, False, Unknown.

type

string

type of condition in CamelCase or in foo.example.com/CamelCase.

API endpoints

The following API endpoints are available:

  • /apis/config.openshift.io/v1/criocredentialproviderconfigs

    • DELETE: delete collection of CRIOCredentialProviderConfig

    • GET: list objects of kind CRIOCredentialProviderConfig

    • POST: create a CRIOCredentialProviderConfig

  • /apis/config.openshift.io/v1/criocredentialproviderconfigs/{name}

    • DELETE: delete a CRIOCredentialProviderConfig

    • GET: read the specified CRIOCredentialProviderConfig

    • PATCH: partially update the specified CRIOCredentialProviderConfig

    • PUT: replace the specified CRIOCredentialProviderConfig

  • /apis/config.openshift.io/v1/criocredentialproviderconfigs/{name}/status

    • GET: read status of the specified CRIOCredentialProviderConfig

    • PATCH: partially update status of the specified CRIOCredentialProviderConfig

    • PUT: replace status of the specified CRIOCredentialProviderConfig

/apis/config.openshift.io/v1/criocredentialproviderconfigs

HTTP method

DELETE

Description

delete collection of CRIOCredentialProviderConfig

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list objects of kind CRIOCredentialProviderConfig

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

CRIOCredentialProviderConfigList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create a CRIOCredentialProviderConfig

Table 3. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 4. Body parameters
Parameter Type Description

body

CRIOCredentialProviderConfig schema

Table 5. HTTP responses
HTTP code Reponse body

200 - OK

CRIOCredentialProviderConfig schema

201 - Created

CRIOCredentialProviderConfig schema

202 - Accepted

CRIOCredentialProviderConfig schema

401 - Unauthorized

Empty

/apis/config.openshift.io/v1/criocredentialproviderconfigs/{name}

Table 6. Global path parameters
Parameter Type Description

name

string

name of the CRIOCredentialProviderConfig

HTTP method

DELETE

Description

delete a CRIOCredentialProviderConfig

Table 7. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified CRIOCredentialProviderConfig

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

CRIOCredentialProviderConfig schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified CRIOCredentialProviderConfig

Table 10. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 11. HTTP responses
HTTP code Reponse body

200 - OK

CRIOCredentialProviderConfig schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified CRIOCredentialProviderConfig

Table 12. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. Body parameters
Parameter Type Description

body

CRIOCredentialProviderConfig schema

Table 14. HTTP responses
HTTP code Reponse body

200 - OK

CRIOCredentialProviderConfig schema

201 - Created

CRIOCredentialProviderConfig schema

401 - Unauthorized

Empty

/apis/config.openshift.io/v1/criocredentialproviderconfigs/{name}/status

Table 15. Global path parameters
Parameter Type Description

name

string

name of the CRIOCredentialProviderConfig

HTTP method

GET

Description

read status of the specified CRIOCredentialProviderConfig

Table 16. HTTP responses
HTTP code Reponse body

200 - OK

CRIOCredentialProviderConfig schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified CRIOCredentialProviderConfig

Table 17. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18. HTTP responses
HTTP code Reponse body

200 - OK

CRIOCredentialProviderConfig schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified CRIOCredentialProviderConfig

Table 19. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 20. Body parameters
Parameter Type Description

body

CRIOCredentialProviderConfig schema

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

CRIOCredentialProviderConfig schema

201 - Created

CRIOCredentialProviderConfig schema

401 - Unauthorized

Empty