Search

Chapter 18. KubeControllerManager [operator.openshift.io/v1]

download PDF
Description
KubeControllerManager provides information to configure an operator to manage kube-controller-manager. 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

18.1. Specification

PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

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

spec

object

spec is the specification of the desired behavior of the Kubernetes Controller Manager

status

object

status is the most recently observed status of the Kubernetes Controller Manager

18.1.1. .spec

Description
spec is the specification of the desired behavior of the Kubernetes Controller Manager
Type
object
PropertyTypeDescription

failedRevisionLimit

integer

failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)

forceRedeploymentReason

string

forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.

logLevel

string

logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".

managementState

string

managementState indicates whether and how the operator should manage the component

observedConfig

``

observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator

operatorLogLevel

string

operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".

succeededRevisionLimit

integer

succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)

unsupportedConfigOverrides

``

unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.

useMoreSecureServiceCA

boolean

useMoreSecureServiceCA indicates that the service-ca.crt provided in SA token volumes should include only enough certificates to validate service serving certificates. Once set to true, it cannot be set to false. Even if someone finds a way to set it back to false, the service-ca.crt files that previously existed will only have the more secure content.

18.1.2. .status

Description
status is the most recently observed status of the Kubernetes Controller Manager
Type
object
PropertyTypeDescription

conditions

array

conditions is a list of conditions and their status

conditions[]

object

OperatorCondition is just the standard condition fields.

generations

array

generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.

generations[]

object

GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.

latestAvailableRevision

integer

latestAvailableRevision is the deploymentID of the most recent deployment

latestAvailableRevisionReason

string

latestAvailableRevisionReason describe the detailed reason for the most recent deployment

nodeStatuses

array

nodeStatuses track the deployment values and errors across individual nodes

nodeStatuses[]

object

NodeStatus provides information about the current state of a particular node managed by this operator.

observedGeneration

integer

observedGeneration is the last generation change you’ve dealt with

readyReplicas

integer

readyReplicas indicates how many replicas are ready and at the desired state

version

string

version is the level this availability applies to

18.1.3. .status.conditions

Description
conditions is a list of conditions and their status
Type
array

18.1.4. .status.conditions[]

Description
OperatorCondition is just the standard condition fields.
Type
object
Required
  • type
PropertyTypeDescription

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

18.1.5. .status.generations

Description
generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
Type
array

18.1.6. .status.generations[]

Description
GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
Type
object
PropertyTypeDescription

group

string

group is the group of the thing you’re tracking

hash

string

hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps

lastGeneration

integer

lastGeneration is the last generation of the workload controller involved

name

string

name is the name of the thing you’re tracking

namespace

string

namespace is where the thing you’re tracking is

resource

string

resource is the resource type of the thing you’re tracking

18.1.7. .status.nodeStatuses

Description
nodeStatuses track the deployment values and errors across individual nodes
Type
array

18.1.8. .status.nodeStatuses[]

Description
NodeStatus provides information about the current state of a particular node managed by this operator.
Type
object
Required
  • nodeName
PropertyTypeDescription

currentRevision

integer

currentRevision is the generation of the most recently successful deployment

lastFailedCount

integer

lastFailedCount is how often the installer pod of the last failed revision failed.

lastFailedReason

string

lastFailedReason is a machine readable failure reason string.

lastFailedRevision

integer

lastFailedRevision is the generation of the deployment we tried and failed to deploy.

lastFailedRevisionErrors

array (string)

lastFailedRevisionErrors is a list of human readable errors during the failed deployment referenced in lastFailedRevision.

lastFailedTime

string

lastFailedTime is the time the last failed revision failed the last time.

lastFallbackCount

integer

lastFallbackCount is how often a fallback to a previous revision happened.

nodeName

string

nodeName is the name of the node

targetRevision

integer

targetRevision is the generation of the deployment we’re trying to apply

18.2. API endpoints

The following API endpoints are available:

  • /apis/operator.openshift.io/v1/kubecontrollermanagers

    • DELETE: delete collection of KubeControllerManager
    • GET: list objects of kind KubeControllerManager
    • POST: create a KubeControllerManager
  • /apis/operator.openshift.io/v1/kubecontrollermanagers/{name}

    • DELETE: delete a KubeControllerManager
    • GET: read the specified KubeControllerManager
    • PATCH: partially update the specified KubeControllerManager
    • PUT: replace the specified KubeControllerManager
  • /apis/operator.openshift.io/v1/kubecontrollermanagers/{name}/status

    • GET: read status of the specified KubeControllerManager
    • PATCH: partially update status of the specified KubeControllerManager
    • PUT: replace status of the specified KubeControllerManager

18.2.1. /apis/operator.openshift.io/v1/kubecontrollermanagers

HTTP method
DELETE
Description
delete collection of KubeControllerManager
Table 18.1. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind KubeControllerManager
Table 18.2. HTTP responses
HTTP codeReponse body

200 - OK

KubeControllerManagerList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a KubeControllerManager
Table 18.3. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.4. Body parameters
ParameterTypeDescription

body

KubeControllerManager schema

 
Table 18.5. HTTP responses
HTTP codeReponse body

200 - OK

KubeControllerManager schema

201 - Created

KubeControllerManager schema

202 - Accepted

KubeControllerManager schema

401 - Unauthorized

Empty

18.2.2. /apis/operator.openshift.io/v1/kubecontrollermanagers/{name}

Table 18.6. Global path parameters
ParameterTypeDescription

name

string

name of the KubeControllerManager

HTTP method
DELETE
Description
delete a KubeControllerManager
Table 18.7. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 18.8. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified KubeControllerManager
Table 18.9. HTTP responses
HTTP codeReponse body

200 - OK

KubeControllerManager schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified KubeControllerManager
Table 18.10. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.11. HTTP responses
HTTP codeReponse body

200 - OK

KubeControllerManager schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified KubeControllerManager
Table 18.12. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.13. Body parameters
ParameterTypeDescription

body

KubeControllerManager schema

 
Table 18.14. HTTP responses
HTTP codeReponse body

200 - OK

KubeControllerManager schema

201 - Created

KubeControllerManager schema

401 - Unauthorized

Empty

18.2.3. /apis/operator.openshift.io/v1/kubecontrollermanagers/{name}/status

Table 18.15. Global path parameters
ParameterTypeDescription

name

string

name of the KubeControllerManager

HTTP method
GET
Description
read status of the specified KubeControllerManager
Table 18.16. HTTP responses
HTTP codeReponse body

200 - OK

KubeControllerManager schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified KubeControllerManager
Table 18.17. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.18. HTTP responses
HTTP codeReponse body

200 - OK

KubeControllerManager schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified KubeControllerManager
Table 18.19. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.20. Body parameters
ParameterTypeDescription

body

KubeControllerManager schema

 
Table 18.21. HTTP responses
HTTP codeReponse body

200 - OK

KubeControllerManager schema

201 - Created

KubeControllerManager schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

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

Making open source more inclusive

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

About Red Hat

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

© 2024 Red Hat, Inc.