ContainerRuntimeConfig describes a customized Container Runtime configuration.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
ContainerRuntimeConfig describes a customized Container Runtime configuration.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
object
spec
| Property | Type | Description |
|---|---|---|
|
|
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 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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
spec contains the desired container runtime configuration. |
|
|
status contains observed information about the container runtime configuration. |
spec contains the desired container runtime configuration.
object
containerRuntimeConfig
| Property | Type | Description |
|---|---|---|
|
|
containerRuntimeConfig defines the tuneables of the container runtime. |
|
|
machineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. A nil selector will result in no pools being selected. |
containerRuntimeConfig defines the tuneables of the container runtime.
object
| Property | Type | Description |
|---|---|---|
|
|
additionalArtifactStores configures additional read-only artifact storage locations for Open Container Initiative (OCI) artifacts. Artifacts are checked in order: additional stores first, then the default location (/var/lib/containers/storage/artifacts). Stores are read-only. Maximum of 10 stores allowed. Each path must be unique. When omitted, only the default artifact location is used. When specified, at least one store must be provided. |
|
|
AdditionalArtifactStore defines an additional read-only storage location for Open Container Initiative (OCI) artifacts. |
|
|
additionalImageStores configures additional read-only container image store locations for Open Container Initiative (OCI) images. Images are checked in order: additional stores first, then the default location. Stores are read-only. Maximum of 10 stores allowed. Each path must be unique. When omitted, only the default image location is used. When specified, at least one store must be provided. |
|
|
AdditionalImageStore defines an additional read-only storage location for Open Container Initiative (OCI) images. |
|
|
additionalLayerStores configures additional read-only container image layer store locations for Open Container Initiative (OCI) images. Layers are checked in order: additional stores first, then the default location. Stores are read-only. Maximum of 5 stores allowed. Each path must be unique. When omitted, only the default layer location is used. When specified, at least one store must be provided. |
|
|
AdditionalLayerStore defines a read-only storage location for Open Container Initiative (OCI) container image layers. |
|
|
defaultRuntime is the name of the OCI runtime to be used as the default for containers.
Allowed values are |
|
|
logLevel specifies the verbosity of the logs based on the level it is set to. Options are fatal, panic, error, warn, info, and debug. |
|
|
logSizeMax specifies the Maximum size allowed for the container log file. Negative numbers indicate that no size limit is imposed. If it is positive, it must be >= 8192 to match/exceed conmon’s read buffer. |
|
|
overlaySize specifies the maximum size of a container image. This flag can be used to set quota on the size of container images. (default: 10GB) |
|
|
pidsLimit specifies the maximum number of processes allowed in a container |
additionalArtifactStores configures additional read-only artifact storage locations for Open Container Initiative (OCI) artifacts.
Artifacts are checked in order: additional stores first, then the default location (/var/lib/containers/storage/artifacts). Stores are read-only. Maximum of 10 stores allowed. Each path must be unique.
When omitted, only the default artifact location is used. When specified, at least one store must be provided.
array
AdditionalArtifactStore defines an additional read-only storage location for Open Container Initiative (OCI) artifacts.
object
path
| Property | Type | Description |
|---|---|---|
|
|
path specifies the absolute location of the additional artifact store. The path must exist on the node before configuration is applied. When an artifact is requested, artifacts found at this location will be used instead of retrieving from the registry. The path is required and must be between 1 and 256 characters long, begin with a forward slash, and only contain the characters a-z, A-Z, 0-9, '/', '.', '_', and '-'. Consecutive forward slashes are not permitted. |
additionalImageStores configures additional read-only container image store locations for Open Container Initiative (OCI) images.
Images are checked in order: additional stores first, then the default location. Stores are read-only. Maximum of 10 stores allowed. Each path must be unique.
When omitted, only the default image location is used. When specified, at least one store must be provided.
array
AdditionalImageStore defines an additional read-only storage location for Open Container Initiative (OCI) images.
object
path
| Property | Type | Description |
|---|---|---|
|
|
path specifies the absolute location of the additional image store. The path must exist on the node before configuration is applied. When a container image is requested, images found at this location will be used instead of retrieving from the registry. The path is required and must be between 1 and 256 characters long, begin with a forward slash, and only contain the characters a-z, A-Z, 0-9, '/', '.', '_', and '-'. Consecutive forward slashes are not permitted. |
additionalLayerStores configures additional read-only container image layer store locations for Open Container Initiative (OCI) images.
Layers are checked in order: additional stores first, then the default location. Stores are read-only. Maximum of 5 stores allowed. Each path must be unique.
When omitted, only the default layer location is used. When specified, at least one store must be provided.
array
AdditionalLayerStore defines a read-only storage location for Open Container Initiative (OCI) container image layers.
object
path
| Property | Type | Description |
|---|---|---|
|
|
path specifies the absolute location of the additional layer store. The path must exist on the node before configuration is applied. When a container image is requested, layers found at this location will be used instead of retrieving from the registry. The path is required and must be between 1 and 256 characters long, begin with a forward slash, and only contain the characters a-z, A-Z, 0-9, '/', '.', '_', and '-'. Consecutive forward slashes are not permitted. |
machineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. A nil selector will result in no pools being selected.
object
| Property | Type | Description |
|---|---|---|
|
|
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
|
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
matchExpressions is a list of label selector requirements. The requirements are ANDed.
array
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
object
key
operator
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
|
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
status contains observed information about the container runtime configuration.
object
| Property | Type | Description |
|---|---|---|
|
|
conditions represents the latest available observations of current state. |
|
|
ContainerRuntimeConfigCondition defines the state of the ContainerRuntimeConfig |
|
|
observedGeneration represents the generation observed by the controller. |
conditions represents the latest available observations of current state.
array
ContainerRuntimeConfigCondition defines the state of the ContainerRuntimeConfig
object
| Property | Type | Description |
|---|---|---|
|
`` |
lastTransitionTime is the time of the last update to the current status object. |
|
|
message provides additional information about the current condition. This is only to be consumed by humans. |
|
|
reason is the reason for the condition’s last transition. Reasons are PascalCase |
|
|
status of the condition, one of True, False, Unknown. |
|
|
type specifies the state of the operator’s reconciliation functionality. |
The following API endpoints are available:
/apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs
DELETE: delete collection of ContainerRuntimeConfig
GET: list objects of kind ContainerRuntimeConfig
POST: create a ContainerRuntimeConfig
/apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name}
DELETE: delete a ContainerRuntimeConfig
GET: read the specified ContainerRuntimeConfig
PATCH: partially update the specified ContainerRuntimeConfig
PUT: replace the specified ContainerRuntimeConfig
/apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name}/status
GET: read status of the specified ContainerRuntimeConfig
PATCH: partially update status of the specified ContainerRuntimeConfig
PUT: replace status of the specified ContainerRuntimeConfig
DELETE
delete collection of ContainerRuntimeConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
list objects of kind ContainerRuntimeConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
POST
create a ContainerRuntimeConfig
| Parameter | Type | Description |
|---|---|---|
|
|
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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
| Parameter | Type | Description |
|---|---|---|
|
|
name of the ContainerRuntimeConfig |
DELETE
delete a ContainerRuntimeConfig
| Parameter | Type | Description |
|---|---|---|
|
|
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 |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
GET
read the specified ContainerRuntimeConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified ContainerRuntimeConfig
| Parameter | Type | Description |
|---|---|---|
|
|
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 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. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace the specified ContainerRuntimeConfig
| Parameter | Type | Description |
|---|---|---|
|
|
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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |
| Parameter | Type | Description |
|---|---|---|
|
|
name of the ContainerRuntimeConfig |
GET
read status of the specified ContainerRuntimeConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update status of the specified ContainerRuntimeConfig
| Parameter | Type | Description |
|---|---|---|
|
|
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 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. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace status of the specified ContainerRuntimeConfig
| Parameter | Type | Description |
|---|---|---|
|
|
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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |