Web 控制台

流程

1. 在 openshift-config 命名空间中将您的徽标文件导入到配置映射中：

   $ oc create configmap console-custom-logo --from-file /path/to/console-custom-logo.png -n openshift-config

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: console-custom-logo
     namespace: openshift-config
   data:
     console-custom-logo.png: <base64-encoded_logo> ... 1

   1

   提供有效的 base64 编码徽标。

2. 编辑 web 控制台的 Operator 配置使其包含 customLogoFile 和 customProductName：

   $ oc edit consoles.operator.openshift.io cluster

   apiVersion: operator.openshift.io/v1
   kind: Console
   metadata:
     name: cluster
   spec:
     customization:
       customLogoFile:
         key: console-custom-logo.png
         name: console-custom-logo
       customProductName: My Console

   更新 Operator 配置后，它将会把自定义的 logo 配置映射同步到控制台命名空间中，并将其挂载到 console pod 并重新部署。

3. 检查操作是否成功。如果有任何问题，控制台集群 Operator 将报告 Degraded 状态，控制台 Operator 配置也会报告 CustomLogoDegraded 状态，但状态类似于 KeyOrFilenameInvalid 或 NoImageProvided。

   运行以下命令检查 clusteroperator：

   $ oc get clusteroperator console -o yaml

   运行以下命令检查 console Operator 配置：

   $ oc get consoles.operator.openshift.io -o yaml

流程

1. 在 Administration → Custom Resource Definitions 中点 ConsoleLink。
2. 选择 Instances 标签

3. 点击 Create Console Link 并编辑文件：

   apiVersion: console.openshift.io/v1
   kind: ConsoleLink
   metadata:
     name: example
   spec:
     href: 'https://www.example.com'
     location: HelpMenu 1
     text: Link 1

   1

   有效的位置设置为 HelpMenu、UserMenu、ApplicationMenu 和 NamespaceDashboard。

   要使自定义链接出现在所有命名空间中，请按照以下示例操作：

   apiVersion: console.openshift.io/v1
   kind: ConsoleLink
   metadata:
     name: namespaced-dashboard-link-for-all-namespaces
   spec:
     href: 'https://www.example.com'
     location: NamespaceDashboard
     text: This appears in all namespaces

   要使自定义链接只出现在某些命名空间中，请按照以下示例操作：

   apiVersion: console.openshift.io/v1
   kind: ConsoleLink
   metadata:
     name: namespaced-dashboard-for-some-namespaces
   spec:
     href: 'https://www.example.com'
     location: NamespaceDashboard
     # This text will appear in a box called "Launcher" under "namespace" or "project" in the web console
     text: Custom Link Text
     namespaceDashboard:
       namespaces:
       # for these specific namespaces
       - my-namespace
       - your-namespace
       - other-namespace

   要使自定义链接出现在应用程序菜单中，请按照以下示例操作：

   apiVersion: console.openshift.io/v1
   kind: ConsoleLink
   metadata:
     name: application-menu-link-1
   spec:
     href: 'https://www.example.com'
     location: ApplicationMenu
     text: Link 1
     applicationMenu:
       section: My New Section
       # image that is 24x24 in size
       imageURL: https://via.placeholder.com/24

4. 点击 Save 以应用您的更改。

流程

1. 在 consoles.operator.openshift.io 自定义资源中修改安装过程中默认创建的集群实例：

   $ oc patch consoles.operator.openshift.io cluster --patch '{"spec":{"route":{"hostname":"console.example.com"}}}' --type=merge

   apiVersion: operator.openshift.io/v1
   kind: Console
   metadata:
     name: cluster
   spec:
     route:
       hostname: 'console.example.com'

2. 如果指定自定义证书，则必须在 openshift-config 命名空间中创建具有密钥和证书的 secret。例如：

   $ oc create secret tls console-tls --key=key.pem --cert=cert.pem -n openshift-config

   apiVersion: v1
   kind: Secret
   metadata:
     name: console-tls
     namespace: openshift-config
   type: kubernetes.io/tls
   data:
     tls.crt: >-
           <base64-encoded_cert> ... 1
     tls.key: >-
           <base64-encoded_key> ... 2

   1

   提供有效的 TLS 证书。

   2

   提供有效的 TLS 密钥。

   然后，编辑 Web 控制台的 Operator 配置：

   $ oc edit consoles.operator.openshift.io cluster

   在配置资源中添加以下小节：

   spec:
     route:
       hostname: console.example.com
       secret:
         name: console-tls

流程

1. 运行以下命令来创建您可以修改的模板：

   $ oc adm create-login-template > login.html

   $ oc adm create-provider-selection-template > providers.html

   $ oc adm create-error-template > errors.html

2. 创建 secret:

   $ oc create secret generic login-template --from-file=login.html -n openshift-config

   $ oc create secret generic providers-template --from-file=providers.html -n openshift-config

   $ oc create secret generic error-template --from-file=errors.html -n openshift-config

3. 运行：

   $ oc edit oauths cluster

4. 更新规格：

   spec:
     templates:
       error:
           name: error-template
       login:
           name: login-template
       providerSelection:
           name: providers-template

   运行 oc explain oauths.spec.templates 以了解选项。

流程

1. 在 Administration → Custom Resource Definitions 中点 ConsoleExternalLogLink。
2. 选择 Instances 标签

3. 点击 Create Console External Log Link 并编辑文件：

   apiVersion: console.openshift.io/v1
   kind: ConsoleExternalLogLink
   metadata:
     name: example
   spec:
     hrefTemplate: >-
       https://example.com/logs?resourceName=${resourceName}&containerName=${containerName}&resourceNamespace=${resourceNamespace}&podLabels=${podLabels}
     text: Example Logs

流程

1. 在 Administration → Custom Resource Definitions 中点 ConsoleNotification。
2. 选择 Instances 标签

3. 点击 Create Console Notification 并编辑文件：

   apiVersion: console.openshift.io/v1
   kind: ConsoleNotification
   metadata:
     name: example
   spec:
     text: This is an example notification message with an optional link.
     location: BannerTop 1
     link:
       href: 'https://www.example.com'
       text: Optional link text
     color: '#fff'
     backgroundColor: '#0088ce'

   1

   有效的位置设置为 BannerTop、BannerBottom 和 BannerTopBottom。

4. 点 Create 以应用您的更改。

流程

1. 进入 Administration → Custom Resource Definitions。
2. 从 Custom Resource Definitions (CRDs) 列表中选 ConsoleCLIDownload 。

3. 点 YAML 标签页，然后进行编辑：

   apiVersion: console.openshift.io/v1
   kind: ConsoleCLIDownload
   metadata:
     name: example-cli-download-links-for-foo
   spec:
     description: |
       This is an example of download links for foo
     displayName: example-foo
     links:
     - href: 'https://www.example.com/public/foo.tar'
       text: foo for linux
     - href: 'https://www.example.com/public/foo.mac.zip'
       text: foo for mac
     - href: 'https://www.example.com/public/foo.win.zip'
       text: foo for windows

4. 点 Save 按钮。

流程

1. 在 Administration → Custom Resource Definitions 中点 ConsoleYAMLSample。

2. 点 YAML 并编辑该文件：

   apiVersion: console.openshift.io/v1
   kind: ConsoleYAMLSample
   metadata:
     name: example
   spec:
     targetResource:
       apiVersion: batch/v1
       kind: Job
     title: Example Job
     description: An example Job YAML sample
     yaml: |
       apiVersion: batch/v1
       kind: Job
       metadata:
         name: countdown
       spec:
         template:
           metadata:
             name: countdown
           spec:
             containers:
             - name: counter
               image: centos:7
               command:
               - "bin/bash"
               - "-c"
               - "for i in 9 8 7 6 5 4 3 2 1 ; do echo $i ; done"
             restartPolicy: Never

   使用 spec.snippet 表示 YAML 样本不是完整的 YAML 资源定义，而是可在用户光标处的现有 YAML 文档中插入的片段。

3. 点击 Save。

流程

1. 在 Web 控制台的 Administrator 视角中，导航到 Operators → OperatorHub。
2. 使用 Filter by keyword 复选框在目录中搜索 Web Terminal Operator，然后点击 Web Terminal 标题。
3. 参阅 Web Terminal 页面中有关 Operator 的简单描述，然后点击 Install。

4. 在 Install Operator 页面中，保留所有字段的默认值。

   • Update Channel 菜单中的 alpha 选项启用 Web Terminal Operator 最新版本的安装。
   • Installation Mode 菜单中的 All namespaces on the cluster 选项可让 Operator 监视并可供集群中的所有命名空间使用。
   • Installed Namespace 菜单中的 openshift-operators 选项会在默认的 openshift-operators 命名空间中安装 Operator。
   • Approval Strategy 菜单中的 Automatic 选项确保以后对 Operator 的升级由 Operator Lifecycle Manager 自动处理。
5. 点击 Install。
6. 在 Installed Operators 页面中，点 View operator 来验证 Installed Operators 页中列出的 Operator。
7. 安装 Operator 后，刷新页面以查看控制台右上角的命令行终端图标。

1. 要启动 web 终端，请点击控制台右上角的命令行终端图标( )。在 Command line terminal 窗格中会显示 web 终端实例。此实例使用您的凭证自动登录。

2. 从 Project 下拉列表中选择创建 DevWorkspace CR 的 项目。默认情况下会选择当前项目。

   注意
   • 只有在不存在 DevWorkspace CR 时才会创建 DevWorkspace CR。
   • openshift-terminal 项目是集群管理员使用的默认项目。它们没有选择其他项目的选项。
3. 点 Start 使用所选项目初始化 Web 终端。

1. 删除安装 Operator 时添加的组件和自定义资源（CR）。
2. 卸载 Web Terminal Operator。

1. 在 Administrator 或 Developer 视角中，点击 Help 图标并选择 Quick Starts。
2. 点快速启动卡。
3. 在出现的面板中点 Start。
4. 完成屏幕的说明，然后点 Next。

5. 在出现 Check your work 模块时，回答问题以确认您成功完成了该任务。

   1. 如果您选择 Yes，点 Next 来继续到下一个任务。
   2. 如果您选择 No，重复任务说明并再次检查您的工作。
6. 重复以上第 1 到 6 步，以便快速完成剩余的任务。
7. 完成最后的任务后，点 Close 关闭快速启动。

流程

1. 要创建新快速启动，请运行：

   $ oc get -o yaml consolequickstart spring-with-s2i > my-quick-start.yaml

2. 运行：

   $ oc create -f my-quick-start.yaml

3. 根据本文档中介绍的指南更新 YAML 文件。
4. 保存您的编辑。