控制台 [operator.openshift.io/v1]

customization

对象

customization 用于可选地为 Web 控制台提供少量自定义选项。

ingress

对象

ingress 允许配置控制台的替代入口。此字段适用于没有入口功能的集群，在这些集群中无法访问路由。

logLevel

字符串

logLevel 是基于意图的整体组件日志记录。它不提供细粒度的控制，但它是一种简单的方法来管理操作员必须为其操作数解释的粗粒度日志记录选择。有效值为：“Normal”、“Debug”、“Trace”、“TraceAll”。默认为“Normal”。

managementState

字符串

managementState 指示操作员是否以及如何管理组件

observedConfig

``

observedConfig 包含控制器从集群状态观察到的稀疏配置。它存在于规范中，因为它是对操作员级别的输入

operatorLogLevel

字符串

operatorLogLevel 是操作符本身的基于意图的日志记录。它不提供细粒度的控制，但它是一种简单的方法来管理操作员必须为自己解释的粗粒度日志记录选择。有效值为：“Normal”、“Debug”、“Trace”、“TraceAll”。默认为“Normal”。

plugins

数组（字符串）

plugins 定义已启用控制台插件名称的列表。

providers

对象

providers 包含使用特定服务提供商的配置。

route

对象

route 包含主机名和包含服务证书的密钥引用。如果指定了自定义路由，则将创建一个具有提供的主机名的新的路由，控制台将在该路由下可用。如果自定义主机名使用集群的默认路由后缀，则不需要服务证书的 Secret 规范。如果自定义主机名指向任意域名，则需要手动 DNS 配置步骤。如果删除了自定义路由，则将维护默认控制台路由以保留控制台的默认主机名。如果未指定，则将使用默认路由。已弃用

unsupportedConfigOverrides

``

unsupportedConfigOverrides 覆盖了操作员计算的最终配置。Red Hat 不支持使用此字段。误用此字段可能会导致意外行为或与其他配置选项冲突。在使用此字段之前，请寻求 Red Hat 支持的指导。使用此属性会阻止集群升级，必须在升级集群之前将其删除。

addPage

对象

addPage 允许自定义开发人员视角中“添加”页面上的操作。

brand

字符串

brand 是 Web 控制台的默认品牌，可以通过提供 brand 字段来覆盖。有一组有限的特定品牌选项。此字段控制控制台的元素，例如徽标。无效值将阻止控制台推出。

capabilities

数组

capabilities 定义可以在控制台 UI 中交互的一组功能。每个功能都定义一个可视化状态，可以与控制台交互以在 UI 中呈现。可用的功能是 LightspeedButton。每个可用功能最多只能在列表中出现一次。

capabilities[]

对象

Capabilities 包含控制台 UI 中的一组 UI 功能及其状态。

customLogoFile

对象

customLogoFile 替换 masthead 和关于对话框中的默认 OpenShift 徽标。它是 openshift-config 命名空间中 ConfigMap 的引用。可以使用类似“oc create configmap custom-logo --from-file=/path/to/file -n openshift-config”的命令来创建它。由于 ConfigMap 大小的限制，图像大小必须小于 1 MB。ConfigMap 密钥应包含文件扩展名，以便控制台使用正确的 MIME 类型提供文件。推荐的徽标规格：尺寸：最大高度 68 像素，最大宽度 200 像素，首选 SVG 格式

customProductName

字符串

customProductName 是在页面标题、logo 替代文本和关于对话框中显示的名称，而不是默认的 OpenShift 产品名称。

developerCatalog

对象

developerCatalog 允许配置显示的开发者目录类别（过滤器）和类型（子目录）。

documentationBaseURL

字符串

documentationBaseURL 用于链接到显示在 Web 控制台各个部分的外部文档。提供 documentationBaseURL 将覆盖默认文档 URL。无效值将阻止控制台部署。

perspectives

数组

perspectives 允许启用/禁用用户在“视角切换”下拉菜单中看到的视角。

perspectives[]

对象

Perspective 定义集群管理员希望在视角切换下拉菜单中显示/隐藏的视角。

projectAccess

对象

projectAccess 允许自定义开发者视角“项目访问”页面中可用的 ClusterRole 列表，项目管理员可以使用该列表为其他用户指定角色并限制项目内的访问权限。如果设置了此项，该列表将替换默认的 ClusterRole 选项。

quickStarts

对象

quickStarts 允许自定义控制台中可用的 ConsoleQuickStart 资源。

disabledActions

数组（字符串）

disabledActions 是一个列表，其中包含不向用户显示的操作。列表中的每个操作都由其 ID 表示。

name

字符串

name 是功能的唯一名称。可用的功能是 LightspeedButton。

visibility

对象

visibility 定义功能的可见性状态。

state

字符串

state 定义功能在控制台 UI 中是启用还是禁用。“Enabled”值表示在控制台 UI 中启用该功能。“Disabled”值表示在控制台 UI 中禁用该功能。

key

字符串

Key 允许指向 configmap 内的特定键/值。这对于逻辑文件引用很有用。

name

字符串

categories

数组

在开发者目录中显示的categories。

categories[]

对象

开发者控制台目录的 DeveloperConsoleCatalogCategory。

types

对象

types 允许启用或禁用用户在开发者目录中看到的子目录类型。如果省略，则将显示所有子目录类型。

id

字符串

ID 是 URL 中使用的标识符，用于启用控制台中的深层链接。ID 是必需的，并且必须具有 1-32 个 URL 安全字符（A-Z、a-z、0-9、- 和 _）。

label

字符串

label 定义类别显示标签。这是必需的，并且必须具有 1-64 个字符。

subcategories

数组

subcategories 定义子类别的列表。

subcategories[]

对象

DeveloperConsoleCatalogCategoryMeta 是开发者目录类别的关键标识符。

tags

数组（字符串）

tags 是一个字符串列表，用于匹配类别。选定的类别将显示所有至少具有类别和项目之间一个重叠标签的项目。

id

字符串

ID 是 URL 中使用的标识符，用于启用控制台中的深层链接。ID 是必需的，并且必须具有 1-32 个 URL 安全字符（A-Z、a-z、0-9、- 和 _）。

label

字符串

label 定义类别显示标签。这是必需的，并且必须具有 1-64 个字符。

tags

数组（字符串）

tags 是一个字符串列表，用于匹配类别。选定的类别将显示所有至少具有类别和项目之间一个重叠标签的项目。

disabled

数组（字符串）

disabled 是一个开发者目录类型（子目录 ID）列表，这些类型不向用户显示。类型（子目录）通过控制台插件添加，可用的类型（子目录 ID）可在集群配置页面上的控制台中获得，或者在控制台中编辑 YAML 时获得。例如：“Devfile”、“HelmChart”、“BuilderImage”。如果列表为空或添加了所有可用的子目录类型，则应隐藏完整的开发者目录。

enabled

数组（字符串）

enabled 是一个开发者目录类型（子目录 ID）列表，这些类型将显示给用户。类型（子目录）通过控制台插件添加，可用的类型（子目录 ID）可在集群配置页面上的控制台中获得，或者在控制台中编辑 YAML 时获得。例如：“Devfile”、“HelmChart”、“BuilderImage”。如果列表不为空，则只有在将新类型添加到列表后，才会向用户显示该类型。如果列表为空，则将显示完整的开发者目录。

state

字符串

state 定义是否应启用或禁用目录类型列表。

id

字符串

id 定义视角的 ID。例如：“dev”、“admin”。可用的视角 ID 可以在 yaml 编辑器旁边的代码片段部分找到。不正确或未知的 ID 将被忽略。

pinnedResources

数组

pinnedResources 定义用户如果尚未自行自定义这些固定资源，则会在视角导航中看到的默认固定资源列表。可用的 Kubernetes 资源列表可以通过kubectl api-resources读取。控制台还将提供一个配置 UI 和一个 YAML 代码片段，这些代码片段将列出可以固定到导航的可用资源。不正确或未知的资源将被忽略。

pinnedResources[]

对象

PinnedResourceReference 包括资源的组、版本和类型。

visibility

对象

visibility 定义视角的状态以及如果需要该视角的访问审查检查。

group

字符串

group 是资源的 API 组。对于核心组，请输入空字符串。此值应仅包含小写字母数字字符、连字符和句点。例如：“”、“apps”、“build.openshift.io”等。

resource

字符串

resource 是被引用的类型。它通常是小写的资源类型的复数形式。此值应仅包含小写字母数字字符和连字符。例如：“deployments”、“deploymentconfigs”、“pods”等。

version

字符串

version 是资源的 API 版本。此值应仅包含小写字母数字字符。例如：“v1”、“v1beta1”等。

accessReview

对象

accessReview 定义所需和缺少的访问审查检查。

state

字符串

state 定义视角是启用还是禁用，或者是否需要访问审查检查。

missing

数组

missing 定义了一个权限检查列表。只有当至少一项检查失败时，才会显示该视角。如果省略此字段，则会跳过访问审查，除非根据所需访问审查列表的配置需要显示该视角。

missing[]

对象

ResourceAttributes 包含可用于向 Authorizer 接口发出资源请求的授权属性。

required

数组

required 定义了一个权限检查列表。只有当所有检查都成功时，才会显示该视角。如果省略此字段，则会跳过访问审查，除非根据 missing 访问审查列表的配置需要显示该视角。

required[]

对象

ResourceAttributes 包含可用于向 Authorizer 接口发出资源请求的授权属性。

group

字符串

Group 是资源的 API 分组。“*”表示全部。

name

字符串

Name 是针对“get”请求而请求的资源名称，或针对“delete”请求而删除的资源名称。“”（空）表示全部。

namespace

字符串

Namespace 是正在请求的操作的命名空间。目前，没有命名空间和所有命名空间之间没有区别。“”（空）对于 LocalSubjectAccessReviews 默认为空；对于集群范围的资源，“”（空）为空；对于来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围的资源，“”（空）表示“全部”。

resource

字符串

Resource 是现有资源类型之一。“*”表示全部。

subresource

字符串

Subresource 是现有资源类型之一。“”表示无。

verb

字符串

Verb 是 Kubernetes 资源 API 动词，例如：get、list、watch、create、update、delete、proxy。“*”表示全部。

version

字符串

Version 是资源的 API 版本。“*”表示全部。

group

字符串

Group 是资源的 API 分组。“*”表示全部。

name

字符串

Name 是针对“get”请求而请求的资源名称，或针对“delete”请求而删除的资源名称。“”（空）表示全部。

namespace

字符串

Namespace 是正在请求的操作的命名空间。目前，没有命名空间和所有命名空间之间没有区别。“”（空）对于 LocalSubjectAccessReviews 默认为空；对于集群范围的资源，“”（空）为空；对于来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围的资源，“”（空）表示“全部”。

resource

字符串

Resource 是现有资源类型之一。“*”表示全部。

subresource

字符串

Subresource 是现有资源类型之一。“”表示无。

verb

字符串

Verb 是 Kubernetes 资源 API 动词，例如：get、list、watch、create、update、delete、proxy。“*”表示全部。

version

字符串

Version 是资源的 API 版本。“*”表示全部。

availableClusterRoles

数组（字符串）

availableClusterRoles 是可通过项目访问选项卡分配给用户的 ClusterRole 名称列表。

disabled

数组（字符串）

disabled 是不向用户显示的 ConsoleQuickStart 资源名称列表。

clientDownloadsURL

字符串

clientDownloadsURL 是用作下载客户端二进制文件的地址的 URL。如果未指定，则将使用下载路由主机名。对于没有 Ingress 功能的集群，此字段是必需的，因为无法访问路由。控制台操作符将监控此 URL，如果长时间无法访问，则可能会降级。必须使用 HTTPS 方案。

consoleURL

字符串

consoleURL 是用作基本控制台地址的 URL。如果未指定，则将使用控制台路由主机名。对于没有 Ingress 功能的集群，此字段是必需的，因为无法访问路由。确保在此 URL 上设置了适当的 Ingress。控制台操作符将监控此 URL，如果长时间无法访问，则可能会降级。必须使用 HTTPS 方案。

statuspage

对象

statuspage 包含 statuspage.io 页面的 ID，该页面提供有关状态的信息。

pageID

字符串

pageID 是 Statuspage 为您的页面分配的唯一 ID。这必须是公共页面。

hostname

字符串

hostname 是控制台可用的所需自定义域名。

secret

对象

secret 指向 openshift-config 命名空间中的密钥，其中包含自定义证书和密钥，需要由集群管理员手动创建。引用的密钥必须包含以下键值对： - “tls.crt” - 指定自定义证书 - “tls.key” - 指定自定义证书的私钥。如果自定义主机名使用集群的默认路由后缀，则不需要服务证书的密钥规范。

name

字符串

name 是引用的密钥的 metadata.name

conditions

数组

conditions 是条件及其状态的列表。

conditions[]

对象

OperatorCondition 只是标准的条件字段。

generations

数组

generations 用于确定何时需要协调项目或项目以需要React的方式更改。

generations[]

对象

GenerationStatus 跟踪给定资源的代数，以便可以做出关于强制更新的决策。

observedGeneration

integer

observedGeneration 是您处理的最后一代更改。

readyReplicas

integer

readyReplicas 指示有多少个副本已准备就绪并处于所需状态。

version

字符串

version 是此可用性适用的级别。

lastTransitionTime

字符串

message

字符串

reason

字符串

status

字符串

type

字符串

group

字符串

group 是您正在跟踪的事物的组。

hash

字符串

hash 是为没有代数且对内容敏感的资源（如密钥和 ConfigMap）设置的可选字段。

lastGeneration

integer

lastGeneration 是所涉及的工作负载控制器的最后一代。

name

字符串

name 是您正在跟踪的事物的名称。

namespace

字符串

namespace 是您正在跟踪的事物所在的命名空间。

resource

字符串

resource 是您正在跟踪的事物的资源类型。

200 - OK

Status 模式

401 - Unauthorized

空

200 - OK

ConsoleList 模式

401 - Unauthorized

空

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何未知字段（这些字段将从对象中静默删除），并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

body

Console 模式

200 - OK

Console 模式

201 - 已创建

Console 模式

202 - 已接受

Console 模式

401 - Unauthorized

空

name

字符串

Console 的名称

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - Unauthorized

空

200 - OK

Console 模式

401 - Unauthorized

空

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何未知字段（这些字段将从对象中静默删除），并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

200 - OK

Console 模式

401 - Unauthorized

空

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何未知字段（这些字段将从对象中静默删除），并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

body

Console 模式

200 - OK

Console 模式

201 - 已创建

Console 模式

401 - Unauthorized

空

name

字符串

Console 的名称

200 - OK

Console 模式

401 - Unauthorized

空

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何未知字段（这些字段将从对象中静默删除），并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

200 - OK

Console 模式

401 - Unauthorized

空

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何未知字段（这些字段将从对象中静默删除），并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

body

Console 模式

200 - OK

Console 模式

201 - 已创建

Console 模式

401 - Unauthorized

空