{ "description": "Console provides a means to configure an operator to manage the console. \n Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).", "properties": { "apiVersion": { "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", "type": "string" }, "kind": { "description": "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", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "ConsoleSpec is the specification of the desired behavior of the Console.", "properties": { "customization": { "description": "customization is used to optionally provide a small set of customization options to the web console.", "properties": { "addPage": { "description": "addPage allows customizing actions on the Add page in developer perspective.", "properties": { "disabledActions": { "description": "disabledActions is a list of actions that are not shown to users. Each action in the list is represented by its ID.", "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "additionalProperties": false }, "brand": { "description": "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.", "pattern": "^$|^(ocp|origin|okd|dedicated|online|azure)$", "type": "string" }, "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", "properties": { "key": { "description": "Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.", "type": "string" }, "name": { "type": "string" } }, "type": "object", "additionalProperties": false }, "customProductName": { "description": "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.", "type": "string" }, "developerCatalog": { "description": "developerCatalog allows to configure the shown developer catalog categories.", "properties": { "categories": { "description": "categories which are shown in the developer catalog.", "items": { "description": "DeveloperConsoleCatalogCategory for the developer console catalog.", "properties": { "id": { "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.", "maxLength": 32, "minLength": 1, "pattern": "^[A-Za-z0-9-_]+$", "type": "string" }, "label": { "description": "label defines a category display label. It is required and must have 1-64 characters.", "maxLength": 64, "minLength": 1, "type": "string" }, "subcategories": { "description": "subcategories defines a list of child categories.", "items": { "description": "DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category.", "properties": { "id": { "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.", "maxLength": 32, "minLength": 1, "pattern": "^[A-Za-z0-9-_]+$", "type": "string" }, "label": { "description": "label defines a category display label. It is required and must have 1-64 characters.", "maxLength": 64, "minLength": 1, "type": "string" }, "tags": { "description": "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "label" ], "type": "object", "additionalProperties": false }, "type": "array" }, "tags": { "description": "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "label" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "documentationBaseURL": { "description": "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.", "pattern": "^$|^((https):\\/\\/?)[^\\s()<>]+(?:\\([\\w\\d]+\\)|([^[:punct:]\\s]|\\/?))\\/$", "type": "string" }, "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.", "properties": { "availableClusterRoles": { "description": "availableClusterRoles is the list of ClusterRole names that are assignable to users through the project access tab.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "quickStarts": { "description": "quickStarts allows customization of available ConsoleQuickStart resources in console.", "properties": { "disabled": { "description": "disabled is a list of ConsoleQuickStart resource names that are not shown to users.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "logLevel": { "default": "Normal", "description": "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. \n Valid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".", "enum": [ "", "Normal", "Debug", "Trace", "TraceAll" ], "type": "string" }, "managementState": { "description": "managementState indicates whether and how the operator should manage the component", "pattern": "^(Managed|Unmanaged|Force|Removed)$", "type": "string" }, "observedConfig": { "description": "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", "type": [ "object", "null" ], "x-kubernetes-preserve-unknown-fields": true }, "operatorLogLevel": { "default": "Normal", "description": "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. \n Valid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".", "enum": [ "", "Normal", "Debug", "Trace", "TraceAll" ], "type": "string" }, "plugins": { "description": "plugins defines a list of enabled console plugin names.", "items": { "type": "string" }, "type": "array" }, "providers": { "description": "providers contains configuration for using specific service providers.", "properties": { "statuspage": { "description": "statuspage contains ID for statuspage.io page that provides status info about.", "properties": { "pageID": { "description": "pageID is the unique ID assigned by Statuspage for your page. This must be a public page.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "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", "properties": { "hostname": { "description": "hostname is the desired custom domain under which console will be available.", "type": "string" }, "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.", "properties": { "name": { "description": "name is the metadata.name of the referenced secret", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "unsupportedConfigOverrides": { "description": "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", "type": [ "object", "null" ], "x-kubernetes-preserve-unknown-fields": true } }, "type": "object", "additionalProperties": false }, "status": { "description": "ConsoleStatus defines the observed status of the Console.", "properties": { "conditions": { "description": "conditions is a list of conditions and their status", "items": { "description": "OperatorCondition is just the standard condition fields.", "properties": { "lastTransitionTime": { "format": "date-time", "type": "string" }, "message": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "generations": { "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.", "items": { "description": "GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.", "properties": { "group": { "description": "group is the group of the thing you're tracking", "type": "string" }, "hash": { "description": "hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps", "type": "string" }, "lastGeneration": { "description": "lastGeneration is the last generation of the workload controller involved", "format": "int64", "type": "integer", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "name": { "description": "name is the name of the thing you're tracking", "type": "string" }, "namespace": { "description": "namespace is where the thing you're tracking is", "type": "string" }, "resource": { "description": "resource is the resource type of the thing you're tracking", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "observedGeneration": { "description": "observedGeneration is the last generation change you've dealt with", "format": "int64", "type": "integer", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "readyReplicas": { "description": "readyReplicas indicates how many replicas are ready and at the desired state", "format": "int32", "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "version": { "description": "version is the level this availability applies to", "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "spec" ], "type": "object", "additionalProperties": false, "$schema": "http://json-schema.org/draft-04/schema#" }