ControllerConfig [machineconfiguration.openshift.io/v1] - Machine <strong>api</strong>s | <strong>api</strong> reference

Specification
api endpoints

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

Specification

Property Type Description

Property	Type	Description
`.apiVersion`	`string`	apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`.kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`.spec`	`object`	ControllerConfigSpec is the spec for ControllerConfig resource.
`.status`	`object`	ControllerConfigStatus is the status for ControllerConfig

.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 meta/v1

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

.spec

object

ControllerConfigSpec is the spec for ControllerConfig resource.

.status

object

ControllerConfigStatus is the status for ControllerConfig

.spec

Description: ControllerConfigSpec is the spec for ControllerConfig resource.
Type: object

Property Type Description

Property	Type	Description
`additionalTrustBundle`	``	additionalTrustBundle is a certificate bundle that will be added to the nodes trusted certificate store.
`cloudProviderCAData`	``	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
`etcdCAData`	`string`	etcdCAData specifies the etcd CA data
`etcdDiscoveryDomain`	`string`	etcdDiscoveryDomain specifies the etcd discovery domain
`etcdMetricCAData`	`string`	etcdMetricData specifies the etcd metric CA data
`images`	`object (string)`	images is map of images that are used by the controller to render templates under ./templates/
`infra`	``	infra holds the infrastructure details TODO this makes platform redundant as everything is contained inside Infra.Status
`kubeapiServerServingCAData`	`string`	kubeapiServerServingCAData managed Kubelet to api Server Cert… Rotated automatically
`kubeletIPv6`	`boolean`	kubeletIPv6 is true to force a single-stack IPv6 kubelet config
`osImageURL`	`string`	osImageURL is the location of the container image that contains the OS update payload. Its value is taken from the data.osImageURL field on the machine-config-osimageurl ConfigMap.
`platform`	`string`	The openshift platform, e.g. "libvirt", "openstack", "gcp", "baremetal", "aws", or "none"
`proxy`	``	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.
`rootCAData`	`string`	rootCAData specifies the root CA data

additionalTrustBundle

additionalTrustBundle is a certificate bundle that will be added to the nodes trusted certificate store.

cloudProviderCAData

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

etcdCAData

string

etcdCAData specifies the etcd CA data

etcdDiscoveryDomain

string

etcdDiscoveryDomain specifies the etcd discovery domain

etcdMetricCAData

string

etcdMetricData specifies the etcd metric CA data

images

object (string)

images is map of images that are used by the controller to render templates under ./templates/

infra

infra holds the infrastructure details TODO this makes platform redundant as everything is contained inside Infra.Status

kubeapiServerServingCAData

string

kubeapiServerServingCAData managed Kubelet to api Server Cert… Rotated automatically

kubeletIPv6

boolean

kubeletIPv6 is true to force a single-stack IPv6 kubelet config

osImageURL

string

osImageURL is the location of the container image that contains the OS update payload. Its value is taken from the data.osImageURL field on the machine-config-osimageurl ConfigMap.

platform

string

The openshift platform, e.g. "libvirt", "openstack", "gcp", "baremetal", "aws", or "none"

proxy

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.

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

Property Type Description

Property	Type	Description
`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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`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: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
`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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.status

Description: ControllerConfigStatus is the status for ControllerConfig
Type: object

Property Type Description

Property	Type	Description
`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.

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

.status.conditions[]

Description: ControllerConfigStatusCondition contains condition information for ControllerConfigStatus
Type: object

Property Type Description

Property	Type	Description
`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.

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/controllerconfigs
- DELETE: delete collection of ControllerConfig
- GET: list objects of kind ControllerConfig
- POST: create a ControllerConfig
/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
- PUT: replace status of the specified ControllerConfig

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

Table 1. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of ControllerConfig

Table 2. Query parameters
Parameter	Type	Description
`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. If the feature gate WatchBookmarks is not enabled in apiserver, 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`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`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 code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind ControllerConfig

Table 4. Query parameters
Parameter	Type	Description
`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. If the feature gate WatchBookmarks is not enabled in apiserver, 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`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`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 code	Reponse body
200 - OK	`ControllerConfigList machineconfiguration.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ControllerConfig

Table 6. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`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.

Table 7. Body parameters
Parameter	Type	Description
`body`	`ControllerConfig machineconfiguration.openshift.io/v1`

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`ControllerConfig machineconfiguration.openshift.io/v1`
201 - Created	`ControllerConfig machineconfiguration.openshift.io/v1`
202 - Accepted	`ControllerConfig machineconfiguration.openshift.io/v1`
401 - Unauthorized	Empty

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

Table 9. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ControllerConfig

Table 10. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a ControllerConfig

Table 11. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`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
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
202 - Accepted	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ControllerConfig

Table 14. Query parameters
Parameter	Type	Description
`resourceVersion`	`string`	When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`ControllerConfig machineconfiguration.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ControllerConfig

Table 16. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`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.

Table 17. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`ControllerConfig machineconfiguration.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ControllerConfig

Table 19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`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.

Table 20. Body parameters
Parameter	Type	Description
`body`	`ControllerConfig machineconfiguration.openshift.io/v1`

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`ControllerConfig machineconfiguration.openshift.io/v1`
201 - Created	`ControllerConfig machineconfiguration.openshift.io/v1`
401 - Unauthorized	Empty

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

Table 22. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ControllerConfig

Table 23. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read status of the specified ControllerConfig

Table 24. Query parameters
Parameter	Type	Description
`resourceVersion`	`string`	When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

Table 25. HTTP responses
HTTP code	Reponse body
200 - OK	`ControllerConfig machineconfiguration.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified ControllerConfig

Table 26. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`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.

Table 27. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 28. HTTP responses
HTTP code	Reponse body
200 - OK	`ControllerConfig machineconfiguration.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified ControllerConfig

Table 29. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`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.

Table 30. Body parameters
Parameter	Type	Description
`body`	`ControllerConfig machineconfiguration.openshift.io/v1`

Table 31. HTTP responses
HTTP code	Reponse body
200 - OK	`ControllerConfig machineconfiguration.openshift.io/v1`
201 - Created	`ControllerConfig machineconfiguration.openshift.io/v1`
401 - Unauthorized	Empty