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

toc::[]


Description::
+
--
Console provides a means to configure an operator to manage the console.

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`
| ConsoleSpec is the specification of the desired behavior of the Console.

| `status`
| `object`
| ConsoleStatus defines the observed status of the Console.

|===
=== .spec
Description::
+
--
ConsoleSpec is the specification of the desired behavior of the Console.
--

Type::
  `object`




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

| `customization`
| `object`
| customization is used to optionally provide a small set of
customization options to the web console.

| `ingress`
| `object`
| ingress allows to configure the alternative ingress for the console.
This field is intended for clusters without ingress capability,
where access to routes is not possible.

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

| `plugins`
| `array (string)`
| plugins defines a list of enabled console plugin names.

| `providers`
| `object`
| providers contains configuration for using specific service providers.

| `route`
| `object`
| route contains hostname and secret reference that contains the serving certificate.
If a custom route is specified, a new route will be created with the
provided hostname, under which console will be available.
In case of custom hostname uses the default routing suffix of the cluster,
the Secret specification for a serving certificate will not be needed.
In case of custom hostname points to an arbitrary domain, manual DNS configurations steps are necessary.
The default console route will be maintained to reserve the default hostname
for console if the custom route is removed.
If not specified, default route will be used.
DEPRECATED

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

|===
=== .spec.customization
Description::
+
--
customization is used to optionally provide a small set of
customization options to the web console.
--

Type::
  `object`




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

| `addPage`
| `object`
| addPage allows customizing actions on the Add page in developer perspective.

| `brand`
| `string`
| brand is the default branding of the web console which can be overridden by
providing the brand field.  There is a limited set of specific brand options.
This field controls elements of the console such as the logo.
Invalid value will prevent a console rollout.

| `capabilities`
| `array`
| capabilities defines an array of capabilities that can be interacted with in the console UI.
Each capability defines a visual state that can be interacted with the console to render in the UI.
Available capabilities are LightspeedButton, GettingStartedBanner, and GuidedTour.
Each of the available capabilities may appear only once in the list.

| `capabilities[]`
| `object`
| Capabilities contains set of UI capabilities and their state in the console UI.

| `customLogoFile`
| `object`
| customLogoFile replaces the default OpenShift logo in the masthead and about dialog. It is a reference to a
Only one of customLogoFile or logos can be set at a time.
ConfigMap in the openshift-config namespace. This can be created with a command like
'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config'.
Image size must be less than 1 MB due to constraints on the ConfigMap size.
The ConfigMap key should include a file extension so that the console serves the file
with the correct MIME type.
The recommended file format for the logo is SVG, but other file formats are allowed if supported by the browser.
Deprecated: Use logos instead.

| `customProductName`
| `string`
| customProductName is the name that will be displayed in page titles, logo alt text, and the about dialog
instead of the normal OpenShift product name.

| `developerCatalog`
| `object`
| developerCatalog allows to configure the shown developer catalog categories (filters) and types (sub-catalogs).

| `documentationBaseURL`
| `string`
| documentationBaseURL links to external documentation are shown in various sections
of the web console.  Providing documentationBaseURL will override the default
documentation URL.
Invalid value will prevent a console rollout.

| `logos`
| `array`
| logos is used to replace the OpenShift Masthead and Favicon logos in the console UI with custom logos.
logos is an optional field that allows a list of logos.
Only one of logos or customLogoFile can be set at a time.
If logos is set, customLogoFile must be unset.
When specified, there must be at least one entry and no more than 2 entries.
Each type must appear only once in the list.

| `logos[]`
| `object`
| Logo defines a configuration based on theme modes for the console UI logo.

| `perspectives`
| `array`
| perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown.

| `perspectives[]`
| `object`
| Perspective defines a perspective that cluster admins want to show/hide in the perspective switcher dropdown

| `projectAccess`
| `object`
| projectAccess allows customizing the available list of ClusterRoles in the Developer perspective
Project access page which can be used by a project admin to specify roles to other users and
restrict access within the project. If set, the list will replace the default ClusterRole options.

| `quickStarts`
| `object`
| quickStarts allows customization of available ConsoleQuickStart resources in console.

|===
=== .spec.customization.addPage
Description::
+
--
addPage allows customizing actions on the Add page in developer perspective.
--

Type::
  `object`




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

| `disabledActions`
| `array (string)`
| disabledActions is a list of actions that are not shown to users.
Each action in the list is represented by its ID.

|===
=== .spec.customization.capabilities
Description::
+
--
capabilities defines an array of capabilities that can be interacted with in the console UI.
Each capability defines a visual state that can be interacted with the console to render in the UI.
Available capabilities are LightspeedButton, GettingStartedBanner, and GuidedTour.
Each of the available capabilities may appear only once in the list.
--

Type::
  `array`




=== .spec.customization.capabilities[]
Description::
+
--
Capabilities contains set of UI capabilities and their state in the console UI.
--

Type::
  `object`

Required::
  - `name`
  - `visibility`



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

| `name`
| `string`
| name is the unique name of a capability.
Available capabilities are LightspeedButton, GettingStartedBanner, and GuidedTour.

| `visibility`
| `object`
| visibility defines the visibility state of the capability.

|===
=== .spec.customization.capabilities[].visibility
Description::
+
--
visibility defines the visibility state of the capability.
--

Type::
  `object`

Required::
  - `state`



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

| `state`
| `string`
| state defines if the capability is enabled or disabled in the console UI.
Enabling the capability in the console UI is represented by the "Enabled" value.
Disabling the capability in the console UI is represented by the "Disabled" value.

|===
=== .spec.customization.customLogoFile
Description::
+
--
customLogoFile replaces the default OpenShift logo in the masthead and about dialog. It is a reference to a
Only one of customLogoFile or logos can be set at a time.
ConfigMap in the openshift-config namespace. This can be created with a command like
'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config'.
Image size must be less than 1 MB due to constraints on the ConfigMap size.
The ConfigMap key should include a file extension so that the console serves the file
with the correct MIME type.
The recommended file format for the logo is SVG, but other file formats are allowed if supported by the browser.
Deprecated: Use logos instead.
--

Type::
  `object`




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

| `key`
| `string`
| key allows pointing to a specific key/value inside of the configmap.  This is useful for logical file references.

| `name`
| `string`
| 

|===
=== .spec.customization.developerCatalog
Description::
+
--
developerCatalog allows to configure the shown developer catalog categories (filters) and types (sub-catalogs).
--

Type::
  `object`




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

| `categories`
| `array`
| categories which are shown in the developer catalog.

| `categories[]`
| `object`
| DeveloperConsoleCatalogCategory for the developer console catalog.

| `types`
| `object`
| types allows enabling or disabling of sub-catalog types that user can see in the Developer catalog.
When omitted, all the sub-catalog types will be shown.

|===
=== .spec.customization.developerCatalog.categories
Description::
+
--
categories which are shown in the developer catalog.
--

Type::
  `array`




=== .spec.customization.developerCatalog.categories[]
Description::
+
--
DeveloperConsoleCatalogCategory for the developer console catalog.
--

Type::
  `object`

Required::
  - `id`
  - `label`



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

| `id`
| `string`
| id is an identifier used in the URL to enable deep linking in console.
ID is required and must have 1-32 URL safe (A-Z, a-z, 0-9, - and _) characters.

| `label`
| `string`
| label defines a category display label. It is required and must have 1-64 characters.

| `subcategories`
| `array`
| subcategories defines a list of child categories.

| `subcategories[]`
| `object`
| DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category.

| `tags`
| `array (string)`
| tags is a list of strings that will match the category. A selected category
show all items which has at least one overlapping tag between category and item.

|===
=== .spec.customization.developerCatalog.categories[].subcategories
Description::
+
--
subcategories defines a list of child categories.
--

Type::
  `array`




=== .spec.customization.developerCatalog.categories[].subcategories[]
Description::
+
--
DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category.
--

Type::
  `object`

Required::
  - `id`
  - `label`



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

| `id`
| `string`
| id is an identifier used in the URL to enable deep linking in console.
ID is required and must have 1-32 URL safe (A-Z, a-z, 0-9, - and _) characters.

| `label`
| `string`
| label defines a category display label. It is required and must have 1-64 characters.

| `tags`
| `array (string)`
| tags is a list of strings that will match the category. A selected category
show all items which has at least one overlapping tag between category and item.

|===
=== .spec.customization.developerCatalog.types
Description::
+
--
types allows enabling or disabling of sub-catalog types that user can see in the Developer catalog.
When omitted, all the sub-catalog types will be shown.
--

Type::
  `object`

Required::
  - `state`



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

| `disabled`
| `array (string)`
| disabled is a list of developer catalog types (sub-catalogs IDs) that are not shown to users.
Types (sub-catalogs) are added via console plugins, the available types (sub-catalog IDs) are available
in the console on the cluster configuration page, or when editing the YAML in the console.
Example: "Devfile", "HelmChart", "BuilderImage"
If the list is empty or all the available sub-catalog types are added, then the complete developer catalog should be hidden.

| `enabled`
| `array (string)`
| enabled is a list of developer catalog types (sub-catalogs IDs) that will be shown to users.
Types (sub-catalogs) are added via console plugins, the available types (sub-catalog IDs) are available
in the console on the cluster configuration page, or when editing the YAML in the console.
Example: "Devfile", "HelmChart", "BuilderImage"
If the list is non-empty, a new type will not be shown to the user until it is added to list.
If the list is empty the complete developer catalog will be shown.

| `state`
| `string`
| state defines if a list of catalog types should be enabled or disabled.

|===
=== .spec.customization.logos
Description::
+
--
logos is used to replace the OpenShift Masthead and Favicon logos in the console UI with custom logos.
logos is an optional field that allows a list of logos.
Only one of logos or customLogoFile can be set at a time.
If logos is set, customLogoFile must be unset.
When specified, there must be at least one entry and no more than 2 entries.
Each type must appear only once in the list.
--

Type::
  `array`




=== .spec.customization.logos[]
Description::
+
--
Logo defines a configuration based on theme modes for the console UI logo.
--

Type::
  `object`

Required::
  - `themes`
  - `type`



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

| `themes`
| `array`
| themes specifies the themes for the console UI logo.
themes is a required field that allows a list of themes. Each item in the themes list must have a unique mode and a source field.
Each mode determines whether the logo is for the dark or light mode of the console UI.
If a theme is not specified, the default OpenShift logo will be displayed for that theme.
There must be at least one entry and no more than 2 entries.

| `themes[]`
| `object`
| Theme defines a theme mode for the console UI.

| `type`
| `string`
| type specifies the type of the logo for the console UI. It determines whether the logo is for the masthead or favicon.
type is a required field that allows values of Masthead and Favicon.
When set to "Masthead", the logo will be used in the masthead and about modal of the console UI.
When set to "Favicon", the logo will be used as the favicon of the console UI.

|===
=== .spec.customization.logos[].themes
Description::
+
--
themes specifies the themes for the console UI logo.
themes is a required field that allows a list of themes. Each item in the themes list must have a unique mode and a source field.
Each mode determines whether the logo is for the dark or light mode of the console UI.
If a theme is not specified, the default OpenShift logo will be displayed for that theme.
There must be at least one entry and no more than 2 entries.
--

Type::
  `array`




=== .spec.customization.logos[].themes[]
Description::
+
--
Theme defines a theme mode for the console UI.
--

Type::
  `object`

Required::
  - `mode`
  - `source`



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

| `mode`
| `string`
| mode is used to specify what theme mode a logo will apply to in the console UI.
mode is a required field that allows values of Dark and Light.
When set to Dark, the logo file referenced in the 'file' field will be used when an end-user of the console UI enables the Dark mode.
When set to Light, the logo file referenced in the 'file' field will be used when an end-user of the console UI enables the Light mode.

| `source`
| `object`
| source is used by the console to locate the specified file containing a custom logo.
source is a required field that references a ConfigMap name and key that contains the custom logo file in the openshift-config namespace.
You can create it with a command like:
- 'oc create configmap custom-logos-config --namespace=openshift-config --from-file=/path/to/file'
The ConfigMap key must include the file extension so that the console serves the file with the correct MIME type.
The recommended file format for the Masthead and Favicon logos is SVG, but other file formats are allowed if supported by the browser.
The logo image size must be less than 1 MB due to constraints on the ConfigMap size.
For more information, see the documentation: https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/customizing-web-console#customizing-web-console

|===
=== .spec.customization.logos[].themes[].source
Description::
+
--
source is used by the console to locate the specified file containing a custom logo.
source is a required field that references a ConfigMap name and key that contains the custom logo file in the openshift-config namespace.
You can create it with a command like:
- 'oc create configmap custom-logos-config --namespace=openshift-config --from-file=/path/to/file'
The ConfigMap key must include the file extension so that the console serves the file with the correct MIME type.
The recommended file format for the Masthead and Favicon logos is SVG, but other file formats are allowed if supported by the browser.
The logo image size must be less than 1 MB due to constraints on the ConfigMap size.
For more information, see the documentation: https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/customizing-web-console#customizing-web-console
--

Type::
  `object`

Required::
  - `from`



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

| `configMap`
| `object`
| configMap specifies the ConfigMap sourcing details such as the name of the ConfigMap and the key for the file.
The ConfigMap must exist in the openshift-config namespace.
Required when from is "ConfigMap", and forbidden otherwise.

| `from`
| `string`
| from is a required field to specify the source type of the file reference.
Allowed values are ConfigMap.
When set to ConfigMap, the file will be sourced from a ConfigMap in the openshift-config namespace. The configMap field must be set when from is set to ConfigMap.

|===
=== .spec.customization.logos[].themes[].source.configMap
Description::
+
--
configMap specifies the ConfigMap sourcing details such as the name of the ConfigMap and the key for the file.
The ConfigMap must exist in the openshift-config namespace.
Required when from is "ConfigMap", and forbidden otherwise.
--

Type::
  `object`

Required::
  - `key`
  - `name`



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

| `key`
| `string`
| key is the logo key inside the referenced ConfigMap.
Must consist only of alphanumeric characters, dashes (-), underscores (_), and periods (.).
Must be at most 253 characters in length.
Must end in a valid file extension.
A valid file extension must consist of a period followed by 2 to 5 alpha characters.

| `name`
| `string`
| name is the name of the ConfigMap.
name is a required field.
Must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.
Must be at most 253 characters in length.

|===
=== .spec.customization.perspectives
Description::
+
--
perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown.
--

Type::
  `array`




=== .spec.customization.perspectives[]
Description::
+
--
Perspective defines a perspective that cluster admins want to show/hide in the perspective switcher dropdown
--

Type::
  `object`

Required::
  - `id`
  - `visibility`



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

| `id`
| `string`
| id defines the id of the perspective.
Example: "dev", "admin".
The available perspective ids can be found in the code snippet section next to the yaml editor.
Incorrect or unknown ids will be ignored.

| `pinnedResources`
| `array`
| pinnedResources defines the list of default pinned resources that users will see on the perspective navigation if they have not customized these pinned resources themselves.
The list of available Kubernetes resources could be read via `kubectl api-resources`.
The console will also provide a configuration UI and a YAML snippet that will list the available resources that can be pinned to the navigation.
Incorrect or unknown resources will be ignored.

| `pinnedResources[]`
| `object`
| PinnedResourceReference includes the group, version and type of resource

| `visibility`
| `object`
| visibility defines the state of perspective along with access review checks if needed for that perspective.

|===
=== .spec.customization.perspectives[].pinnedResources
Description::
+
--
pinnedResources defines the list of default pinned resources that users will see on the perspective navigation if they have not customized these pinned resources themselves.
The list of available Kubernetes resources could be read via `kubectl api-resources`.
The console will also provide a configuration UI and a YAML snippet that will list the available resources that can be pinned to the navigation.
Incorrect or unknown resources will be ignored.
--

Type::
  `array`




=== .spec.customization.perspectives[].pinnedResources[]
Description::
+
--
PinnedResourceReference includes the group, version and type of resource
--

Type::
  `object`

Required::
  - `group`
  - `resource`
  - `version`



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

| `group`
| `string`
| group is the API Group of the Resource.
Enter empty string for the core group.
This value should consist of only lowercase alphanumeric characters, hyphens and periods.
Example: "", "apps", "build.openshift.io", etc.

| `resource`
| `string`
| resource is the type that is being referenced.
It is normally the plural form of the resource kind in lowercase.
This value should consist of only lowercase alphanumeric characters and hyphens.
Example: "deployments", "deploymentconfigs", "pods", etc.

| `version`
| `string`
| version is the API Version of the Resource.
This value should consist of only lowercase alphanumeric characters.
Example: "v1", "v1beta1", etc.

|===
=== .spec.customization.perspectives[].visibility
Description::
+
--
visibility defines the state of perspective along with access review checks if needed for that perspective.
--

Type::
  `object`

Required::
  - `state`



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

| `accessReview`
| `object`
| accessReview defines required and missing access review checks.

| `state`
| `string`
| state defines the perspective is enabled or disabled or access review check is required.

|===
=== .spec.customization.perspectives[].visibility.accessReview
Description::
+
--
accessReview defines required and missing access review checks.
--

Type::
  `object`




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

| `missing`
| `array`
| missing defines a list of permission checks. The perspective will only be shown when at least one check fails. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the required access review list.

| `missing[]`
| `object`
| ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

| `required`
| `array`
| required defines a list of permission checks. The perspective will only be shown when all checks are successful. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the missing access review list.

| `required[]`
| `object`
| ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

|===
=== .spec.customization.perspectives[].visibility.accessReview.missing
Description::
+
--
missing defines a list of permission checks. The perspective will only be shown when at least one check fails. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the required access review list.
--

Type::
  `array`




=== .spec.customization.perspectives[].visibility.accessReview.missing[]
Description::
+
--
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
--

Type::
  `object`




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

| `fieldSelector`
| `object`
| fieldSelector describes the limitation on access based on field.  It can only limit access, not broaden it.

| `group`
| `string`
| Group is the API Group of the Resource.  "*" means all.

| `labelSelector`
| `object`
| labelSelector describes the limitation on access based on labels.  It can only limit access, not broaden it.

| `name`
| `string`
| Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.

| `namespace`
| `string`
| Namespace is the namespace of the action being requested.  Currently, there is no distinction between no namespace and all namespaces
"" (empty) is defaulted for LocalSubjectAccessReviews
"" (empty) is empty for cluster-scoped resources
"" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview

| `resource`
| `string`
| Resource is one of the existing resource types.  "*" means all.

| `subresource`
| `string`
| Subresource is one of the existing resource types.  "" means none.

| `verb`
| `string`
| Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy.  "*" means all.

| `version`
| `string`
| Version is the API Version of the Resource.  "*" means all.

|===
=== .spec.customization.perspectives[].visibility.accessReview.missing[].fieldSelector
Description::
+
--
fieldSelector describes the limitation on access based on field.  It can only limit access, not broaden it.
--

Type::
  `object`




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

| `rawSelector`
| `string`
| rawSelector is the serialization of a field selector that would be included in a query parameter.
Webhook implementations are encouraged to ignore rawSelector.
The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present.

| `requirements`
| `array`
| requirements is the parsed interpretation of a field selector.
All requirements must be met for a resource instance to match the selector.
Webhook implementations should handle requirements, but how to handle them is up to the webhook.
Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements
are not understood.

| `requirements[]`
| `object`
| FieldSelectorRequirement is a selector that contains values, a key, and an operator that
relates the key and values.

|===
=== .spec.customization.perspectives[].visibility.accessReview.missing[].fieldSelector.requirements
Description::
+
--
requirements is the parsed interpretation of a field selector.
All requirements must be met for a resource instance to match the selector.
Webhook implementations should handle requirements, but how to handle them is up to the webhook.
Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements
are not understood.
--

Type::
  `array`




=== .spec.customization.perspectives[].visibility.accessReview.missing[].fieldSelector.requirements[]
Description::
+
--
FieldSelectorRequirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



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

| `key`
| `string`
| key is the field selector key that the requirement applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist.
The list of operators may grow in the future.

| `values`
| `array (string)`
| values is an array of string values.
If the operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values array must be empty.

|===
=== .spec.customization.perspectives[].visibility.accessReview.missing[].labelSelector
Description::
+
--
labelSelector describes the limitation on access based on labels.  It can only limit access, not broaden it.
--

Type::
  `object`




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

| `rawSelector`
| `string`
| rawSelector is the serialization of a field selector that would be included in a query parameter.
Webhook implementations are encouraged to ignore rawSelector.
The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present.

| `requirements`
| `array`
| requirements is the parsed interpretation of a label selector.
All requirements must be met for a resource instance to match the selector.
Webhook implementations should handle requirements, but how to handle them is up to the webhook.
Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements
are not understood.

| `requirements[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

|===
=== .spec.customization.perspectives[].visibility.accessReview.missing[].labelSelector.requirements
Description::
+
--
requirements is the parsed interpretation of a label selector.
All requirements must be met for a resource instance to match the selector.
Webhook implementations should handle requirements, but how to handle them is up to the webhook.
Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements
are not understood.
--

Type::
  `array`




=== .spec.customization.perspectives[].visibility.accessReview.missing[].labelSelector.requirements[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



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

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.customization.perspectives[].visibility.accessReview.required
Description::
+
--
required defines a list of permission checks. The perspective will only be shown when all checks are successful. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the missing access review list.
--

Type::
  `array`




=== .spec.customization.perspectives[].visibility.accessReview.required[]
Description::
+
--
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
--

Type::
  `object`




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

| `fieldSelector`
| `object`
| fieldSelector describes the limitation on access based on field.  It can only limit access, not broaden it.

| `group`
| `string`
| Group is the API Group of the Resource.  "*" means all.

| `labelSelector`
| `object`
| labelSelector describes the limitation on access based on labels.  It can only limit access, not broaden it.

| `name`
| `string`
| Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.

| `namespace`
| `string`
| Namespace is the namespace of the action being requested.  Currently, there is no distinction between no namespace and all namespaces
"" (empty) is defaulted for LocalSubjectAccessReviews
"" (empty) is empty for cluster-scoped resources
"" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview

| `resource`
| `string`
| Resource is one of the existing resource types.  "*" means all.

| `subresource`
| `string`
| Subresource is one of the existing resource types.  "" means none.

| `verb`
| `string`
| Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy.  "*" means all.

| `version`
| `string`
| Version is the API Version of the Resource.  "*" means all.

|===
=== .spec.customization.perspectives[].visibility.accessReview.required[].fieldSelector
Description::
+
--
fieldSelector describes the limitation on access based on field.  It can only limit access, not broaden it.
--

Type::
  `object`




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

| `rawSelector`
| `string`
| rawSelector is the serialization of a field selector that would be included in a query parameter.
Webhook implementations are encouraged to ignore rawSelector.
The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present.

| `requirements`
| `array`
| requirements is the parsed interpretation of a field selector.
All requirements must be met for a resource instance to match the selector.
Webhook implementations should handle requirements, but how to handle them is up to the webhook.
Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements
are not understood.

| `requirements[]`
| `object`
| FieldSelectorRequirement is a selector that contains values, a key, and an operator that
relates the key and values.

|===
=== .spec.customization.perspectives[].visibility.accessReview.required[].fieldSelector.requirements
Description::
+
--
requirements is the parsed interpretation of a field selector.
All requirements must be met for a resource instance to match the selector.
Webhook implementations should handle requirements, but how to handle them is up to the webhook.
Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements
are not understood.
--

Type::
  `array`




=== .spec.customization.perspectives[].visibility.accessReview.required[].fieldSelector.requirements[]
Description::
+
--
FieldSelectorRequirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



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

| `key`
| `string`
| key is the field selector key that the requirement applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist.
The list of operators may grow in the future.

| `values`
| `array (string)`
| values is an array of string values.
If the operator is In or NotIn, the values array must be non-empty.
If the operator is Exists or DoesNotExist, the values array must be empty.

|===
=== .spec.customization.perspectives[].visibility.accessReview.required[].labelSelector
Description::
+
--
labelSelector describes the limitation on access based on labels.  It can only limit access, not broaden it.
--

Type::
  `object`




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

| `rawSelector`
| `string`
| rawSelector is the serialization of a field selector that would be included in a query parameter.
Webhook implementations are encouraged to ignore rawSelector.
The kube-apiserver's *SubjectAccessReview will parse the rawSelector as long as the requirements are not present.

| `requirements`
| `array`
| requirements is the parsed interpretation of a label selector.
All requirements must be met for a resource instance to match the selector.
Webhook implementations should handle requirements, but how to handle them is up to the webhook.
Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements
are not understood.

| `requirements[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

|===
=== .spec.customization.perspectives[].visibility.accessReview.required[].labelSelector.requirements
Description::
+
--
requirements is the parsed interpretation of a label selector.
All requirements must be met for a resource instance to match the selector.
Webhook implementations should handle requirements, but how to handle them is up to the webhook.
Since requirements can only limit the request, it is safe to authorize as unlimited request if the requirements
are not understood.
--

Type::
  `array`




=== .spec.customization.perspectives[].visibility.accessReview.required[].labelSelector.requirements[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



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

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.customization.projectAccess
Description::
+
--
projectAccess allows customizing the available list of ClusterRoles in the Developer perspective
Project access page which can be used by a project admin to specify roles to other users and
restrict access within the project. If set, the list will replace the default ClusterRole options.
--

Type::
  `object`




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

| `availableClusterRoles`
| `array (string)`
| availableClusterRoles is the list of ClusterRole names that are assignable to users
through the project access tab.

|===
=== .spec.customization.quickStarts
Description::
+
--
quickStarts allows customization of available ConsoleQuickStart resources in console.
--

Type::
  `object`




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

| `disabled`
| `array (string)`
| disabled is a list of ConsoleQuickStart resource names that are not shown to users.

|===
=== .spec.ingress
Description::
+
--
ingress allows to configure the alternative ingress for the console.
This field is intended for clusters without ingress capability,
where access to routes is not possible.
--

Type::
  `object`




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

| `clientDownloadsURL`
| `string`
| clientDownloadsURL is a URL to be used as the address to download client binaries.
If not specified, the downloads route hostname will be used.
This field is required for clusters without ingress capability,
where access to routes is not possible.
The console operator will monitor the URL and may go degraded
if it's unreachable for an extended period.
Must use the HTTPS scheme.

| `consoleURL`
| `string`
| consoleURL is a URL to be used as the base console address.
If not specified, the console route hostname will be used.
This field is required for clusters without ingress capability,
where access to routes is not possible.
Make sure that appropriate ingress is set up at this URL.
The console operator will monitor the URL and may go degraded
if it's unreachable for an extended period.
Must use the HTTPS scheme.

|===
=== .spec.providers
Description::
+
--
providers contains configuration for using specific service providers.
--

Type::
  `object`




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

| `statuspage`
| `object`
| statuspage contains ID for statuspage.io page that provides status info about.

|===
=== .spec.providers.statuspage
Description::
+
--
statuspage contains ID for statuspage.io page that provides status info about.
--

Type::
  `object`




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

| `pageID`
| `string`
| pageID is the unique ID assigned by Statuspage for your page. This must be a public page.

|===
=== .spec.route
Description::
+
--
route contains hostname and secret reference that contains the serving certificate.
If a custom route is specified, a new route will be created with the
provided hostname, under which console will be available.
In case of custom hostname uses the default routing suffix of the cluster,
the Secret specification for a serving certificate will not be needed.
In case of custom hostname points to an arbitrary domain, manual DNS configurations steps are necessary.
The default console route will be maintained to reserve the default hostname
for console if the custom route is removed.
If not specified, default route will be used.
DEPRECATED
--

Type::
  `object`




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

| `hostname`
| `string`
| hostname is the desired custom domain under which console will be available.

| `secret`
| `object`
| secret points to secret in the openshift-config namespace that contains custom
certificate and key and needs to be created manually by the cluster admin.
Referenced Secret is required to contain following key value pairs:
- "tls.crt" - to specifies custom certificate
- "tls.key" - to specifies private key of the custom certificate
If the custom hostname uses the default routing suffix of the cluster,
the Secret specification for a serving certificate will not be needed.

|===
=== .spec.route.secret
Description::
+
--
secret points to secret in the openshift-config namespace that contains custom
certificate and key and needs to be created manually by the cluster admin.
Referenced Secret is required to contain following key value pairs:
- "tls.crt" - to specifies custom certificate
- "tls.key" - to specifies private key of the custom certificate
If the custom hostname uses the default routing suffix of the cluster,
the Secret specification for a serving certificate will not be needed.
--

Type::
  `object`

Required::
  - `name`



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

| `name`
| `string`
| name is the metadata.name of the referenced secret

|===
=== .status
Description::
+
--
ConsoleStatus defines the observed status of the Console.
--

Type::
  `object`




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

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

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

Required::
  - `lastTransitionTime`
  - `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`
| 

| `reason`
| `string`
| 

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

Required::
  - `group`
  - `name`
  - `namespace`
  - `resource`



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

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

|===

== API endpoints

The following API endpoints are available:

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


=== /apis/operator.openshift.io/v1/consoles



HTTP method::
  `DELETE`

Description::
  delete collection of Console




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




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

HTTP method::
  `POST`

Description::
  create a Console


.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:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema
| 
|===

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


=== /apis/operator.openshift.io/v1/consoles/{name}

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


HTTP method::
  `DELETE`

Description::
  delete a Console


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




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

HTTP method::
  `PATCH`

Description::
  partially update the specified Console


.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:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified Console


.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:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema
| 
|===

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


=== /apis/operator.openshift.io/v1/consoles/{name}/status

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


HTTP method::
  `GET`

Description::
  read status of the specified Console




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

HTTP method::
  `PATCH`

Description::
  partially update status of the specified Console


.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:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified Console


.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:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema
| 
|===

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


