// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="featuregate-config-openshift-io-v1"]
= FeatureGate [config.openshift.io/v1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
Feature holds cluster-wide information about feature gates.  The canonical name is `cluster`

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

[cols="1,1,1",options="header"]
|===
| 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`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `spec`
| `object`
| spec holds user settable values for configuration

| `status`
| `object`
| status holds observed values from the cluster. They may not be overridden.

|===
=== .spec
Description::
+
--
spec holds user settable values for configuration
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `customNoUpgrade`
| ``
| customNoUpgrade allows the enabling or disabling of any feature. Turning this feature set on IS NOT SUPPORTED, CANNOT BE UNDONE, and PREVENTS UPGRADES.
Because of its nature, this setting cannot be validated.  If you have any typos or accidentally apply invalid combinations
your cluster may fail in an unrecoverable way.  featureSet must equal "CustomNoUpgrade" must be set to use this field.

| `featureSet`
| `string`
| featureSet changes the list of features in the cluster.  The default is empty.  Be very careful adjusting this setting.
Turning on or off features may cause irreversible changes in your cluster which cannot be undone.

|===
=== .status
Description::
+
--
status holds observed values from the cluster. They may not be overridden.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `conditions`
| `array`
| conditions represent the observations of the current state.
Known .status.conditions.type are: "DeterminationDegraded"

| `conditions[]`
| `object`
| Condition contains details for one aspect of the current state of this API Resource.

| `featureGates`
| `array`
| featureGates contains a list of enabled and disabled featureGates that are keyed by payloadVersion.
Operators other than the CVO and cluster-config-operator, must read the .status.featureGates, locate
the version they are managing, find the enabled/disabled featuregates and make the operand and operator match.
The enabled/disabled values for a particular version may change during the life of the cluster as various
.spec.featureSet values are selected.
Operators may choose to restart their processes to pick up these changes, but remembering past enable/disable
lists is beyond the scope of this API and is the responsibility of individual operators.
Only featureGates with .version in the ClusterVersion.status will be present in this list.

| `featureGates[]`
| `object`
| 

|===
=== .status.conditions
Description::
+
--
conditions represent the observations of the current state.
Known .status.conditions.type are: "DeterminationDegraded"
--

Type::
  `array`




=== .status.conditions[]
Description::
+
--
Condition contains details for one aspect of the current state of this API Resource.
--

Type::
  `object`

Required::
  - `lastTransitionTime`
  - `message`
  - `reason`
  - `status`
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `lastTransitionTime`
| `string`
| lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.

| `message`
| `string`
| message is a human readable message indicating details about the transition.
This may be an empty string.

| `observedGeneration`
| `integer`
| observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.

| `reason`
| `string`
| reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.

| `status`
| `string`
| status of the condition, one of True, False, Unknown.

| `type`
| `string`
| type of condition in CamelCase or in foo.example.com/CamelCase.

|===
=== .status.featureGates
Description::
+
--
featureGates contains a list of enabled and disabled featureGates that are keyed by payloadVersion.
Operators other than the CVO and cluster-config-operator, must read the .status.featureGates, locate
the version they are managing, find the enabled/disabled featuregates and make the operand and operator match.
The enabled/disabled values for a particular version may change during the life of the cluster as various
.spec.featureSet values are selected.
Operators may choose to restart their processes to pick up these changes, but remembering past enable/disable
lists is beyond the scope of this API and is the responsibility of individual operators.
Only featureGates with .version in the ClusterVersion.status will be present in this list.
--

Type::
  `array`




=== .status.featureGates[]
Description::
+
--

--

Type::
  `object`

Required::
  - `version`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `disabled`
| `array`
| disabled is a list of all feature gates that are disabled in the cluster for the named version.

| `disabled[]`
| `object`
| 

| `enabled`
| `array`
| enabled is a list of all feature gates that are enabled in the cluster for the named version.

| `enabled[]`
| `object`
| 

| `version`
| `string`
| version matches the version provided by the ClusterVersion and in the ClusterOperator.Status.Versions field.

|===
=== .status.featureGates[].disabled
Description::
+
--
disabled is a list of all feature gates that are disabled in the cluster for the named version.
--

Type::
  `array`




=== .status.featureGates[].disabled[]
Description::
+
--

--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| name is the name of the FeatureGate.

|===
=== .status.featureGates[].enabled
Description::
+
--
enabled is a list of all feature gates that are enabled in the cluster for the named version.
--

Type::
  `array`




=== .status.featureGates[].enabled[]
Description::
+
--

--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| name is the name of the FeatureGate.

|===

== API endpoints

The following API endpoints are available:

* `/apis/config.openshift.io/v1/featuregates`
- `DELETE`: delete collection of FeatureGate
- `GET`: list objects of kind FeatureGate
- `POST`: create a FeatureGate
* `/apis/config.openshift.io/v1/featuregates/{name}`
- `DELETE`: delete a FeatureGate
- `GET`: read the specified FeatureGate
- `PATCH`: partially update the specified FeatureGate
- `PUT`: replace the specified FeatureGate
* `/apis/config.openshift.io/v1/featuregates/{name}/status`
- `GET`: read status of the specified FeatureGate
- `PATCH`: partially update status of the specified FeatureGate
- `PUT`: replace status of the specified FeatureGate


=== /apis/config.openshift.io/v1/featuregates



HTTP method::
  `DELETE`

Description::
  delete collection of FeatureGate




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  list objects of kind FeatureGate




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-config-v1-FeatureGateList[`FeatureGateList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create a FeatureGate


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
| `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.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 201 - Created
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 202 - Accepted
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/config.openshift.io/v1/featuregates/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the FeatureGate
|===


HTTP method::
  `DELETE`

Description::
  delete a FeatureGate


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  read the specified FeatureGate




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified FeatureGate


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
| `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.
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified FeatureGate


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
| `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.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 201 - Created
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/config.openshift.io/v1/featuregates/{name}/status

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the FeatureGate
|===


HTTP method::
  `GET`

Description::
  read status of the specified FeatureGate




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update status of the specified FeatureGate


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
| `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.
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified FeatureGate


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
| `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.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 201 - Created
| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema
| 401 - Unauthorized
| Empty
|===


