ControllerConfig [machineconfiguration.openshift.io/v1]

    ControllerConfig describes configuration for MachineConfigController. This is currently only used to drive the MachineConfig objects generated by the TemplateController.

    Type

    Required

    • spec

    Description

    ControllerConfigSpec is the spec for ControllerConfig resource.

    Type

    object

    Required

    • baseOSExtensionsContainerImage

    • cloudProviderConfig

    • clusterDNSIP

    • images

    • ipFamilies

    • kubeAPIServerServingCAData

    • osImageURL

    • releaseImage

    • rootCAData

    PropertyTypeDescription

    additionalTrustBundle

    </p></td><td><p>additionalTrustBundle is a certificate bundle that will be added to the nodes trusted certificate store.</p></td></tr><tr><td><p><code>baseOSContainerImage</code></p></td><td><p><code>string</code></p></td><td><p>BaseOSContainerImage is the new-format container image for operating system updates.</p></td></tr><tr><td><p><code>baseOSExtensionsContainerImage</code></p></td><td><p><code>string</code></p></td><td><p>BaseOSExtensionsContainerImage is the matching extensions container for the new-format container</p></td></tr><tr><td><p><code>cloudProviderCAData</code></p></td><td><p>

    cloudProvider specifies the cloud provider CA data

    cloudProviderConfig

    string

    cloudProviderConfig is the configuration for the given cloud provider

    clusterDNSIP

    string

    clusterDNSIP is the cluster DNS IP address

    dns

    </p></td><td><p>dns holds the cluster dns details</p></td></tr><tr><td><p><code>etcdDiscoveryDomain</code></p></td><td><p><code>string</code></p></td><td><p>etcdDiscoveryDomain is deprecated, use Infra.Status.EtcdDiscoveryDomain instead</p></td></tr><tr><td><p><code>images</code></p></td><td><p><code>object (string)</code></p></td><td><p>images is map of images that are used by the controller to render templates under ./templates/</p></td></tr><tr><td><p><code>infra</code></p></td><td><p>

    infra holds the infrastructure details

    ipFamilies

    string

    ipFamilies indicates the IP families in use by the cluster network

    kubeAPIServerServingCAData

    string

    kubeAPIServerServingCAData managed Kubelet to API Server Cert…​ Rotated automatically

    network

    </p></td><td><p>Network contains additional network related information</p></td></tr><tr><td><p><code>networkType</code></p></td><td><p><code>string</code></p></td><td><p>networkType holds the type of network the cluster is using XXX: this is temporary and will be dropped as soon as possible in favor of a better support to start network related services the proper way. Nobody is also changing this once the cluster is up and running the first time, so, disallow regeneration if this changes.</p></td></tr><tr><td><p><code>osImageURL</code></p></td><td><p><code>string</code></p></td><td><p>OSImageURL is the old-format container image that contains the OS update payload.</p></td></tr><tr><td><p><code>platform</code></p></td><td><p><code>string</code></p></td><td><p>platform is deprecated, use Infra.Status.PlatformStatus.Type instead</p></td></tr><tr><td><p><code>proxy</code></p></td><td><p>

    proxy holds the current proxy configuration for the nodes

    pullSecret

    object

    pullSecret is the default pull secret that needs to be installed on all machines.

    releaseImage

    string

    releaseImage is the image used when installing the cluster

    rootCAData

    string

    rootCAData specifies the root CA data

    .spec.pullSecret

    Description

    pullSecret is the default pull secret that needs to be installed on all machines.

    Type

    object

    PropertyTypeDescription

    apiVersion

    string

    API version of the referent.

    fieldPath

    string

    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

    kind

    string

    Kind of the referent. More info:

    name

    string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    namespace

    string

    Namespace of the referent. More info:

    resourceVersion

    string

    Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

    uid

    string

    UID of the referent. More info:

    Description

    ControllerConfigStatus is the status for ControllerConfig

    Type

    object

    PropertyTypeDescription

    conditions

    array

    conditions represents the latest available observations of current state.

    conditions[]

    object

    ControllerConfigStatusCondition contains condition information for ControllerConfigStatus

    observedGeneration

    integer

    observedGeneration represents the generation observed by the controller.

    .status.conditions

    Description

    conditions represents the latest available observations of current state.

    Type

    array

    Description

    ControllerConfigStatusCondition contains condition information for ControllerConfigStatus

    Type

    object

    Required

    • status

    • type

    PropertyTypeDescription

    lastTransitionTime

    ``

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

    message

    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

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

      • DELETE: delete a ControllerConfig

      • GET: read the specified ControllerConfig

      • PATCH: partially update the specified ControllerConfig

      • PUT: replace the specified ControllerConfig

    • /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status

      • GET: read status of the specified ControllerConfig

      • PATCH: partially update status of the specified ControllerConfig

    /apis/machineconfiguration.openshift.io/v1/controllerconfigs

    Table 1. Global query parameters
    ParameterTypeDescription

    pretty

    string

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

    HTTP method

    DELETE

    Description

    delete collection of ControllerConfig

    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 ControllerConfig

    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

    ControllerConfigList schema

    401 - Unauthorized

    Empty

    HTTP method

    POST

    Description

    create a ControllerConfig

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

    body

    ControllerConfig schema

    Table 9. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the ControllerConfig

    Table 10. Global query parameters
    ParameterTypeDescription

    pretty

    string

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

    HTTP method

    DELETE

    Description

    delete a ControllerConfig

    Table 11. Query parameters
    ParameterTypeDescription

    dryRun

    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

    gracePeriodSeconds

    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 ControllerConfig

    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

    ControllerConfig schema

    401 - Unauthorized

    Empty

    HTTP method

    PATCH

    Description

    partially update the specified ControllerConfig

    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

    Table 18. HTTP responses
    HTTP codeReponse body

    200 - OK

    schema

    401 - Unauthorized

    Empty

    HTTP method

    PUT

    Description

    replace the specified ControllerConfig

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

    200 - OK

    schema

    201 - Created

    ControllerConfig schema

    401 - Unauthorized

    Empty

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

    Table 22. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the ControllerConfig

    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 ControllerConfig

    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 ControllerConfig

    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

    ControllerConfig schema

    401 - Unauthorized

    Empty

    HTTP method

    PUT

    Description

    replace status of the specified ControllerConfig

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

    ControllerConfig schema

    Table 31. HTTP responses
    HTTP codeReponse body

    200 - OK

    schema

    201 - Created

    ControllerConfig schema

    401 - Unauthorized

    Empty