Search

Chapter 2. ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]

download PDF
Description
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).
Type
object
Required
  • spec

2.1. Specification

PropertyTypeDescription

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

ContainerRuntimeConfigSpec defines the desired state of ContainerRuntimeConfig

status

object

ContainerRuntimeConfigStatus defines the observed state of a ContainerRuntimeConfig

2.1.1. .spec

Description
ContainerRuntimeConfigSpec defines the desired state of ContainerRuntimeConfig
Type
object
Required
  • containerRuntimeConfig
PropertyTypeDescription

containerRuntimeConfig

object

ContainerRuntimeConfiguration defines the tuneables of the container runtime

machineConfigPoolSelector

object

MachineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. A nil selector will result in no pools being selected.

2.1.2. .spec.containerRuntimeConfig

Description
ContainerRuntimeConfiguration defines the tuneables of the container runtime
Type
object
PropertyTypeDescription

defaultRuntime

string

defaultRuntime is the name of the OCI runtime to be used as the default.

logLevel

string

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

integer-or-string

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

integer-or-string

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

integer

pidsLimit specifies the maximum number of processes allowed in a container

2.1.3. .spec.machineConfigPoolSelector

Description
MachineConfigPoolSelector selects which pools the ContainerRuntimeConfig shoud apply to. A nil selector will result in no pools being selected.
Type
object
PropertyTypeDescription

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.

2.1.4. .spec.machineConfigPoolSelector.matchExpressions

Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array

2.1.5. .spec.machineConfigPoolSelector.matchExpressions[]

Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
  • key
  • operator
PropertyTypeDescription

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

2.1.6. .status

Description
ContainerRuntimeConfigStatus defines the observed state of a ContainerRuntimeConfig
Type
object
PropertyTypeDescription

conditions

array

conditions represents the latest available observations of current state.

conditions[]

object

ContainerRuntimeConfigCondition defines the state of the ContainerRuntimeConfig

observedGeneration

integer

observedGeneration represents the generation observed by the controller.

2.1.7. .status.conditions

Description
conditions represents the latest available observations of current state.
Type
array

2.1.8. .status.conditions[]

Description
ContainerRuntimeConfigCondition defines the state of the ContainerRuntimeConfig
Type
object
PropertyTypeDescription

lastTransitionTime

``

lastTransitionTime is the time of the last update to the current status object.

message

string

message provides additional information about the current condition. This is only to be consumed by humans.

reason

string

reason is the reason for the condition’s last transition. Reasons are PascalCase

status

string

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

type

string

type specifies the state of the operator’s reconciliation functionality.

2.2. API endpoints

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

2.2.1. /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs

HTTP method
DELETE
Description
delete collection of ContainerRuntimeConfig
Table 2.1. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind ContainerRuntimeConfig
Table 2.2. HTTP responses
HTTP codeReponse body

200 - OK

ContainerRuntimeConfigList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a ContainerRuntimeConfig
Table 2.3. Query parameters
ParameterTypeDescription

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 2.4. Body parameters
ParameterTypeDescription

body

ContainerRuntimeConfig schema

 
Table 2.5. HTTP responses
HTTP codeReponse body

200 - OK

ContainerRuntimeConfig schema

201 - Created

ContainerRuntimeConfig schema

202 - Accepted

ContainerRuntimeConfig schema

401 - Unauthorized

Empty

2.2.2. /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name}

Table 2.6. Global path parameters
ParameterTypeDescription

name

string

name of the ContainerRuntimeConfig

HTTP method
DELETE
Description
delete a ContainerRuntimeConfig
Table 2.7. Query parameters
ParameterTypeDescription

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 2.8. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified ContainerRuntimeConfig
Table 2.9. HTTP responses
HTTP codeReponse body

200 - OK

ContainerRuntimeConfig schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified ContainerRuntimeConfig
Table 2.10. Query parameters
ParameterTypeDescription

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 2.11. HTTP responses
HTTP codeReponse body

200 - OK

ContainerRuntimeConfig schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified ContainerRuntimeConfig
Table 2.12. Query parameters
ParameterTypeDescription

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 2.13. Body parameters
ParameterTypeDescription

body

ContainerRuntimeConfig schema

 
Table 2.14. HTTP responses
HTTP codeReponse body

200 - OK

ContainerRuntimeConfig schema

201 - Created

ContainerRuntimeConfig schema

401 - Unauthorized

Empty

2.2.3. /apis/machineconfiguration.openshift.io/v1/containerruntimeconfigs/{name}/status

Table 2.15. Global path parameters
ParameterTypeDescription

name

string

name of the ContainerRuntimeConfig

HTTP method
GET
Description
read status of the specified ContainerRuntimeConfig
Table 2.16. HTTP responses
HTTP codeReponse body

200 - OK

ContainerRuntimeConfig schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified ContainerRuntimeConfig
Table 2.17. Query parameters
ParameterTypeDescription

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 2.18. HTTP responses
HTTP codeReponse body

200 - OK

ContainerRuntimeConfig schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified ContainerRuntimeConfig
Table 2.19. Query parameters
ParameterTypeDescription

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 2.20. Body parameters
ParameterTypeDescription

body

ContainerRuntimeConfig schema

 
Table 2.21. HTTP responses
HTTP codeReponse body

200 - OK

ContainerRuntimeConfig schema

201 - Created

ContainerRuntimeConfig schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.