手順

1. パースペクティブスイッチャーを使用して、Administrator パースペクティブまたは Developer パースペクティブに切り替えます。
2. Project ドロップダウンリストから既存のプロジェクトを選択します。このドロップダウンから新しいプロジェクトを作成することもできます。

手順

1. ログイン認証情報を使用して OpenShift Container Platform Web コンソールにログインします。
2. マストヘッドを使用して、ユーザープロファイルのユーザー名とパスワードにアクセスします。

3. General セクションで、以下を実行します。

   1. perspective フィールドで、ログインするデフォルトのパースペクティブを設定できます。必要に応じて Administrator または Developer パースペクティブを選択できます。パースペクティブが選択されていない場合には、最後にアクセスしたパースペクティブにログインします。
   2. Project フィールドで、作業するプロジェクトを選択します。コンソールは、毎回ログインすると、そのプロジェクトにデフォルト設定されます。
   3. Topology フィールドで、トポロジービューのデフォルトをグラフビューか、一覧ビューに設定できます。選択されていない場合は、コンソールは使用した最後のビューにデフォルト設定されます。
   4. Create/Edit resource method フィールドで、リソースの作成または編集設定を指定できます。フォームおよび YAML オプションの両方が利用可能な場合には、選択した内容にコンソールはデフォルト設定されます。
4. ブラウザーのデフォルトの言語設定を使用するには、言語セクションで、Default browser languageを選択します。それ以外の場合は、コンソールに使用する言語を選択します。

手順

1. Administrator パースペクティブで、Administration → Cluster Settings に移動します。
2. Cluster Settings ページで、Configuration タブをクリックします。

3. Configuration ページで、operator.openshift.io と説明が記載されている Console 設定リソースをクリックします。

   
4. Action ドロップダウンリストから Customize を選択し、Cluster configuration ページを開きます。

5. General タブの Quick starts セクションで、Enabled リストまたは Disabled リストから項目を選択し、矢印ボタンを使用して他方のリストに移動します。

   • 1 つのクイックスタートを有効または無効にするには、該当するクイックスタートをクリックし、一重矢印ボタンを使用してクイックスタートを適切なリストに移動します。
   • 複数のクイックスタートをまとめて有効または無効にするには、Ctrl を押して移動するクイックスタートをクリックします。次に、一重矢印ボタンを使用してクイックスタートを適切なリストに移動します。
   • すべてのクイックスタートをまとめて有効または無効にするには、二重矢印ボタンをクリックして、すべてのクイックスタートを適切なリストに移動します。

手順

1. ロゴファイルを openshift-config namespace の設定マップにインポートします。

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

   ヒント

   または、以下の YAML を適用して設定マップを作成できます。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: console-custom-logo
     namespace: openshift-config
   binaryData:
     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 設定が更新されると、カスタムロゴ設定マップをコンソール namespace に同期し、これをコンソール Pod にマウントし、再デプロイします。

3. 正常に実行されたかどうかを確認します。問題がある場合は、コンソールクラスター Operator は Degraded ステータスを報告し、コンソール Operator 設定も CustomLogoDegraded ステータスを KeyOrFilenameInvalid または NoImageProvided などの理由と共に報告します。

   clusteroperator を確認するには、以下を実行します。

   $ oc get clusteroperator console -o yaml

   コンソール 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 です。

   カスタムリンクがすべての 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

4. Save をクリックして変更を適用します。

手順

1. 以下のコマンドを実行して、変更可能なテンプレートを作成します。

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

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

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

2. シークレットを作成します。

   $ 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. カスタムリソース定義 (CRD) の一覧から 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. 新しいタブで、console-plugin-template リポジトリーを開きます。このリポジトリーには、新しいタブでプラグインを作成するためのテンプレートが含まれています。

   重要

   カスタムプラグインコードは、Red Hat ではサポートされていません。プラグインで利用できるのは、共同コミュニティーのサポート のみです。

2. Use this template → Create new repository をクリックして、テンプレートの GitHub リポジトリーを作成します。
3. プラグインの名前で新しいリポジトリーの名前を変更します。
4. コードを編集できるように、新しいリポジトリーのクローンをローカルマシンに作成します。

5. package.json ファイルを編集して、プラグインのメタデータを consolePlugin 宣言に追加します。以下に例を示します。

   "consolePlugin": {
     "name": "my-plugin", 1
     "version": "0.0.1", 2
     "displayName": "My Plugin", 3
     "description": "Enjoy this shiny, new console plugin!", 4
     "exposedModules": {
       "ExamplePage": "./components/ExamplePage"
     },
     "dependencies": {
       "@console/pluginAPI": "/*"
     }
   }

   1

   プラグインの名前を更新します。

   2

   バージョンを更新します。

   3

   プラグインの表示名を更新します。

   4

   プラグインの概要を使用して、説明を更新します。

6. console-extensions.json ファイルに以下を追加します。

   {
     "type": "console.tab/horizontalNav",
     "properties": {
       "page": {
         "name": "Example Tab",
         "href": "example"
       },
       "model": {
         "group": "core",
         "version": "v1",
         "kind": "Pod"
       },
       "component": { "$codeRef": "ExampleTab" }
     }
   }

7. package.json ファイルを編集して以下の変更を追加します。

           "exposedModules": {
               "ExamplePage": "./components/ExamplePage",
               "ExampleTab": "./components/ExampleTab"
           }

8. 新しいファイル src/components/ExampleTab.tsx を作成し、以下のスクリプトを追加することで、Pod ページの新規カスタムタブに表示されるメッセージを作成します。

   import * as React from 'react';
   
   export default function ExampleTab() {
       return (
           <p>This is a custom tab added to a resource using a dynamic plugin.</p>
       );
   }

9. プラグインをクラスターにデプロイするには、プラグインの名前を Helm リリース名として Helm チャートを、新しい namespace または -n コマンドラインオプションで指定された既存の namespace にインストールします。次のコマンドを使用して、plugin.image パラメーター内のイメージの場所を指定します。

   $ helm upgrade -i  my-plugin charts/openshift-console-plugin -n my-plugin-namespace --create-namespace --set plugin.image=my-plugin-image-location

   注記

   クラスターへのプラグインのデプロイの詳細は、「クラスターへのプラグインのデプロイ」を参照してください。

手順

1. 以下のコマンドでイメージをビルドします。

   $ docker build -t quay.io/my-repositroy/my-plugin:latest .

2. オプション: イメージをテストする場合は、以下のコマンドを実行します。

   $ docker run -it --rm -d -p 9001:80 quay.io/my-repository/my-plugin:latest

3. 以下のコマンドを実行してイメージをプッシュします。

   $ docker push quay.io/my-repository/my-plugin:latest

手順

1. プラグインをクラスターにデプロイするには、プラグインの名前を Helm リリース名として Helm チャートを、新しい namespace または -n コマンドラインオプションで指定された既存の namespace にインストールします。次のコマンドを使用して、plugin.image パラメーター内のイメージの場所を指定します。

   $ helm upgrade -i  my-plugin charts/openshift-console-plugin -n my-plugin-namespace --create-namespace --set plugin.image=my-plugin-image-location

   ここでは、以下のようになります。

   n <my-plugin-namespace>

   プラグインをデプロイする既存の namespace を指定します。

   --create-namespace

   オプション: 新しい namespace にデプロイする場合は、このパラメーターを使用します。

   --set plugin.image=my-plugin-image-location

   plugin.image パラメーター内のイメージの場所を指定します。

2. オプション: charts/openshift-console-plugin/values.yaml ファイルでサポートされている一連のパラメーターを使用して、追加のパラメーターを指定できます。

   plugin:
     name: ""
     description: ""
     image: ""
     imagePullPolicy: IfNotPresent
     replicas: 2
     port: 9443
     securityContext:
       enabled: true
     podSecurityContext:
       enabled: true
       runAsNonRoot: true
       seccompProfile:
         type: RuntimeDefault
     containerSecurityContext:
       enabled: true
       allowPrivilegeEscalation: false
       capabilities:
         drop:
           - ALL
     resources:
       requests:
         cpu: 10m
         memory: 50Mi
     basePath: /
     certificateSecretName: ""
     serviceAccount:
       create: true
       annotations: {}
       name: ""
     patcherServiceAccount:
       create: true
       annotations: {}
       name: ""
     jobs:
       patchConsoles:
         enabled: true
         image: "registry.redhat.io/openshift4/ose-tools-rhel8@sha256:e44074f21e0cca6464e50cb6ff934747e0bd11162ea01d522433a1a1ae116103"
         podSecurityContext:
           enabled: true
           runAsNonRoot: true
           seccompProfile:
             type: RuntimeDefault
         containerSecurityContext:
           enabled: true
           allowPrivilegeEscalation: false
           capabilities:
             drop:
               - ALL
         resources:
           requests:
             cpu: 10m
             memory: 50Mi

1. Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。
2. Filter by keyword ボックスを使用してカタログで Web Terminal Operator を検索し、Web Terminal タイルをクリックします。
3. Web Terminal ページで Operator についての簡単な説明を確認してから、Install をクリックします。

4. Install Operator ページで、すべてのフィールドのデフォルト値を保持します。

   • Update Channel メニューの fast オプションは、Web 端末 Operator の最新リリースのインストールを可能にします。
   • Installation Mode メニューの All namespaces on the cluster オプションにより、Operator にクラスターのすべての namespace を監視され、Operator をこれらの namespace で利用可能にすることができます。
   • Installed Namespace メニューの openshift-operators オプションは、Operator をデフォルトの openshift-operators namespace にインストールします。
   • Approval Strategy メニューの Automatic オプションにより、Operator への今後のアップグレードは Operator Lifecycle Manager によって自動的に処理されます。
5. Install をクリックします。

6. Installed Operators ページで、View Operator をクリックし、Operator が Installed Operators ページに一覧表示されていることを確認します。

   注記

   Web Terminal Operator は、DevWorkspace Operator を依存関係としてインストールします。

7. Operator のインストール後に、ページを更新し、コンソールのマストヘッドにあるコマンドラインターミナルアイコン ( ) を確認します。

1. Operator のインストール時に追加された Web 端末 Operator および関連するカスタムリソース (CR) をアンインストールします。
2. Web 端末 Operator の依存関係として追加された DevWorkspace 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. 編集を保存します。