KubeAPIServer [operator.openshift.io/v1]

    KubeAPIServer provides information to configure an operator to manage kube-apiserver.

    Type

    Required

    .spec

    Description

    spec is the specification of the desired behavior of the Kubernetes API Server

    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

    </p></td><td><p>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</p></td></tr><tr><td><p><code>operatorLogLevel</code></p></td><td><p><code>string</code></p></td><td><p>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".</p></td></tr><tr><td><p><code>succeededRevisionLimit</code></p></td><td><p><code>integer</code></p></td><td><p>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)</p></td></tr><tr><td><p><code>unsupportedConfigOverrides</code></p></td><td><p>

    unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides

    .status

    Description

    status is the most recently observed status of the Kubernetes API Server

    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

    .status.conditions

    Description

    conditions is a list of conditions and their status

    Type

    array

    .status.conditions[]

    Description

    OperatorCondition is just the standard condition fields.

    Type

    object

    PropertyTypeDescription

    lastTransitionTime

    string

    message

    string

    reason

    string

    status

    string

    type

    string

    .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

    .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 is the resource type of the thing you’re tracking

    .status.nodeStatuses

    Description

    nodeStatuses track the deployment values and errors across individual nodes

    Type

    array

    .status.nodeStatuses[]

    Description

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

    Type

    object

    PropertyTypeDescription

    currentRevision

    integer

    currentRevision is the generation of the most recently successful deployment

    lastFailedCount

    integer

    lastFailedCount is how often the last failed revision failed.

    lastFailedRevision

    integer

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

    lastFailedRevisionErrors

    array (string)

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

    lastFailedTime

    string

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

    nodeName

    string

    nodeName is the name of the node

    targetRevision

    integer

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

    API endpoints

    The following API endpoints are available:

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

      • DELETE: delete collection of KubeAPIServer

      • GET: list objects of kind KubeAPIServer

      • POST: create a KubeAPIServer

    • /apis/operator.openshift.io/v1/kubeapiservers/{name}

      • GET: read the specified KubeAPIServer

      • PATCH: partially update the specified KubeAPIServer

      • PUT: replace the specified KubeAPIServer

    • /apis/operator.openshift.io/v1/kubeapiservers/{name}/status

      • GET: read status of the specified KubeAPIServer

      • PUT: replace status of the specified KubeAPIServer

    Table 1. Global query parameters
    ParameterTypeDescription

    pretty

    string

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

    HTTP method

    DELETE

    Description

    delete collection of KubeAPIServer

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

    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

    HTTP method

    GET

    Description

    list objects of kind KubeAPIServer

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

    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.

    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

    KubeAPIServerList operator.openshift.io/v1

    HTTP method

    POST

    Description

    create a KubeAPIServer

    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 .

    Table 8. HTTP responses
    HTTP codeReponse body

    200 - OK

    KubeAPIServer operator.openshift.io/v1

    Table 9. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the KubeAPIServer

    Table 10. Global query parameters
    ParameterTypeDescription

    pretty

    string

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

    HTTP method

    DELETE

    Description

    delete a KubeAPIServer

    Table 11. Query parameters
    ParameterTypeDescription

    dryRun

    string

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

    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

    Table 13. HTTP responses
    HTTP codeReponse body

    200 - OK

    Status_v2 meta/v1

    HTTP method

    GET

    Description

    read the specified KubeAPIServer

    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

    KubeAPIServer operator.openshift.io/v1

    HTTP method

    PATCH

    Description

    partially update the specified KubeAPIServer

    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 .

    Table 17. Body parameters
    ParameterTypeDescription

    body

    Patch meta/v1

    Table 18. HTTP responses
    HTTP codeReponse body

    200 - OK

    HTTP method

    PUT

    Description

    replace the specified KubeAPIServer

    Table 20. Body parameters
    ParameterTypeDescription

    body

    KubeAPIServer operator.openshift.io/v1

    Table 21. HTTP responses
    HTTP codeReponse body

    200 - OK

    Table 22. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the KubeAPIServer

    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 KubeAPIServer

    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

    HTTP method

    PATCH

    Description

    partially update status of the specified KubeAPIServer

    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.

    Table 27. Body parameters
    ParameterTypeDescription

    body

    Table 28. HTTP responses
    HTTP codeReponse body

    200 - OK

    KubeAPIServer operator.openshift.io/v1

    HTTP method

    PUT

    Description

    replace status of the specified KubeAPIServer

    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 .

    Table 30. Body parameters
    ParameterTypeDescription

    body

    KubeAPIServer operator.openshift.io/v1