第 5 章 Console [operator.openshift.io/v1]

自定义

对象

自定义用于选择性地为 web 控制台提供一组较小的自定义选项。

ingress

object

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

logLevel

字符串

Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。

有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。

managementState

字符串

managementState 指明 Operator 是否应该管理组件

observedConfig

``

observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入

operatorLogLevel

字符串

operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。

有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。

plugins

数组（字符串）

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

providers

对象

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

route

对象

路由包含包含服务证书的主机名和 secret 引用。如果指定了自定义路由，则会使用提供的主机名创建新路由，该主机名下提供控制台。如果自定义主机名使用集群的默认路由后缀，则不需要服务证书的 Secret 规格。如果自定义主机名指向任意域，则需要手动 DNS 配置步骤。如果删除了自定义路由，则会维护默认控制台路由，以便为控制台保留默认主机名。如果没有指定，则使用默认路由。弃用

unsupportedConfigOverrides

``

unsupportedConfigOverrides 覆盖 Operator 计算的最终配置。红帽不支持使用此字段。滥用此字段可能会导致意外行为或与其他配置选项冲突。在使用此字段前，请参阅红帽支持的指导。使用此属性会阻止集群升级，必须在升级集群前删除它。

addPage

对象

addPage 允许在 Developer 视角中的 Add 页面中自定义操作。

品牌

字符串

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

功能

数组

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

capabilities[]

object

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

customLogoFile

对象

customLogoFile 替换 masthead 和 about 对话框中的默认 OpenShift 徽标。它只是一次可以设置 customLogoFile 或 logos 的一个参考。openshift-config 命名空间中的 ConfigMap。这可以通过 'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config' 等命令来创建。由于 ConfigMap 大小的限制，镜像大小必须小于 1 MB。ConfigMap 键应包含文件扩展名，以便控制台提供具有正确 MIME 类型的文件。徽标的建议文件格式是 SVG，但如果浏览器支持其他文件格式，则允许其他文件格式。弃用 ：使用徽标。

customProductName

字符串

customProductName 是页面标题、徽标 alt 文本以及有关对话框而不是普通的 OpenShift 产品名称显示的名称。

developerCatalog

object

developerCatalog 允许配置显示的开发人员目录类别(filters)和类型(sub-catalogs)。

documentationBaseURL

字符串

Web 控制台的各种部分中显示了到外部文档的 DocumentationBaseURL 链接。提供 DocumentationBaseURL 将覆盖默认文档 URL。无效的值将导致控制台推出部署。

徽标

数组

徽标用于将控制台 UI 中的 OpenShift Masthead 和 Favicon 徽标替换为自定义徽标。徽标是一个可选字段，允许徽标列表。一次只能设置其中一个徽标或 customLogoFile。如果设置了徽标，则必须取消设置 customLogoFile。指定后，必须至少有一个条目，且不超过 2 个条目。每种类型必须在列表中仅显示一次。

logos[]

object

徽标根据控制台 UI 徽标的主题模式定义配置。

perspectives

数组

透视图允许启用/禁用用户在视角切换器下拉菜单中可见的视角。

perspectives[]

object

视角定义了集群管理员要在视角切换器下拉菜单中显示/隐藏的视角

projectAccess

对象

ProjectAccess 允许在 Developer 视角 Project 访问页面中自定义可用 ClusterRole 列表，供项目 admin 用于指定角色到其他用户，并限制项目中的访问。如果设置，列表将替换默认的 ClusterRole 选项。

quickStarts

对象

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

disabledActions

数组（字符串）

disabledActions 是未向用户显示的操作列表。列表中的每个操作都由其 ID 表示。

name

string

name 是能力的唯一名称。可用功能包括 LightspeedButton 和 GettingStartedBanner。

可见性

object

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

state

string

State 定义在控制台 UI 中是否启用或禁用了该功能。在控制台 UI 中启用的功能由 "Enabled" 值表示。在控制台 UI 中禁用功能由 "Disabled" 值表示。

key

string

键允许指向 configmap 中的特定键/值。这对逻辑文件引用非常有用。

name

字符串

类别

array

开发人员目录中显示的类别。

categories[]

对象

DeveloperConsoleCatalogCategory 用于开发人员控制台目录。

类型

object

Type 允许启用或禁用用户可以在 Developer 目录中看到的子目录类型。如果省略时，将显示所有子目录类型。

id

string

ID 是 URL 中用来在控制台中启用深度链接的标识符。ID 是必需的，且必须具有 1-32 URL 安全(A-Z、a-z、0-9、- 和 _)。

label

字符串

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

subcategories

array

subcategories 定义子类别列表。

subcategories[]

对象

DeveloperConsoleCatalogCategoryMeta 是开发人员目录类别的密钥标识符。

tags

数组（字符串）

tags 是与类别匹配的字符串列表。所选类别显示所有在类别和项目之间至少有一个重叠标签的项目。

id

string

ID 是 URL 中用来在控制台中启用深度链接的标识符。ID 是必需的，且必须具有 1-32 URL 安全(A-Z、a-z、0-9、- 和 _)。

label

字符串

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

tags

数组（字符串）

tags 是与类别匹配的字符串列表。所选类别显示所有在类别和项目之间至少有一个重叠标签的项目。

disabled

数组（字符串）

disabled 是未向用户显示的开发人员目录类型(sub-catalogs ID)列表。通过控制台插件添加类型(sub-catalogs)，可用的类型(sub-catalog ID)可在集群配置页面上提供，或在控制台中编辑 YAML 时。示例："Devfile", "HelmChart", "BuilderImage"，如果列表为空，或添加了所有可用的子目录类型，则应隐藏完整的开发人员目录。

enabled

数组（字符串）

enabled 是开发人员目录类型(sub-catalogs ID)的列表，它将向用户显示。通过控制台插件添加类型(sub-catalogs)，可用的类型(sub-catalog ID)可在集群配置页面上提供，或在控制台中编辑 YAML 时。示例："Devfile", "HelmChart", "BuilderImage"，如果列表不是空的，则不会向用户显示一个新的类型，直到它添加到列表为止。如果列表为空，则会显示完整的开发人员目录。

state

string

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

themes

数组

themes 为控制台 UI 徽标指定主题。主题是一个允许列出主题的必填字段。themes 列表中的每一项都必须具有唯一的模式和 source 字段。每个模式都决定徽标是否为控制台 UI 的 dark 或 light 模式。如果没有指定主题，则会显示该主题的默认 OpenShift 徽标。必须至少有一个条目，且不超过 2 个条目。

themes[]

object

主题 为控制台 UI 定义主题模式。

type

string

Type 指定控制台 UI 的徽标类型。它决定了 masthead 或 favicon. type 的徽标是允许 Masthead 和 Favicon 值的必填字段。当设置为 "Masthead" 时，徽标将在 masthead 和 console UI 的模态中使用。当设置为 "Favicon" 时，徽标将用作控制台 UI 的 favicon。

模式

string

mode 用于指定徽标在控制台 UI 中应用到的主题模式。模式是一个必需字段，允许 Dark 和 Light 值。当设置为 Dark 时，当控制台 UI 的最终用户启用 Dark 模式时，将使用 'file' 字段中引用的徽标文件。当设置为 Light 时，当控制台 UI 的最终用户启用 Light 模式时，将使用 'file' 字段中引用的徽标文件。

source

object

控制台使用源来定位包含自定义徽标的指定文件。源是一个必填字段，引用 openshift-config 命名空间中包含自定义徽标文件的 ConfigMap 名称和密钥。您可以使用类似以下命令创建它： - 'oc create configmap custom-logos-config --namespace=openshift-config --from-file=/path/to/file'。ConfigMap 键必须包含文件扩展名，以便控制台为具有正确的 MIME 类型的文件提供。Masthead 和 Favicon 徽标的建议文件格式是 SVG，但如果浏览器支持，则允许其他文件格式。由于 ConfigMap 大小的限制，徽标镜像大小必须小于 1 MB。如需更多信息，请参阅文档： https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/customizing-web-console#customizing-web-console

configMap

object

ConfigMap 指定 ConfigMap 源详情，如 ConfigMap 的名称以及文件的密钥。ConfigMap 必须存在于 openshift-config 命名空间中。from 为 "ConfigMap" 时需要，否则禁止。

from

string

from 是必填字段，用于指定文件引用的源类型。允许的值是 ConfigMap。当设置为 ConfigMap 时，该文件将从 openshift-config 命名空间中的 ConfigMap 中获取。当 from 设为 ConfigMap 时，必须设置 configMap 字段。

key

string

键是引用的 ConfigMap 中的 logo 键。只能包含字母数字字符、短划线(-)、下划线(_)和句点(.)。长度最多 253 个字符。必须以有效的文件扩展名结尾。有效的文件扩展名必须包含后跟 2 到 5 alpha 字符的句点。

name

string

name 是 ConfigMap 的名称。name 是一个必填字段。必须包含小写字母数字字符、'-' 或 '.'，且必须以字母数字字符开头和结尾。长度最多 253 个字符。

id

string

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

pinnedResources

数组

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

pinnedResources[]

object

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

可见性

object

可见性定义了视角的状态，以及该视角是否需要访问检查。

group

string

Group 是资源的 API 组。为 core 组输入空字符串。这个值应该只包含小写字母数字字符、连字符和句点。示例： ""、"apps"、"build.openshift.io"等。

resource

string

resource 是被引用的类型。它通常是小写的资源类型的复数形式。这个值应该只包含小写字母数字字符和连字符。示例："deployments", "deploymentconfigs", "pods" 等。

version

string

version 是资源的 API 版本。这个值应该只包含小写字母数字字符。示例："v1", "v1beta1", 等。

accessReview

object

accessReview 定义 required 和 missing access review 检查。

state

string

State 定义透视图为 enabled 或 disabled 或 access review check。

missing

数组

missing 定义权限检查列表。只有在至少有一个检查失败时，才会显示视角。省略时，会跳过访问审核，并且不会显示视角，除非需要根据所需访问查看列表的配置进行配置。

missing[]

object

ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性

required

数组

必需定义权限检查列表。只有在所有检查都成功时才会显示视角。省略时，会跳过访问审核，并且不会显示视角，除非需要根据缺少访问查看列表的配置进行配置。

required[]

object

ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性

fieldSelector

object

fieldSelector 描述了基于字段的访问的限制。它只能限制访问，不能广泛地访问。

此字段是 alpha-level。要使用此字段，您必须启用 AuthorizeWithSelectors 功能门（默认为禁用）。

group

字符串

Group 是 Resource 的 API 组。"*"代表所有。

labelSelector

object

labelSelector 描述了基于标签的访问的限制。它只能限制访问，不能广泛地访问。

此字段是 alpha-level。要使用此字段，您必须启用 AuthorizeWithSelectors 功能门（默认为禁用）。

name

字符串

Name 是为"get"请求的资源的名称，或删除"delete"。"" （空）表示全部。

namespace

字符串

namespace 是所请求操作的命名空间。目前，对于集群范围的资源 "" (empty)，没有命名空间和所有命名空间"" （空）之间的差别，对于集群范围的资源 "" （空）代表"all"表示来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源

resource

字符串

资源是现有资源类型之一。"*"表示全部。

subresource

字符串

子资源是现有资源类型之一。""表示 none。

verb

字符串

verb 是一个 kubernetes 资源 API 动词，如： get, list, watch, create, update, delete, proxy. "*" 表示所有。

version

字符串

version 是资源的 API 版本。"*"表示所有。

rawSelector

string

rawSelector 是字段选择器的序列化，它将包含在查询参数中。我们鼓励 webhook 实现忽略 rawSelector。kube-apiserver 的 *SubjectAccessReview 将解析 rawSelector，只要不存在要求。

要求

数组

要求是字段选择器的解析解释。必须满足所有要求，资源实例才能与选择器匹配。Webhook 实现应该处理要求，但如何处理它们，但只能处理它们。由于要求只能限制请求，因此如果无法理解要求，则可以安全地授权为无限请求。

requirements[]

object

FieldSelectorRequirement 是一个选择器，其中包含与键和值相关的值、键和值。

key

string

key 是要求应用到的字段选择器键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。运算符列表可能会在未来增长。

values

数组（字符串）

值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。

rawSelector

string

rawSelector 是字段选择器的序列化，它将包含在查询参数中。我们鼓励 webhook 实现忽略 rawSelector。kube-apiserver 的 *SubjectAccessReview 将解析 rawSelector，只要不存在要求。

要求

数组

要求是标签选择器的解析解释。必须满足所有要求，资源实例才能与选择器匹配。Webhook 实现应该处理要求，但如何处理它们，但只能处理它们。由于要求只能限制请求，因此如果无法理解要求，则可以安全地授权为无限请求。

requirements[]

object

标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

值

数组（字符串）

值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。

fieldSelector

object

fieldSelector 描述了基于字段的访问的限制。它只能限制访问，不能广泛地访问。

此字段是 alpha-level。要使用此字段，您必须启用 AuthorizeWithSelectors 功能门（默认为禁用）。

group

字符串

Group 是 Resource 的 API 组。"*"代表所有。

labelSelector

object

labelSelector 描述了基于标签的访问的限制。它只能限制访问，不能广泛地访问。

此字段是 alpha-level。要使用此字段，您必须启用 AuthorizeWithSelectors 功能门（默认为禁用）。

name

字符串

Name 是为"get"请求的资源的名称，或删除"delete"。"" （空）表示全部。

namespace

字符串

namespace 是所请求操作的命名空间。目前，对于集群范围的资源 "" (empty)，没有命名空间和所有命名空间"" （空）之间的差别，对于集群范围的资源 "" （空）代表"all"表示来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源

resource

字符串

资源是现有资源类型之一。"*"表示全部。

subresource

字符串

子资源是现有资源类型之一。""表示 none。

verb

字符串

verb 是一个 kubernetes 资源 API 动词，如： get, list, watch, create, update, delete, proxy. "*" 表示所有。

version

字符串

version 是资源的 API 版本。"*"表示所有。

rawSelector

string

rawSelector 是字段选择器的序列化，它将包含在查询参数中。我们鼓励 webhook 实现忽略 rawSelector。kube-apiserver 的 *SubjectAccessReview 将解析 rawSelector，只要不存在要求。

要求

数组

要求是字段选择器的解析解释。必须满足所有要求，资源实例才能与选择器匹配。Webhook 实现应该处理要求，但如何处理它们，但只能处理它们。由于要求只能限制请求，因此如果无法理解要求，则可以安全地授权为无限请求。

requirements[]

object

FieldSelectorRequirement 是一个选择器，其中包含与键和值相关的值、键和值。

key

string

key 是要求应用到的字段选择器键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。运算符列表可能会在未来增长。

values

数组（字符串）

值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。

rawSelector

string

rawSelector 是字段选择器的序列化，它将包含在查询参数中。我们鼓励 webhook 实现忽略 rawSelector。kube-apiserver 的 *SubjectAccessReview 将解析 rawSelector，只要不存在要求。

要求

数组

要求是标签选择器的解析解释。必须满足所有要求，资源实例才能与选择器匹配。Webhook 实现应该处理要求，但如何处理它们，但只能处理它们。由于要求只能限制请求，因此如果无法理解要求，则可以安全地授权为无限请求。

requirements[]

object

标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

值

数组（字符串）

值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。

availableClusterRoles

数组（字符串）

availableClusterRoles 是 ClusterRole 名称列表，可通过项目访问标签页分配给用户。

disabled

数组（字符串）

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

clientDownloadsURL

string

clientDownloadsURL 是一个 URL，用作下载客户端二进制文件的地址。如果没有指定，则使用下载路由主机名。没有入口(ingress)功能的集群需要此字段，因为无法访问路由。控制台 Operator 将监控 URL，并在延长期间无法访问时可能会降级。必须使用 HTTPS 方案。

consoleURL

string

consoleURL 是用作基本控制台地址的 URL。如果没有指定，则使用控制台路由主机名。没有入口(ingress)功能的集群需要此字段，因为无法访问路由。确保在这个 URL 中设置适当的入口。控制台 Operator 将监控 URL，并在延长期间无法访问时可能会降级。必须使用 HTTPS 方案。

状态页面

对象

状态页面包含 statuspage.io 页面的 ID，其中提供了状态信息。

pageID

字符串

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

hostname

字符串

hostname 是所需的自定义域，控制台将在其中可用。

secret

对象

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

name

字符串

name 是引用的 secret 的 metadata.name

conditions

array

conditions 是条件及其状态列表

conditions[]

对象

OperatorCondition 只是标准条件字段。

generations

array

生成用于确定项目是否需要协调或更改是否需要反应。

generations[]

对象

GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。

latestAvailableRevision

整数

latestAvailableRevision 是最新部署的 deploymentID

observedGeneration

整数

observedGeneration 是您处理的最后生成更改

readyReplicas

整数

readyReplicas 表示有多少副本就绪并处于所需的状态

version

字符串

版本是此可用性适用的级别

lastTransitionTime

字符串

lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。

message

字符串

reason

字符串

status

字符串

条件的状态，True, False, Unknown 之一。

type

字符串

CamelCase 或 foo.example.com/CamelCase 中的条件类型。

group

字符串

组是您要跟踪的内容组

hash

字符串

hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps

lastGeneration

整数

lastGeneration 是涉及的工作负载控制器的最后生成

name

字符串

name 是您要跟踪的内容的名称

namespace

字符串

命名空间(namespace)是您要跟踪的事情

resource

字符串

资源是您要跟踪的资源类型