第8章 Web 端末
8.1. Web 端末のインストール リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform ソフトウェアカタログに記載されている Web Terminal Operator を使用して、Web ターミナルをインストールできます。Web Terminal Operator をインストールすると、DevWorkspace CRD など、コマンドラインの設定に必要なカスタムリソース定義 (CRD) が自動的にインストールされます。Web コンソールでは、Web 端末を開く際に必要なリソースを作成します。
8.1.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OpenShift Container Platform Web コンソールにログインしている。
- クラスター管理者パーミッションがある。
8.1.2. 手順 リンクのコピーリンクがクリップボードにコピーされました!
-
Web コンソールの Administrator パースペクティブで、Ecosystem
Software Catalog に移動します。 - Filter by keyword ボックスを使用してカタログで Web Terminal Operator を検索し、Web Terminal タイルをクリックします。
- Web Terminal ページで Operator に関する簡単な説明を確認してから、Install をクリックします。
Install Operator ページで、すべてのフィールドのデフォルト値を保持します。
- Update Channel メニューの fast オプションを使用すると、Web Terminal Operator の最新リリースをインストールできます。
- Installation Mode メニューの All namespaces on the cluster オプションにより、Operator にクラスターのすべての namespace を監視され、Operator をこれらの namespace で利用可能にすることができます。
-
Installed Namespace メニューの openshift-operators オプションは、Operator をデフォルトの
openshift-operatorsnamespace にインストールします。 - Approval Strategy メニューの Automatic オプションにより、Operator への今後のアップグレードは Operator Lifecycle Manager によって自動的に処理されます。
- Install をクリックします。
Installed Operators ページで、View Operator をクリックし、Operator が Installed Operators ページにリスト表示されていることを確認します。
注記Web Terminal Operator は、DevWorkspace Operator を依存関係としてインストールします。
Operator のインストール後に、ページを更新し、コンソールのマストヘッドにあるコマンドラインターミナルアイコン (
) を確認します。
注記Subscriptionリソースを作成して Web ターミナル Operator を手動でインストールする場合は、Subscriptionにweb-terminalという名前を付ける必要があります。web-terminalという名前を付けないと、コンソールのヘッダーにターミナルアイコンが表示されません。
8.2. Web 端末の設定 リンクのコピーリンクがクリップボードにコピーされました!
現在のセッションに対して (クラスター管理者の場合はすべてのユーザーセッションに対して)、Web ターミナルのタイムアウトとイメージの設定を設定できます。
8.2.1. セッションの Web 端末タイムアウトの設定 リンクのコピーリンクがクリップボードにコピーされました!
現在のセッションで、Web 端末のデフォルトタイムアウト期間を変更できます。
前提条件
- Web Terminal Operator がインストールされている OpenShift Container Platform クラスターにアクセスできる。
- Web コンソールにログインしている。
手順
-
Web 端末アイコン (
) をクリックします。
オプション: 現在のセッションの Web 端末タイムアウトを設定します。
- Timeout をクリックします。
- 表示されるフィールドに、タイムアウト値を入力します。
- ドロップダウンリストから、タイムアウト間隔を Seconds、Minutes、Hours、または Milliseconds から選択します。
オプション: Web 端末で使用するカスタムイメージを選択します。
- イメージをクリックします。
- 表示されるフィールドに、使用するイメージの URL を入力します。
- Start をクリックし、指定したタイムアウト設定を使用して端末インスタンスを開始します。
8.2.2. すべてのユーザーの Web ターミナルタイムアウトの設定 リンクのコピーリンクがクリップボードにコピーされました!
Web コンソールの Administrator パースペクティブを使用して、すべてのユーザーのデフォルトの Web ターミナルタイムアウト期間を設定できます。
前提条件
- クラスター管理者の権限があり、Web コンソールにログインしている。
- Web Terminal Operator がインストールされている。
手順
-
Administrator パースペクティブで、Administration
Cluster Settings に移動します。 - Cluster Settings ページで、Configuration タブをクリックします。
Configuration ページで、operator.openshift.io と説明が記載されている Console 設定リソースをクリックします。
- Action ドロップダウンリストから Customize を選択し、Cluster configuration ページを開きます。
- Web Terminal タブをクリックすると、Web Terminal Configuration ページが開きます。
- タイムアウトの値を設定します。ドロップダウンリストから、Seconds、Minutes、Hours、Milliseconds で時間の間隔を選択します。
- Save をクリックします。
8.2.3. セッション用 Web 端末イメージの設定 リンクのコピーリンクがクリップボードにコピーされました!
現在のセッションで、Web 端末のデフォルトイメージを変更できます。
前提条件
- Web Terminal Operator がインストールされている OpenShift Container Platform クラスターにアクセスできる。
- Web コンソールにログインしている。
手順
-
Web 端末アイコン (
) をクリックします。
- Image をクリックして、Web 端末イメージの詳細設定オプションを表示します。
- 使用するイメージの URL を入力します。
- Start をクリックし、指定したイメージ設定を使用して端末インスタンスを開始します。
8.2.4. すべてのユーザーの Web 端末イメージを設定する リンクのコピーリンクがクリップボードにコピーされました!
Web コンソールの Administrator パースペクティブを使用して、すべてのユーザーのデフォルトの Web ターミナルイメージを設定できます。
前提条件
- クラスター管理者の権限があり、Web コンソールにログインしている。
- Web Terminal Operator がインストールされている。
手順
-
Administrator パースペクティブで、Administration
Cluster Settings に移動します。 - Cluster Settings ページで、Configuration タブをクリックします。
Configuration ページで、operator.openshift.io と説明が記載されている Console 設定リソースをクリックします。
- Action ドロップダウンリストから Customize を選択し、Cluster configuration ページを開きます。
- Web Terminal タブをクリックすると、Web Terminal Configuration ページが開きます。
- 使用するイメージの URL を入力します。
- Save をクリックします。
8.3. Web 端末の使用 リンクのコピーリンクがクリップボードにコピーされました!
Web コンソールで組み込みコマンドラインターミナルインスタンスを起動できます。この端末のインスタンスは、oc、kubectl、odo、kn、tkn、helm、subctl など、クラスターと対話するための一般的な CLI ツールと共に事前にインストールされます。また、これには作業しているプロジェクトのコンテキストが含まれ、ユーザーの認証情報を使用してユーザーのログインを自動的に行います。
8.3.1. Web 端末へのアクセス リンクのコピーリンクがクリップボードにコピーされました!
Web 端末 Operator がインストールされると、Web 端末にアクセスし、oc、kubectl、oc、kn、tkn、helm、および subctl などの事前インストールされた CLI ツールを使用できます。
ターミナルで実行したコマンドのリストからコマンドを選択して、コマンドを再実行することができます。これらのコマンドは、複数のターミナルセッション間で保持されます。Web 端末を閉じるまで、またはブラウザーウィンドウかタブを閉じるまで、Web 端末は表示されたままになります。
前提条件
- OpenShift Container Platform クラスターにアクセスでき、Web コンソールにログインしている。
- Web Terminal Operator がクラスターにインストールされている。
手順
-
Web 端末を起動するには、コンソールのマストヘッドにあるコマンドラインターミナルアイコン (
) をクリックします。Web 端末インスタンスが、Command line terminal ペインに表示されます。このインスタンスは、お使いの認証情報を使用して自動的にログインします。
現在のセッションでプロジェクトが選択されていない場合は、
DevWorkspaceCR を作成する必要があるプロジェクトを Project ドロップダウンリストから選択します。デフォルトでは、現在のプロジェクトが選択されます。注記-
1 つの
DevWorkspaceCR は、1 ユーザーの Web 端末を定義します。この CR には、ユーザーの Web 端末ステータスおよびコンテナーイメージコンポーネントに関する詳細が含まれています。 -
DevWorkspaceCR は存在しない場合にのみ作成されます。 -
openshift-terminalプロジェクトは、クラスター管理者に使用されるデフォルトのプロジェクトです。別のプロジェクトを選択するオプションはありません。Web Terminal Operator は、DevWorkspace Operator を依存関係としてインストールします。
-
1 つの
オプション: 現在のセッションの Web 端末タイムアウトを設定します。
- Timeout をクリックします。
- 表示されるフィールドに、タイムアウト値を入力します。
- ドロップダウンリストから、タイムアウト間隔を Seconds、Minutes、Hours、または Milliseconds から選択します。
オプション: Web 端末で使用するカスタムイメージを選択します。
- イメージをクリックします。
- 表示されるフィールドに、使用するイメージの URL を入力します。
- Start をクリックし、選択したプロジェクトを使用して Web 端末を初期化します。
- + をクリックして、コンソールの Web 端末で複数のタブを開きます。
8.4. Web 端末のトラブルシューティング リンクのコピーリンクがクリップボードにコピーされました!
8.4.1. Web 端末とネットワークポリシー リンクのコピーリンクがクリップボードにコピーされました!
クラスターにネットワークポリシーが設定されていると、Web 端末の起動に失敗する可能性があります。Web 端末インスタンスを起動するには、Web Terminal Operator は Web 端末の Pod と通信して実行中であることを確認する必要があり、OpenShift Container Platform Web コンソールはターミナル内のクラスターへの自動ログイン情報を送信する必要があります。いずれのステップも失敗すると、Web 端末は起動に失敗し、context deadline exceeded error が発生するまで、端末パネルはロード状態になります。
この問題を回避するには、端末に使用される namespace のネットワークポリシーが openshift-console および openshift-operators namespace からの ingress を許可していることを確認してください。
以下のサンプルは、openshift-console および openshift-operators namespace からの Ingress を許可する NetworkPolicy オブジェクトを示しています。
openshift-console namespace からの Ingress の許可
apiVersion: networking.k8s.io/v1
kind: NetworkPolicy
metadata:
name: allow-from-openshift-console
spec:
ingress:
- from:
- namespaceSelector:
matchLabels:
kubernetes.io/metadata.name: openshift-console
podSelector: {}
policyTypes:
- Ingress
openshift-operators namespace からの Ingress の許可
apiVersion: networking.k8s.io/v1
kind: NetworkPolicy
metadata:
name: allow-from-openshift-operators
spec:
ingress:
- from:
- namespaceSelector:
matchLabels:
kubernetes.io/metadata.name: openshift-operators
podSelector: {}
policyTypes:
- Ingress
8.5. Web 端末のアンインストール リンクのコピーリンクがクリップボードにコピーされました!
Web Terminal Operator をアンインストールしても、Operator のインストール時に作成されるカスタムリソース定義 (CRD) または管理リソースは削除されません。セキュリティー上の理由から、これらのコンポーネントは手動でアンインストールする必要があります。これらのコンポーネントを削除すると、Operator をアンインストールしても端末はアイドル状態にならないため、クラスターリソースが保存されます。
Web 端末のアンインストールは 2 つの手順で実行されます。
- Web Terminal Operator と、Operator のインストール時に追加された関連カスタムリソース (CR) をアンインストールします。
- Web Terminal Operator の依存関係として追加された DevWorkspace Operator と関連するカスタムリソースをアンインストールします。
8.5.1. Web Terminal Operator の削除 リンクのコピーリンクがクリップボードにコピーされました!
Web 端末をアンインストールするには、Operator が使用する Web Terminal Operator とカスタムリソースを削除します。
前提条件
-
cluster-adminロールを持つユーザーとして OpenShift Container Platform Web コンソールにアクセスできる。 -
ocCLI がインストールされている。
手順
-
Web コンソールで、Ecosystem
Installed Operators に移動します。 - フィルターリストをスクロールするか、Filter by name ボックスにキーワードを入力して Web Terminal Operator を見つけます。
-
Web 端末 Operator の Options メニュー
をクリックし、Uninstall Operator を選択します。
- Uninstall Operator 確認ダイアログボックスで、Uninstall をクリックし、Operator、Operator デプロイメント、および Pod をクラスターから削除します。この Operator は実行を停止し、更新を受信しなくなります。
8.5.2. DevWorkspace Operator の削除 リンクのコピーリンクがクリップボードにコピーされました!
Web 端末を完全にアンインストールするには、Operator が使用する DevWorkspace Operator とカスタムリソースも削除する必要があります。
DevWorkspace Operator はスタンドアロン Operator であり、クラスターにインストールされている他の Operator の依存関係として必要になる場合があります。DevWorkspace Operator が不要であることが確実な場合にのみ、以下の手順を実行してください。
前提条件
- クラスター管理者のパーミッションを持つ OpenShift Container Platform クラスターにアクセスできる。
-
ocCLI がインストールされている。
手順
Operator が使用する
DevWorkspaceカスタムリソースと関連する Kubernetes オブジェクトを削除します。$ oc delete devworkspaces.workspace.devfile.io --all-namespaces --all --wait$ oc delete devworkspaceroutings.controller.devfile.io --all-namespaces --all --wait警告この手順が完了していない場合、ファイナライザーにより Operator を完全にアンインストールすることが困難になります。
Operator によって使用される CRD を削除します。
警告DevWorkspace Operator は、変換 Webhook を使用するカスタムリソース定義 (CRD) を提供します。これらの CRD の削除に失敗すると、クラスターで問題が発生する可能性があります。
$ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaceroutings.controller.devfile.io$ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaces.workspace.devfile.io$ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspacetemplates.workspace.devfile.io$ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaceoperatorconfigs.controller.devfile.io関連するすべてのカスタムリソース定義が削除されていることを確認します。以下のコマンドを実行しても何も出力されないはずです。
$ oc get customresourcedefinitions.apiextensions.k8s.io | grep "devfile.io"devworkspace-webhook-serverデプロイメント、変更用および検証用の Webhook を削除します。$ oc delete deployment/devworkspace-webhook-server -n openshift-operators$ oc delete mutatingwebhookconfigurations controller.devfile.io$ oc delete validatingwebhookconfigurations controller.devfile.io注記変更用および検証用の Webhook を削除せずに
devworkspace-webhook-serverデプロイメントを削除すると、oc execコマンドを使用してクラスターのコンテナーでコマンドを実行することはできません。Webhook を削除したら、oc execコマンドを再度使用できます。残りのサービス、シークレット、および config map を削除します。インストールによっては、以下のコマンドに含まれる一部のリソースがクラスターに存在しない場合があります。
$ oc delete all --selector app.kubernetes.io/part-of=devworkspace-operator,app.kubernetes.io/name=devworkspace-webhook-server -n openshift-operators$ oc delete serviceaccounts devworkspace-webhook-server -n openshift-operators$ oc delete clusterrole devworkspace-webhook-server$ oc delete clusterrolebinding devworkspace-webhook-serverDevWorkspace Operator をアンインストールします。
-
Web コンソールの Administrator パースペクティブで、Ecosystem
Installed Operators に移動します。 - フィルターリストをスクロールするか、Filter by name ボックスにキーワードを入力して DevWorkspace Operator を見つけます。
-
Operator のオプションメニュー
をクリックし、Uninstall Operator を選択します。
- Uninstall Operator 確認ダイアログボックスで、Uninstall をクリックし、Operator、Operator デプロイメント、および Pod をクラスターから削除します。この Operator は実行を停止し、更新を受信しなくなります。
-
Web コンソールの Administrator パースペクティブで、Ecosystem