Web コンソール

手順

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

   $ 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 設定が更新されると、カスタムロゴ設定マップをコンソール 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. 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 namespace に作成する必要があります。以下は例になります。

   $ 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. シークレットを作成します。

   $ 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. 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 端末 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 ページに一覧表示されていることを確認します。
7. Operator のインストール後に、ページを更新し、コンソールの右上にあるコマンドラインターミナルアイコンを確認します。

1. Web 端末を起動するには、コンソールの右上にあるコマンドラインターミナルアイコン ( ) をクリックします。Web 端末インスタンスが、Command line terminal ペインに表示されます。このインスタンスは、お使いの認証情報を使用して自動的にログインします。

2. Project ドロップダウンリストから DevWorkspace CR を作成する必要のあるプロジェクトを選択します。デフォルトでは、現在のプロジェクトが選択されます。

   注記
   • DevWorkspace CR は存在しない場合にのみ作成されます。
   • openshift-terminal プロジェクトは、クラスター管理者に使用されるデフォルトのプロジェクトです。別のプロジェクトを選択するオプションはありません。
3. Start をクリックし、選択したプロジェクトを使用して Web 端末を初期化します。

1. Operator のインストール時に追加されたコンポーネントおよびカスタムリソース (CR) を削除します。
2. Web 端末 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. 編集を保存します。