- Console [operator.openshift.io/v1]
- Specification
- .spec
- .spec.customization
- .spec.customization.addPage
- .spec.customization.customLogoFile
- .spec.customization.developerCatalog
- .spec.customization.developerCatalog.categories
- .spec.customization.developerCatalog.categories[]
- .spec.customization.developerCatalog.categories[].subcategories
- .spec.customization.developerCatalog.categories[].subcategories[]
- .spec.customization.developerCatalog.types
- .spec.customization.perspectives
- .spec.customization.perspectives[]
- .spec.customization.perspectives[].pinnedResources
- .spec.customization.perspectives[].pinnedResources[]
- .spec.customization.perspectives[].visibility
- .spec.customization.perspectives[].visibility.accessReview
- .spec.customization.perspectives[].visibility.accessReview.missing
- .spec.customization.perspectives[].visibility.accessReview.missing[]
- .spec.customization.perspectives[].visibility.accessReview.required
- .spec.customization.perspectives[].visibility.accessReview.required[]
- .spec.customization.projectAccess
- .spec.customization.quickStarts
- .spec.providers
- .spec.providers.statuspage
- .spec.route
- .spec.route.secret
- .status
- .status.conditions
- .status.conditions[]
- .status.generations
- .status.generations[]
- API endpoints
- Specification
Console [operator.openshift.io/v1]
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
Property | Type | Description |
---|---|---|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| ConsoleSpec is the specification of the desired behavior of the Console. |
|
| ConsoleStatus defines the observed status of the Console. |
.spec
Description
ConsoleSpec is the specification of the desired behavior of the Console.
Type
object
Property | Type | Description |
---|---|---|
|
| customization is used to optionally provide a small set of customization options to the web console. |
|
| 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 indicates whether and how the operator should manage the component |
|
| 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 |
.spec.customization
Description
customization is used to optionally provide a small set of customization options to the web console.
Type
object
Property | Type | Description |
---|---|---|
|
| addPage allows customizing actions on the Add page in developer perspective. |
|
| 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. |
|
| customLogoFile replaces the default OpenShift logo in the masthead and about dialog. It is a reference to a 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. Recommended logo specifications: Dimensions: Max height of 68px and max width of 200px SVG format preferred |
|
| 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 allows to configure the shown developer catalog categories (filters) and types (sub-catalogs). |
|
| 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. |
|
| perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown. |
|
| Perspective defines a perspective that cluster admins want to show/hide in the perspective switcher dropdown |
|
| 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 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
Property | Type | Description |
---|---|---|
|
| disabledActions is a list of actions that are not shown to users. Each action in the list is represented by its ID. |
.spec.customization.customLogoFile
Description
customLogoFile replaces the default OpenShift logo in the masthead and about dialog. It is a reference to a 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. Recommended logo specifications: Dimensions: Max height of 68px and max width of 200px SVG format preferred
Type
object
Property | Type | Description |
---|---|---|
|
| Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. |
|
|
.spec.customization.developerCatalog
Description
developerCatalog allows to configure the shown developer catalog categories (filters) and types (sub-catalogs).
Type
object
Property | Type | Description |
---|---|---|
|
| categories which are shown in the developer catalog. |
|
| DeveloperConsoleCatalogCategory for the developer console catalog. |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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 defines a category display label. It is required and must have 1-64 characters. |
|
| subcategories defines a list of child categories. |
|
| DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category. |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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 defines a category display label. It is required and must have 1-64 characters. |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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 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 defines if a list of catalog types should be enabled or disabled. |
.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
Property | Type | Description |
---|---|---|
|
| 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 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 |
|
| PinnedResourceReference includes the group, version and type of resource |
|
| 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
Property | Type | Description |
---|---|---|
|
| 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 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 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
Property | Type | Description |
---|---|---|
|
| accessReview defines required and missing access review checks. |
|
| 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
Property | Type | 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. |
|
| ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface |
|
| 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. |
|
| 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
Property | Type | Description |
---|---|---|
|
| Group is the API Group of the Resource. ““ means all. |
|
| Name is the name of the resource being requested for a “get” or deleted for a “delete”. “” (empty) means all. |
|
| 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 is one of the existing resource types. ““ means all. |
|
| Subresource is one of the existing resource types. “” means none. |
|
| Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. ““ means all. |
|
| Version is the API Version of the Resource. ““ means all. |
.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
Property | Type | Description |
---|---|---|
|
| Group is the API Group of the Resource. ““ means all. |
|
| Name is the name of the resource being requested for a “get” or deleted for a “delete”. “” (empty) means all. |
|
| 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 is one of the existing resource types. ““ means all. |
|
| Subresource is one of the existing resource types. “” means none. |
|
| Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. ““ means all. |
|
| Version is the API Version of the Resource. ““ means all. |
.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
Property | Type | Description |
---|---|---|
|
| 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
Property | Type | Description |
---|---|---|
|
| disabled is a list of ConsoleQuickStart resource names that are not shown to users. |
.spec.providers
Description
providers contains configuration for using specific service providers.
Type
object
Property | Type | Description |
---|---|---|
|
| 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
Property | Type | Description |
---|---|---|
|
| 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
Property | Type | Description |
---|---|---|
|
| hostname is the desired custom domain under which console will be available. |
|
| 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
Property | Type | Description |
---|---|---|
|
| name is the metadata.name of the referenced secret |
.status
Description
ConsoleStatus defines the observed status of the Console.
Type
object
Property | Type | Description |
---|---|---|
|
| conditions is a list of conditions and their status |
|
| OperatorCondition is just the standard condition fields. |
|
| generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction. |
|
| GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made. |
|
| observedGeneration is the last generation change you’ve dealt with |
|
| readyReplicas indicates how many replicas are ready and at the desired state |
|
| 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
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.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
Property | Type | Description |
---|---|---|
|
| group is the group of the thing you’re tracking |
|
| hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps |
|
| lastGeneration is the last generation of the workload controller involved |
|
| name is the name of the thing you’re tracking |
|
| namespace is where the thing you’re tracking is |
|
| 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 ConsoleGET
: list objects of kind ConsolePOST
: create a Console
/apis/operator.openshift.io/v1/consoles/{name}
DELETE
: delete a ConsoleGET
: read the specified ConsolePATCH
: partially update the specified ConsolePUT
: replace the specified Console
/apis/operator.openshift.io/v1/consoles/{name}/status
GET
: read status of the specified ConsolePATCH
: partially update status of the specified ConsolePUT
: replace status of the specified Console
/apis/operator.openshift.io/v1/consoles
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete collection of Console
Parameter | Type | Description |
---|---|---|
|
| 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. |
|
| 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 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 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list objects of kind Console
Parameter | Type | Description |
---|---|---|
|
| 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. |
|
| 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 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 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 |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK | ConsoleList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a Console
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| 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. |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
| Console schema |
HTTP code | Reponse body |
---|---|
200 - OK | Console schema |
201 - Created | Console schema |
202 - Accepted | Console schema |
401 - Unauthorized | Empty |
/apis/operator.openshift.io/v1/consoles/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the Console |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete a Console
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| 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. |
|
| 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. |
|
| 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. |
Parameter | Type | Description |
---|---|---|
| DeleteOptions schema |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified Console
Parameter | Type | Description |
---|---|---|
|
| 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 |
HTTP code | Reponse body |
---|---|
200 - OK | Console schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified Console
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| 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. |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
| Patch schema |
HTTP code | Reponse body |
---|---|
200 - OK | Console schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified Console
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| 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. |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
| Console schema |
HTTP code | Reponse body |
---|---|
200 - OK | Console schema |
201 - Created | Console schema |
401 - Unauthorized | Empty |
/apis/operator.openshift.io/v1/consoles/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the Console |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
GET
Description
read status of the specified Console
Parameter | Type | Description |
---|---|---|
|
| 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 |
HTTP code | Reponse body |
---|---|
200 - OK | Console schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified Console
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| 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. |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
| Patch schema |
HTTP code | Reponse body |
---|---|
200 - OK | Console schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified Console
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| 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. |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
| Console schema |
HTTP code | Reponse body |
---|---|
200 - OK | Console schema |
201 - Created | Console schema |
401 - Unauthorized | Empty |