ControllerConfig [machineconfiguration.openshift.io/v1]
Description
ControllerConfig describes configuration for MachineConfigController. This is currently only used to drive the MachineConfig objects generated by the TemplateController. 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
Specification
Property | Type | Description |
---|---|---|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| ControllerConfigSpec is the spec for ControllerConfig resource. |
|
| ControllerConfigStatus is the status for ControllerConfig |
.spec
Description
ControllerConfigSpec is the spec for ControllerConfig resource.
Type
object
Required
baseOSContainerImage
cloudProviderConfig
clusterDNSIP
images
ipFamilies
kubeAPIServerServingCAData
releaseImage
rootCAData
Property | Type | Description |
---|---|---|
|
| cloudProvider specifies the cloud provider CA data |
|
| cloudProviderConfig is the configuration for the given cloud provider |
|
| clusterDNSIP is the cluster DNS IP address |
|
| dns holds the cluster dns details |
|
| etcdDiscoveryDomain is deprecated, use Infra.Status.EtcdDiscoveryDomain instead |
|
| imageRegistryBundleData is the ImageRegistryData |
|
| ImageRegistryBundle contains information for writing image registry certificates |
|
| imageRegistryBundleUserData is Image Registry Data provided by the user |
|
| ImageRegistryBundle contains information for writing image registry certificates |
|
| images is map of images that are used by the controller to render templates under ./templates/ |
|
| infra holds the infrastructure details |
|
| Network contains additional network related information |
|
| 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. |
|
| OSImageURL is the old-format container image that contains the OS update payload. |
|
| platform is deprecated, use Infra.Status.PlatformStatus.Type instead |
| `` | proxy holds the current proxy configuration for the nodes |
|
| pullSecret is the default pull secret that needs to be installed on all machines. |
|
| releaseImage is the image used when installing the cluster |
|
| rootCAData specifies the root CA data |
.spec.dns
Description
dns holds the cluster dns details
Type
object
Required
spec
kind
apiVersion
Property | Type | Description |
---|---|---|
|
| apiVersion defines the versioned schema of this representation of an object. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind is a string value representing the type of this object. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
.spec.imageRegistryBundleData
Description
imageRegistryBundleData is the ImageRegistryData
Type
array
.spec.imageRegistryBundleData[]
Description
ImageRegistryBundle contains information for writing image registry certificates
Type
object
Required
data
file
Property | Type | Description |
---|---|---|
|
| data holds the contents of the bundle that will be written to the file location |
|
| file holds the name of the file where the bundle will be written to disk |
.spec.imageRegistryBundleUserData
Description
imageRegistryBundleUserData is Image Registry Data provided by the user
Type
array
.spec.imageRegistryBundleUserData[]
Description
ImageRegistryBundle contains information for writing image registry certificates
Type
object
Required
data
file
Property | Type | Description |
---|---|---|
|
| data holds the contents of the bundle that will be written to the file location |
|
| file holds the name of the file where the bundle will be written to disk |
.spec.infra
Description
infra holds the infrastructure details
Type
object
Required
spec
kind
apiVersion
Property | Type | Description |
---|---|---|
|
| apiVersion defines the versioned schema of this representation of an object. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind is a string value representing the type of this object. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
.spec.pullSecret
Description
pullSecret is the default pull secret that needs to be installed on all machines.
Type
object
Property | Type | Description |
---|---|---|
|
| API version of the referent. |
|
| 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 of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| 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 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 |
---|---|---|
|
| conditions represents the latest available observations of current state. |
|
| ControllerConfigStatusCondition contains condition information for ControllerConfigStatus |
|
| controllerCertificates represents the latest available observations of the automatically rotating certificates in the MCO. |
|
| ControllerCertificate contains info about a specific cert. |
|
| 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
Required
status
type
Property | Type | Description |
---|---|---|
| `` | lastTransitionTime is the time of the last update to the current status object. |
|
| message provides additional information about the current condition. This is only to be consumed by humans. |
|
| reason is the reason for the condition’s last transition. Reasons are PascalCase |
|
| status of the condition, one of True, False, Unknown. |
|
| type specifies the state of the operator’s reconciliation functionality. |
.status.controllerCertificates
Description
controllerCertificates represents the latest available observations of the automatically rotating certificates in the MCO.
Type
array
.status.controllerCertificates[]
Description
ControllerCertificate contains info about a specific cert.
Type
object
Required
bundleFile
signer
subject
Property | Type | Description |
---|---|---|
|
| bundleFile is the larger bundle a cert comes from |
|
| notAfter is the upper boundary for validity |
|
| notBefore is the lower boundary for validity |
|
| signer is the cert Issuer |
|
| subject is the cert subject |
API endpoints
The following API endpoints are available:
/apis/machineconfiguration.openshift.io/v1/controllerconfigs
DELETE
: delete collection of ControllerConfigGET
: list objects of kind ControllerConfigPOST
: create a ControllerConfig
/apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}
DELETE
: delete a ControllerConfigGET
: read the specified ControllerConfigPATCH
: partially update the specified ControllerConfigPUT
: replace the specified ControllerConfig
/apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status
GET
: read status of the specified ControllerConfigPATCH
: partially update status of the specified ControllerConfigPUT
: replace status of the specified ControllerConfig
/apis/machineconfiguration.openshift.io/v1/controllerconfigs
HTTP method
DELETE
Description
delete collection of ControllerConfig
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list objects of kind ControllerConfig
HTTP code | Reponse body |
---|---|
200 - OK | ControllerConfigList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a ControllerConfig
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| ControllerConfig schema |
HTTP code | Reponse body |
---|---|
200 - OK | ControllerConfig schema |
201 - Created | ControllerConfig schema |
202 - Accepted | ControllerConfig schema |
401 - Unauthorized | Empty |
/apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the ControllerConfig |
HTTP method
DELETE
Description
delete a ControllerConfig
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified ControllerConfig
HTTP code | Reponse body |
---|---|
200 - OK | ControllerConfig schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified ControllerConfig
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
HTTP code | Reponse body |
---|---|
200 - OK | ControllerConfig schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified ControllerConfig
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| ControllerConfig schema |
HTTP code | Reponse body |
---|---|
200 - OK | ControllerConfig schema |
201 - Created | ControllerConfig schema |
401 - Unauthorized | Empty |
/apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the ControllerConfig |
HTTP method
GET
Description
read status of the specified ControllerConfig
HTTP code | Reponse body |
---|---|
200 - OK | ControllerConfig schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified ControllerConfig
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
HTTP code | Reponse body |
---|---|
200 - OK | ControllerConfig schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified ControllerConfig
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| ControllerConfig schema |
HTTP code | Reponse body |
---|---|
200 - OK | ControllerConfig schema |
201 - Created | ControllerConfig schema |
401 - Unauthorized | Empty |