ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]

    ContainerRuntimeConfig describes a customized Container Runtime configuration.

    Type

    Required

    • spec

    Description

    ContainerRuntimeConfigSpec defines the desired state of ContainerRuntimeConfig

    Type

    object

    Required

    • containerRuntimeConfig
    PropertyTypeDescription

    containerRuntimeConfig

    object

    ContainerRuntimeConfiguration defines the tuneables of the container runtime. It’s important to note that, since the fields of the ContainerRuntimeConfiguration are directly read by the upstream kubernetes golang client, the validation of those values is handled directly by that golang client which is outside of the controller for ContainerRuntimeConfiguration. Please ensure the valid values are used for those fields as invalid values may render cluster nodes unusable.

    machineConfigPoolSelector

    object

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    .spec.containerRuntimeConfig

    Description

    ContainerRuntimeConfiguration defines the tuneables of the container runtime. It’s important to note that, since the fields of the ContainerRuntimeConfiguration are directly read by the upstream kubernetes golang client, the validation of those values is handled directly by that golang client which is outside of the controller for ContainerRuntimeConfiguration. Please ensure the valid values are used for those fields as invalid values may render cluster nodes unusable.

    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

    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

    string

    overlaySize specifies the maximum size of a container image. This flag can be used to set quota on the size of container images.

    pidsLimit

    integer

    pidsLimit specifies the maximum number of processes allowed in a container

    .spec.machineConfigPoolSelector

    Description

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    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.

    Description

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

    Type

    array

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

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

    Description

    conditions represents the latest available observations of current state.

    Type

    array

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

    API endpoints

    The following API endpoints are available:

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

      • DELETE: delete collection of ContainerRuntimeConfig

      • POST: create a ContainerRuntimeConfig

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

      • 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

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

    Table 1. Global query parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete collection of ContainerRuntimeConfig

    Table 2. Query parameters
    ParameterTypeDescription

    allowWatchBookmarks

    boolean

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    watch

    boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    Table 3. HTTP responses
    HTTP codeReponse body

    200 - OK

    schema

    401 - Unauthorized

    Empty

    HTTP method

    GET

    Description

    list objects of kind ContainerRuntimeConfig

    Table 4. Query parameters
    ParameterTypeDescription

    allowWatchBookmarks

    boolean

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    watch

    boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    Table 5. HTTP responses
    HTTP codeReponse body

    200 - OK

    ContainerRuntimeConfigList schema

    401 - Unauthorized

    Empty

    HTTP method

    POST

    Description

    create a ContainerRuntimeConfig

    Table 7. Body parameters
    ParameterTypeDescription

    body

    schema

    Table 8. HTTP responses
    HTTP codeReponse body

    200 - OK

    ContainerRuntimeConfig schema

    201 - Created

    schema

    202 - Accepted

    ContainerRuntimeConfig schema

    401 - Unauthorized

    Empty

    Table 9. Global path parameters
    ParameterTypeDescription

    name

    name of the ContainerRuntimeConfig

    Table 10. Global query parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete a ContainerRuntimeConfig

    Table 11. 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

    integer

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    orphanDependents

    boolean

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    propagationPolicy

    string

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

    Table 12. Body parameters
    ParameterTypeDescription

    body

    DeleteOptions schema

    Table 13. HTTP responses
    HTTP codeReponse body

    200 - OK

    schema

    202 - Accepted

    Status schema

    401 - Unauthorized

    Empty

    HTTP method

    GET

    Description

    read the specified ContainerRuntimeConfig

    Table 14. Query parameters
    ParameterTypeDescription

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See for details.

    Defaults to unset

    Table 15. HTTP responses
    HTTP codeReponse body

    200 - OK

    ContainerRuntimeConfig schema

    401 - Unauthorized

    Empty

    HTTP method

    PATCH

    Description

    partially update the specified ContainerRuntimeConfig

    Table 16. 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

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    fieldValidation

    string

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the ServerSideFieldValidation feature gate is also enabled. 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 and is the default behavior when the ServerSideFieldValidation feature gate is disabled. - 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 when the ServerSideFieldValidation feature gate is enabled. - 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 17. Body parameters
    ParameterTypeDescription

    body

    Patch schema

    HTTP method

    PUT

    Description

    replace the specified ContainerRuntimeConfig

    Table 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

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    fieldValidation

    string

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the ServerSideFieldValidation feature gate is also enabled. 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 and is the default behavior when the ServerSideFieldValidation feature gate is disabled. - 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 when the ServerSideFieldValidation feature gate is enabled. - 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
    ParameterTypeDescription

    body

    ContainerRuntimeConfig schema

    Table 21. HTTP responses
    HTTP codeReponse body

    200 - OK

    schema

    201 - Created

    ContainerRuntimeConfig schema

    401 - Unauthorized

    Empty

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

    Table 22. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the ContainerRuntimeConfig

    Table 23. Global query parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    GET

    Description

    read status of the specified ContainerRuntimeConfig

    Table 24. Query parameters
    ParameterTypeDescription

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    Table 25. HTTP responses
    HTTP codeReponse body

    200 - OK

    schema

    401 - Unauthorized

    Empty

    HTTP method

    PATCH

    Description

    partially update status of the specified ContainerRuntimeConfig

    Table 26. 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

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    fieldValidation

    string

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the ServerSideFieldValidation feature gate is also enabled. 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 and is the default behavior when the ServerSideFieldValidation feature gate is disabled. - 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 when the ServerSideFieldValidation feature gate is enabled. - 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 27. Body parameters
    ParameterTypeDescription

    body

    schema

    Table 28. HTTP responses
    HTTP codeReponse body

    200 - OK

    ContainerRuntimeConfig schema

    401 - Unauthorized

    Empty

    HTTP method

    PUT

    Description

    replace status of the specified ContainerRuntimeConfig

    Table 29. 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

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    fieldValidation

    string

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the ServerSideFieldValidation feature gate is also enabled. 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 and is the default behavior when the ServerSideFieldValidation feature gate is disabled. - 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 when the feature gate is enabled. - 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 31. HTTP responses
    HTTP codeReponse body

    200 - OK

    ContainerRuntimeConfig schema

    201 - Created

    schema

    Empty