第6章 OpenShift Container Platform の Web コンソールのカスタマイズ
OpenShift Container Platform の Web コンソールをカスタマイズして、カスタムロゴ、製品名、リンク、通知、およびコマンドラインのダウンロードを設定できます。これは、Web コンソールを企業や政府の特定要件を満たすように調整する必要がある場合にとくに役立ちます。
6.1. カスタムロゴおよび製品名の追加 リンクのコピーリンクがクリップボードにコピーされました!
カスタムロゴまたはカスタム製品名を追加することで、カスタムブランディングを作成できます。これらの設定は相互に独立しているため、両方またはいずれかを設定できます。
前提条件
- 管理者権限を持っている。
-
使用するロゴのファイルを作成します。ロゴは、GIF、JPG、PNG、または SVG を含む共通のイメージ形式のファイルであり、
60pxのmax-heightに制限されます。ConfigMapオブジェクトサイズの制約により、イメージサイズは 1 MB を超えてはなりません。
手順
ロゴファイルを
openshift-confignamespace の config map にインポートします。$ oc create configmap console-custom-logo --from-file /path/to/console-custom-logo.png -n openshift-configヒントまたは、以下の YAML を適用して config map を作成できます。
apiVersion: v1 kind: ConfigMap metadata: name: console-custom-logo namespace: openshift-config binaryData: console-custom-logo.png: <base64-encoded_logo> ...<base64-encoded_logo>をロゴの base64 エンコードされた文字列に置き換えます。Web コンソールの Operator 設定を編集して、
customLogoFileおよびcustomProductNameを組み込みます。$ oc edit consoles.operator.openshift.io clusterapiVersion: operator.openshift.io/v1 kind: Console metadata: name: cluster spec: customization: customLogoFile: key: console-custom-logo.png name: console-custom-logo customProductName: My ConsoleOperator 設定が更新されると、カスタムロゴ config map をコンソール namespace に同期し、これをコンソール Pod にマウントし、再デプロイします。
正常に実行されたかどうかを確認します。何らかの問題が発生した場合、コンソールクラスター Operator は
Degradedステータスを報告し、コンソール Operator 設定もKeyOrFilenameInvalidまたはNoImageProvidedなどの理由とともにCustomLogoDegradedステータスを報告します。clusteroperatorを確認するには、以下を実行します。$ oc get clusteroperator console -o yamlコンソール Operator 設定を確認するには、以下を実行します。
$ oc get consoles.operator.openshift.io -o yaml
6.2. Web コンソールでのカスタムリンクの作成 リンクのコピーリンクがクリップボードにコピーされました!
ConsoleLink カスタムリソースを作成して、Web コンソールのヘルプメニュー、ユーザーメニュー、アプリケーションメニュー、または namespace ダッシュボードへのリンクを追加できます。
前提条件
- 管理者権限を持っている。
手順
-
Administration
Custom Resource Definitions から、ConsoleLink をクリックします。 - Instances タブを選択します。
Create Console Link をクリックし、ファイルを編集します。
apiVersion: console.openshift.io/v1 kind: ConsoleLink metadata: name: example spec: href: 'https://www.example.com' location: HelpMenu text: Link 1場所フィールドでは、HelpMenu、UserMenu、ApplicationMenu、またはNamespaceDashboardを使用できます。カスタムリンクがすべての namespace に表示されるようにするには、以下の例に従います。
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カスタムリンクが一部の namespace のみに表示されるようにするには、以下の例に従います。
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- Save をクリックして変更を適用します。
6.3. コンソールおよびダウンロードルートのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
ingress 設定ルート設定 API を使用して コンソール をカスタマイズし、ルートを ダウンロード できます。この API を使用すると、両方のルートでルート設定を一元化され、非推奨の console-operator 設定メソッドよりも優先されます。
console カスタムルートが ingress 設定と console-operator 設定の両方で設定されている場合は、入力 設定のカスタムルート設定が優先されます。console-operator 設定を使用したカスタムルートの設定は非推奨です。
6.4. コンソールルートのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
クラスター Ingress 設定の spec.componentRoutes フィールドにカスタムホスト名および TLS 証明書を設定して、コンソールルートをカスタマイズできます。
前提条件
- 管理者権限のあるユーザーでクラスターにログインしている。
openshift-confignamespace に TLS 証明書およびキーを含めたシークレットを作成している。これは、カスタムホスト名の接尾辞のドメインがクラスターのドメイン接尾辞に一致しない場合に必要です。接尾辞が一致する場合には、シークレットはオプションです。ヒントoc create secret tlsコマンドを使用して TLS シークレットを作成できます。
手順
クラスター
Ingress設定を編集します。$ oc edit ingress.config.openshift.io clusterカスタムのホスト名を設定し、オプションで提供する証明書とキーを設定します。
apiVersion: config.openshift.io/v1 kind: Ingress metadata: name: cluster spec: componentRoutes: - name: console namespace: openshift-console hostname: <custom_hostname> servingCertKeyPairSecret: name: <secret_name>hostnameフィールドはカスタムホスト名を指定します。servingCertKeyPairSecret.nameフィールドは、TLS 証明書(tls.crt)およびキー(tls.key)を含むopenshift-confignamespace のシークレットを参照します。これは、カスタムホスト名の接尾辞のドメインがクラスターのドメイン接尾辞に一致しない場合に必要です。接尾辞が一致する場合には、シークレットはオプションです。変更を適用するためにファイルを保存します。
注記アプリケーション Ingress ロードバランサーを指すカスタムコンソールルートの DNS レコードを追加します。
6.5. ダウンロードルートをカスタマイズする リンクのコピーリンクがクリップボードにコピーされました!
クラスター Ingress 設定の spec.componentRoutes フィールドにカスタムホスト名および TLS 証明書を設定して、ダウンロードルートをカスタマイズできます。
前提条件
- 管理者権限のあるユーザーでクラスターにログインしている。
openshift-confignamespace に TLS 証明書およびキーを含めたシークレットを作成している。これは、カスタムホスト名の接尾辞のドメインがクラスターのドメイン接尾辞に一致しない場合に必要です。接尾辞が一致する場合には、シークレットはオプションです。ヒントoc create secret tlsコマンドを使用して TLS シークレットを作成できます。
手順
クラスター
Ingress設定を編集します。$ oc edit ingress.config.openshift.io clusterカスタムのホスト名を設定し、オプションで提供する証明書とキーを設定します。
apiVersion: config.openshift.io/v1 kind: Ingress metadata: name: cluster spec: componentRoutes: - name: downloads namespace: openshift-console hostname: <custom_hostname> servingCertKeyPairSecret: name: <secret_name>hostnameフィールドはカスタムホスト名を指定します。servingCertKeyPairSecret.nameフィールドは、TLS 証明書(tls.crt)およびキー(tls.key)を含むopenshift-confignamespace のシークレットを参照します。これは、カスタムホスト名の接尾辞のドメインがクラスターのドメイン接尾辞に一致しない場合に必要です。接尾辞が一致する場合には、シークレットはオプションです。変更を適用するためにファイルを保存します。
注記アプリケーション Ingress ロードバランサーを指すカスタムダウンロードルートの DNS レコードを追加します。
6.6. ログインページのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
ログインページをカスタマイズして、サービス利用規約情報を表示したり、サードパーティーのログインプロバイダーにカスタムブランディングを適用したりできます。
カスタムログインページは、GitHub や Google などのサードパーティーログインプロバイダーを使用している場合にも、ユーザーが信頼し、予想できるブランドのページを提示して、その後にユーザーを認証プロバイダーにリダイレクトする際に役立ちます。また、認証プロセス中にカスタムエラーページをレンダリングすることもできます。
エラーテンプレートのカスタマイズは、要求ヘッダーや OIDC ベースの IDP などのリダイレクトを使用するアイデンティティープロバイダー (IDP) に限定されます。LDAP や htpasswd などのダイレクトパスワード認証を使用する IDP にはこれによる影響がありません。
前提条件
- 管理者権限を持っている。
手順
以下のコマンドを実行して、変更可能なテンプレートを作成します。
$ oc adm create-login-template > login.html$ oc adm create-provider-selection-template > providers.html$ oc adm create-error-template > errors.htmlシークレットを作成します。
$ 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以下を実行します。
$ oc edit oauths cluster仕様を更新します。
apiVersion: config.openshift.io/v1 kind: OAuth metadata: name: cluster # ... spec: templates: error: name: error-template login: name: login-template providerSelection: name: providers-templateoc explain oauths.spec.templatesを実行して、オプションを把握します。
6.7. 外部ログリンクのテンプレートを定義する リンクのコピーリンクがクリップボードにコピーされました!
ログの参照に役立つサービスに接続しているものの、特定の方法で URL を生成する必要がある場合は、リンクのテンプレートを定義できます。
前提条件
- 管理者権限を持っている。
手順
-
Administration
Custom Resource Definitions から、ConsoleExternalLogLink をクリックします。 - Instances タブを選択します。
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
6.8. カスタム通知バナーの作成 リンクのコピーリンクがクリップボードにコピーされました!
ConsoleNotification カスタムリソースを作成すると、Web コンソールの各ページの上部または下部にバナーを表示できます。
前提条件
- 管理者権限を持っている。
手順
-
Administration
Custom Resource Definitions から、ConsoleNotification をクリックします。 - Instances タブを選択します。
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 link: href: 'https://www.example.com' text: Optional link text color: '#fff' backgroundColor: '#0088ce'locationフィールドには、BannerTop、BannerBottom、またはBannerTopBottomを受け入れます。- Create をクリックして変更を適用します。
6.9. CLI ダウンロードのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
ファイルパッケージを直接ポイントしたり、パッケージを提供する外部ページをポイントできるカスタムのリンクテキストおよび URL を使用して、CLI をダウンロードするリンクを設定できます。
前提条件
- 管理者権限を持っている。
手順
-
Administration
Custom Resource Definitions に移動します。 - カスタムリソース定義 (CRD) のリストから ConsoleCLIDownload を選択します。
YAML タブをクリックし、編集を行います。
apiVersion: console.openshift.io/v1 kind: ConsoleCLIDownload metadata: name: example-cli-download-links spec: description: | This is an example of download links displayName: example links: - href: 'https://www.example.com/public/example.tar' text: example for linux - href: 'https://www.example.com/public/example.mac.zip' text: example for mac - href: 'https://www.example.com/public/example.win.zip' text: example for windows- Save ボタンをクリックします。
6.10. YAML サンプルの Kubernetes リソースへの追加 リンクのコピーリンクがクリップボードにコピーされました!
YAML サンプルはいつでも Kubernetes リソースに動的に追加できます。
前提条件
- クラスター管理者の権限があること。
手順
-
Administration
Custom Resource Definitions から、ConsoleYAMLSample をクリックします。 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: Neverspec.snippetを使用して、YAML サンプルが完全な YAML リソース定義ではなく、ユーザーのカーソルで既存の YAML ドキュメントに挿入できる断片を示します。- Save をクリックします。
6.11. ユーザーパースペクティブのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
クラスター管理者は、すべてのユーザーまたは特定のユーザーロールの Web コンソールパースペクティブを表示または非表示にして、ユーザーにロールおよびタスクに関連するパースペクティブのみが表示されるようにすることができます。たとえば、管理者アクセス権を持たないユーザーを、Administrator パースペクティブから非表示にすることができます。
ロールベースのアクセス制御 (RBAC) に基づいて、ユーザーのパースペクティブの表示をカスタマイズすることもできます。たとえば、特定の権限を必要とする監視目的でパースペクティブをカスタマイズする場合、パースペクティブが必要な権限を持つユーザーにのみ表示されるように定義できます。
各パースペクティブには、YAML ビューで編集できる次の必須パラメーターが含まれています。
-
id: 表示または非表示にするパースペクティブの ID を定義します -
visibility: パースペクティブの状態と、必要に応じてアクセスレビューチェックを定義します。 -
state: パースペクティブが有効か、無効か、アクセスレビューチェックが必要かを定義します
デフォルトでは、すべてのパースペクティブが有効になっています。ユーザーパースペクティブをカスタマイズすると、その変更はクラスター全体に適用されます。
6.11.1. YAML ビューを使用してパースペクティブをカスタマイズする リンクのコピーリンクがクリップボードにコピーされました!
コンソールリソースの YAML コンテンツを編集することで、パースペクティブをカスタマイズできます。
前提条件
- 管理者権限を持っている。
手順
-
Administrator パースペクティブで、Administration
Cluster Settings に移動します。 - Configuration タブを選択し、Console (operator.openshift.io) リソースをクリックします。
YAML タブをクリックして、カスタマイズを行います。
パースペクティブを有効または無効にするには、Add user perspectives のスニペットを挿入し、必要に応じて YAML コードを編集します。
apiVersion: operator.openshift.io/v1 kind: Console metadata: name: cluster spec: customization: perspectives: - id: admin visibility: state: Enabled - id: dev visibility: state: EnabledRBAC 権限に基づいてパースペクティブを非表示にするには、ユーザーパースペクティブを非表示 にするためのスニペットを挿入し、必要に応じて YAML コードを編集します。
apiVersion: operator.openshift.io/v1 kind: Console metadata: name: cluster spec: customization: perspectives: - id: admin requiresAccessReview: - group: rbac.authorization.k8s.io resource: clusterroles verb: list - id: dev state: Enabledニーズに基づいてパースペクティブをカスタマイズするには、独自の YAML スニペットを作成します。
apiVersion: operator.openshift.io/v1 kind: Console metadata: name: cluster spec: customization: perspectives: - id: admin visibility: state: AccessReview accessReview: missing: - resource: deployment verb: list required: - resource: namespaces verb: list - id: dev visibility: state: Enabled
- Save をクリックします。
6.11.2. フォームビューを使用してパースペクティブをカスタマイズする リンクのコピーリンクがクリップボードにコピーされました!
コンソールリソースのフォームビューを使用して、パースペクティブをカスタマイズできます。
前提条件
- 管理者権限を持っている。
手順
-
Administrator パースペクティブで、Administration
Cluster Settings に移動します。 - Configuration タブを選択し、Console (operator.openshift.io) リソースをクリックします。
-
ページの右側にある Actions
Customize をクリックします。 General 設定で、ドロップダウンリストから次のいずれかのオプションを選択して、パースペクティブをカスタマイズします。
- Enabled: すべてのユーザーに対してパースペクティブを有効にします
- Only visible for privileged users: すべての namespace を一覧表示できるユーザーのパースペクティブを有効にします。
- Only visible for unprivileged users: すべての namespace を一覧表示できないユーザーのパースペクティブを有効にします。
Disabled: すべてのユーザーに対してパースペクティブを無効にします
変更が保存されたことを確認する通知が開きます。
注記ユーザーパースペクティブをカスタマイズすると、変更は自動的に保存され、ブラウザーの更新後に有効になります。
6.12. 開発者カタログとサブカタログのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
クラスター管理者は、Developer カタログまたはそのサブカタログを編成および管理できます。サブカタログタイプを有効または無効にするか、開発者カタログ全体を無効にすることができます。
developerCatalog.types オブジェクトには、YAML ビューで使用するためにスニペットで定義する必要がある次のパラメーターが含まれています。
-
state: 開発者カタログタイプのリストを有効にするか無効にするかを定義します。 -
enabled: ユーザーに表示される開発者カタログタイプ (サブカタログ) のリストを定義します。 -
disabled: ユーザーに表示されない開発者カタログタイプ (サブカタログ) のリストを定義します。
YAML ビューまたはフォームビューを使用して、次の開発者カタログタイプ (サブカタログ) を有効または無効にすることができます。
-
Builder Images -
Templates -
Devfiles -
Samples -
Helm Charts -
Event Sources -
Event Sinks -
Operator Backed
6.12.1. YAML ビューを使用して、開発者カタログまたはそのサブカタログをカスタマイズする リンクのコピーリンクがクリップボードにコピーされました!
YAML ビューで YAML コンテンツを編集することにより、開発者カタログをカスタマイズできます。
前提条件
- クラスター管理者権限を持つ OpenShift Web コンソールセッション。
手順
-
Web コンソールの Administrator パースペクティブで、Administration
Cluster Settings に移動します。 - Configuration タブを選択し、Console (operator.openshift.io) リソースをクリックして、Details ページを表示します。
YAML タブをクリックしてエディターを開き、必要に応じて YAML コンテンツを編集します。
たとえば、開発者カタログタイプを無効にするには、無効な開発者カタログリソースのリストを定義する次のスニペットを挿入します。
apiVersion: operator.openshift.io/v1 kind: Console metadata: name: cluster ... spec: customization: developerCatalog: categories: types: state: Disabled disabled: - BuilderImage - Devfile - HelmChart ...Save をクリックします。
注記デフォルトでは、Web コンソールの管理者ビューで開発者カタログタイプが有効になっています。
6.12.1.1. YAML ファイルの変更例 リンクのコピーリンクがクリップボードにコピーされました!
YAML エディターで YAML コンテンツを動的に編集することで、開発者カタログをカスタマイズできます。
次のスニペットを使用して、状態 タイプを Enabled に設定してすべてのサブカタログを表示します。
apiVersion: operator.openshift.io/v1
kind: Console
metadata:
name: cluster
...
spec:
customization:
developerCatalog:
categories:
types:
state: Enabled
次のスニペットを使用して、状態 タイプを Disabled に設定してすべてのサブカタログを無効にします。
apiVersion: operator.openshift.io/v1
kind: Console
metadata:
name: cluster
...
spec:
customization:
developerCatalog:
categories:
types:
state: Disabled
クラスター管理者が、Web コンソールで有効になっているサブカタログのリストを定義する場合は、次のスニペットを使用します。
apiVersion: operator.openshift.io/v1
kind: Console
metadata:
name: cluster
...
spec:
customization:
developerCatalog:
categories:
types:
state: Enabled
enabled:
- BuilderImage
- Devfile
- HelmChart
- ...
6.12.2. フォームビューを使用した開発者カタログまたはそのサブカタログのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
Web コンソールのフォームビューを使用して、開発者カタログをカスタマイズできます。
前提条件
- クラスター管理者権限を持つ OpenShift Web コンソールセッション。
- Developer パースペクティブが有効になっている。
手順
-
Administrator パースペクティブで、Administration
Cluster Settings に移動します。 - Configuration タブを選択し、Console (operator.openshift.io) リソースをクリックします。
-
Actions
Customize をクリックします。 Pre-pinned navigation items、Add page、および Developer Catalog セクションの項目を有効または無効にします。
検証
開発者カタログをカスタマイズすると、変更内容がシステムに自動的に保存され、更新後にブラウザーで有効になります。
管理者は、すべてのユーザーに対してデフォルトで表示されるナビゲーション項目を定義できます。ナビゲーション項目を並べ替えることもできます。
同様の手順を使用して、クイックスタート、クラスターロール、アクションなどの Web UI 項目をカスタマイズできます。