第4章 CodeReady Workspaces の設定
本章では、いくつかのーザーストーリーを例として使用し、Red Hat CodeReady Workspaces の設定方法とオプションについて説明します。
- 「CodeReady Workspaces サーバーコンポーネントの詳細な設定オプション」 では、前述の方法を適用できない場合に使用する詳細な設定方法を説明します。
次のセクションでは、特定のユーザーストーリーを説明します。
- 「ワークスペースターゲットプロジェクトの設定」
- 「ユーザーが作成できるワークスペースの数の設定」
- 「ユーザーが実行できるワークスペース数の設定」
- 「ワークスペース nodeSelector の設定」
- 「Red Hat CodeReady Workspaces サーバーのホスト名の設定」
- 「OpenShift ルートの設定」
- 「ルーターのシャード化と連携するように OpenShift ルートを設定」
- 「自己署名証明書を使用した Git リポジトリーをサポートする CodeReady Workspaces のデプロイ」
- 「ストレージクラスを使用した CodeReady Workspaces のインストール」
- 「ストレージタイプの設定」
- 「信頼できない TLS 証明書の CodeReady Workspaces へのインポート」
- 「コンポーネント間の通信での外部 DNS 名と内部 DNS 名間の切り替え」
- 「Red Hat CodeReady Workspaces ログインページの RH-SSO codeready-workspaces-username-readonly テーマの設定」
- 「シークレットまたは ConfigMap をファイルまたは環境変数として CodeReady Workspaces コンテナーにマウントする」
- 「Dev Workspace エンジンの有効化」
4.1. CodeReady Workspaces サーバーコンポーネントの詳細な設定オプション
以下のセクションでは、CodeReady Workspaces サーバーコンポーネントの詳細なデプロイメントおよび設定方法を説明します。
4.1.1. Operator を使用した CodeReady Workspaces サーバーの詳細設定について
以下のセクションでは、Operator を使用したデプロイメントの CodeReady Workspaces サーバーコンポーネントの詳細な設定方法について説明します。
詳細設定は以下を実行するために必要です。
-
標準の
CheCluster
カスタムリソースフィールドから Operator によって自動的に生成されない環境変数を追加します。 -
標準の
CheCluster
カスタムリソースフィールドから Operator によって自動的に生成されるプロパティーを上書きします。
CheCluster
カスタムリソースの server
設定の一部である customCheProperties
フィールドには、CodeReady Workspaces サーバーコンポーネントに適用する追加の環境変数のマップが含まれます。
例4.1 ワークスペースのデフォルトのメモリー制限の上書き
CHE_WORKSPACE_DEFAULT__MEMORY__LIMIT__MB
プロパティーを customCheProperties
に追加します。
apiVersion: org.eclipse.che/v1 kind: CheCluster # [...] spec: server: # [...] customCheProperties: CHE_WORKSPACE_DEFAULT__MEMORY__LIMIT__MB: "2048" # [...]
以前のバージョンの CodeReady Workspaces Operator には、このロールを実行するために custom
という名前の configMap が含まれていました。CodeReady Workspaces Operator が custom
という名前の configMap
を見つけると、これに含まれるデータを customCheProperties
フィールドに追加し、CodeReady Workspaces を再デプロイし、custom
configMap
を削除します。
関連資料
-
CheCluster
カスタムリソースで利用可能なすべてのパラメーターの一覧については、2章CodeReady Workspaces インストールの設定 を参照してください。 -
customCheProperties
の設定に使用できるすべてのパラメーターの一覧については、「CodeReady Workspaces サーバーコンポーネントのシステムプロパティー参照」 を参照してください。
4.1.2. CodeReady Workspaces サーバーコンポーネントのシステムプロパティー参照
以下のドキュメントでは、CodeReady Workspaces サーバーコンポーネントのすべての使用可能な設定プロパティーについて説明します。
4.1.2.1. CodeReady Workspaces サーバー
表4.1 CodeReady Workspaces サーバー
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| CodeReady Workspaces が内部データオブジェクトを保存するフォルダー。 |
|
| API サービス。ブラウザーは、この URL を使用して CodeReady Workspaces サーバーへの REST 通信を開始します。 |
|
| API サービスの内部ネットワーク URL。バックエンドサービスは、この URL を使用した CodeReady Workspaces サーバーへの REST 通信を開始する必要があります。 |
|
| CodeReady Workspaces websocket の主なエンドポイント。主な websocket の対話とメッセージング用の基本的な通信エンドポイントを提供します。 |
|
| プロジェクトは、CodeReady Workspaces サーバーから各ワークスペースを実行するマシンに同期されます。これは、プロジェクトが配置されているマシンのディレクトリーです。 |
|
|
devfile 要求の OpenShift タイプのコンポーネントがプロジェクト PVC 作成を要求する場合に使用されます ( |
|
| すべてのワークスペースログが置かれるマシン内のディレクトリーを定義します。環境変数などの値として、この値をマシンに指定します。これは、エージェントの開発者がこのディレクトリーを使用してエージェントのログをバックアップできるようにするためのものです。 |
| 環境変数 HTTP_PROXY は、ワークスペースを起動するコンテナーで指定された値に設定します。 | |
| 環境変数 HTTPS_PROXY は、ワークスペースを起動するコンテナーで指定された値に設定します。 | |
| 環境変数 NO_PROXY は、ワークスペースを起動するコンテナーで指定された値に設定します。 | |
|
|
デフォルトでは、ユーザーがこの URL を使用してワークスペースにアクセスすると、ワークスペースは自動的に起動します (現時点で停止している場合)。この動作を無効にするには、このパラメーターを |
|
|
ワークスペーススレッドプールの設定。このプールは、非同期の実行が必要なワークスペース関連の操作 (例: 起動/停止) に使用されます。設定可能な値は |
|
|
プールタイプが |
|
|
プールタイプが |
|
| このプロパティーは、ワークスペースサーバーの liveness プローブに使用するスレッドの数を指定します。 |
|
| ワークスペース JVM の HTTP プロキシー設定。 |
|
| ワークスペースで実行されている JVM に追加される Java コマンドラインオプション。 |
|
| ワークスペースでエージェントを実行する JVM に追加される Maven コマンドラインオプション。 |
|
| 環境に RAM 設定のない各マシンの RAM 制限のデフォルト。0 以下の値値は、制限を無効にするものとして解釈されます。 |
|
| 環境内に明示的な RAM 設定のない各コンテナーの RAM 要求。この量はワークスペースコンテナーの作成時に割り当てられます。このプロパティーは、すべてのインフラストラクチャー実装でサポートされる訳ではありません。現時点で、これは OpenShift によってサポートされます。メモリー制限を超えるメモリー要求は無視され、制限サイズのみが使用されます。0 以下の値値は、制限を無効にするものとして解釈されます。 |
|
|
環境に CPU 設定のない各コンテナーの CPU 制限。浮動小数点のコア数 (例: |
|
| 環境内に CPU 設定のない各コンテナーの CPU 要求。CPU 制限を超える CPU 要求は無視され、制限の数値のみが使用されます。0 以下の値値は、制限を無効にするものとして解釈されます。 |
|
| CodeReady Workspaces プラグイン設定に RAM 設定のない各サイドカーの RAM 制限。0 以下の値値は、制限を無効にするものとして解釈されます。 |
|
| CodeReady Workspaces プラグイン設定に RAM 設定のない各サイドカーの RAM 要求。 |
|
|
CodeReady Workspaces プラグイン設定に CPU 設定のない各サイドカーの CPU 制限のデフォルト。浮動小数点のコア数 (例: |
|
|
CodeReady Workspaces プラグイン設定に CPU 設定のない各サイドカーの CPU 要求のデフォルト。浮動小数点のコア数 (例: |
|
|
サイドカーのイメージプルストラテジーを定義します。使用できる値は |
|
| 非アクティブなワークスペースの一時停止ジョブの実行期間。 |
|
| アクティビティーテーブルのクリーンアップ期間。アクティビティーテーブルには、サーバーが特定の時点で障害が発生するなどの予想されないエラーが生じる場合に、無効なデータまたは古いデータを含まれることがあります。デフォルトでは、クリーンアップジョブは 1 時間ごとに実行されます。 |
|
| サーバーの起動後から最初のアクティビティーのクリーンアップジョブを開始するまでの遅延。 |
|
| CodeReady Workspaces サーバーが非アクティブのタイムアウトまでの期間利用できない場合の、大規模な一時停止を回避するために最初のワークスペースのアイドルチェックジョブが開始されるまでの遅延。 |
|
| 一時ワークスペースのクリーンアップジョブの最初の実行を遅延させる時間。 |
|
| 実行を終了してから次の一時的なワークスペースのクリーンアップジョブの実行を開始するまでの間に遅延する時間 |
|
| サーバーへの正常に順次実行される ping の数。この数を超えると、サーバーは利用可能な状態にあるものとして処理されます。CodeReady Workspaces Operator: このプロパティーは、ワークスペース、エージェント、ターミナル、exec などの全サーバーに共通します。 |
|
| ワークスペースサーバーへの連続する ping の間隔 (ミリ秒単位)。 |
|
| liveness プローブを必要とするサーバー名の一覧 |
|
| ワークスペースの起動をデバッグする際に che-server で観察される単一コンテナーから収集されるログの制限サイズ。デフォルト値は 10MB=10485760 です。 |
|
| true の場合、OpenShift OAuth が有効な場合に、編集権限を持つ「stop-workspace」ロールが「che」 ServiceAccount に付与されます。この設定は、OpenShift OAuth が有効な場合にワークスペースのアイドリングに主に必要になります。 |
|
| DevWorkspaces を有効にして CodeReady Workspaces をデプロイするかどうかを指定します。このプロパティーは、DevWorkspace のサポートもインストールされている場合に CodeReady Workspaces Operator によって設定されます。このプロパティーを使用して、このファクトを CodeReady Workspaces ダッシュボードにアドバタイズします。このプロパティーの値を手動で変更することは推奨されません。 |
4.1.2.2. 認証パラメーター
表4.2 認証パラメーター
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| CodeReady Workspaces には単一のアイデンティティー実装があるため、これによるユーザーエクスペリエンスへの変更はありません。true の場合、API レベルでのユーザー作成を有効にします。 |
|
| 認証エラーページアドレス |
| 予約済みのユーザー名 | |
|
| GitHub OAuth クライアントの設定。GitHub OAuth を設定して、リモートリポジトリーへの認証を自動化できます。最初に、このアプリケーションを GitHub OAuth に登録する必要があります。GitHub OAuth クライアント ID。 |
|
| GitHub OAuth クライアントシークレット。 |
|
| GitHub OAuth 認証 URI。 |
|
| GitHub OAuth トークン URI。 |
|
| GitHub OAuth リダイレクト URI。複数の値をコンマで区切ります(例: URI,URI,URI)。 |
|
| OpenShift OAuth クライアントの設定。OpenShift OAuth トークンの取得に使用されます。OpenShift OAuth クライアント ID。 |
|
| OpenShift OAuth クライアントの設定。OpenShift OAuth トークンの取得に使用されます。OpenShift OAuth クライアント ID。OpenShift OAuth クライアントシークレット。 |
|
| Configurationof OpenShift OAuth クライアント。OpenShift OAuth トークンの取得に使用されます。OpenShift OAuth クライアント ID。OpenShift OAuth クライアントシークレット。OpenShift OAuth エンドポイント。 |
|
| ConfigurationofOpenShiftOAuth クライアント。OpenShift OAuth トークンの取得に使用されます。OpenShift OAuth クライアント ID。OpenShift OAuth クライアントシークレット。OpenShift OAuth エンドポイント。OpenShift OAuth 検証トークン URL。 |
|
| Bitbucket Server OAuth1 クライアントの設定。パーソナルアクセストークンの取得に使用されます。Bitbucket Server アプリケーションのコンシューマーキーが含まれるファイルの場所(ユーザー名と同等)。 |
|
| Bitbucket Server OAuth1 クライアントの設定パーソナルアクセストークンの取得に使用されます。Bitbucket Server アプリケーションのコンシューマーキーが含まれるファイルの場所(ユーザー名と同等)。Bitbucket Server アプリケーションの秘密鍵が含まれるファイルの場所 |
|
|
Bitbucket Server OAuth1 クライアントの設定パーソナルアクセストークンの取得に使用されます。Bitbucket Server アプリケーションのコンシューマーキーが含まれるファイルの場所(ユーザー名と同等)。Bitbucket Server アプリケーションの秘密鍵の Bitbucket Server URL が含まれるファイルの場所ファクトリーと正しく連携するには、同じ URL を |
4.1.2.3. 内部
表4.3 内部
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| CodeReady Workspaces 拡張には、時間ベースでスケジュールされる実行をスケジュールできます。これにより、繰り返されるスケジュールで起動する拡張に割り当てられるスレッドプールのサイズが設定されます。 |
|
| DB の初期化および移行設定。trueの場合には、baseline.version で設定Siたバージョンのスクリプトを無視します。 |
|
| これまでのバージョンを含むスクリプトは無視されます。ベースラインバージョンと同じバージョンのスクリプトも無視されることに注意してください。 |
| 移行スクリプトの接頭辞 | |
|
| 移行スクリプトの接尾辞。 |
|
| スクリプト名を他の部分からバージョンを区切るための区切り文字。 |
|
| 移行スクリプトを検索する場所。 |
4.1.2.4. OpenShift インフラパラメーター
表4.4 OpenShift インフラパラメーター
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
| インフラが使用する OpenShift クライアントのマスター URL の設定。 | |
|
| 信頼済み証明書を使用するように OpenShift クライアントを設定するブール値。 |
|
| OpenShift クラスタードメイン。設定されていない場合は、svc 名にはクラスタードメインに関する情報が含まれません。 |
|
|
サーバーが Kubernetes インフラでグローバルに公開される方法を定義します。CodeReady Workspaces に実装されたストラテジーの一覧: |
|
|
ワークスペースのプラグインとエディターを単一ホストモードで公開する方法を定義します。サポートされる公開: |
|
|
single-host サーバーストラテジーで devfile エンドポイント、エンドユーザーのアプリケーションを公開する方法を定義します。これらは single-host ストラテジーに従い、サブパスで公開されるか、またはサブドメイン上で公開できます。 |
|
| single-host ゲートウェイを設定する ConfigMap に設定されるラベルを定義します。 |
|
| |
|
| CodeReady Workspaces サーバーがユーザーワークスペースのプロジェクトを作成できるかどうか、またはそれらはクラスター管理者によって手動で作成されるかどうかを示します。このプロパティーは OpenShift infra によっても使用されます。 |
|
|
ユーザーが上書きしない場合に、ユーザーのワークスペースが作成されるデフォルトの OpenShift プロジェクトを定義します。 |
|
| che-server がワークスペース namespace にラベルを付けるかどうかを定義します。 |
|
|
CodeReady Workspaces に使用されるプロジェクトの検索に使用するラベルの一覧。これらは |
|
|
CodeReady Workspaces ユーザーワークスペース用に用意されたプロジェクトの検索に使用するアノテーションの一覧。これらのアノテーションと照合されるのは、 |
|
|
すべてのワークスペース Pod にバインドされるように指定する必要のある Kubernetes サービスアカウント名を定義します。OpenShift インフラストラクチャーがサービスアカウントを作成しない CodeReady Workspaces Operator は存在すべきです。OpenShift インフラストラクチャーは、プロジェクトが事前に定義されているかどうかをチェックします( |
|
|
ワークスペースサービスアカウントで使用するオプションの追加のクラスターロールを指定します。クラスターのロール名がすでに存在している必要があり、CodeReady Workspaces サービスアカウントはロールバインディングを作成して、これらのクラスターロールをワークスペースのサービスアカウントに関連付ける必要があります。名前はコンマで区切られます。このプロパティーは |
|
| Kubernetes ワークスペースの開始時間を制限する待機時間を定義します。 |
|
| OpenShift Route が準備状態になる期間を制限するタイムアウトを分単位で定義します。 |
|
| ワークスペースの起動中に、プロパティーで定義されたリカバリー不可能なイベントが発生する場合は、タイムアウトまで待機するのではなく、ワークスペースをすぐ終了します。CodeReady Workspaces Operator: リカバリー不能なイベントが発生する可能性があるため「Failed」の理由だけを追加できません。失敗したコンテナーの起動は、CodeReady Workspaces サーバーで明示的に処理されます。 |
|
| CodeReady Workspaces ワークスペースに Persistent Volume Claim(永続ボリューム要求、PVC)を使用するかどうかを定義します (例: プロジェクトやログのバックアップや、無効化)。 |
|
|
ワークスペース用に PVC を選択する際に使用するストラテジーを定義します。サポートされるストラテジー: |
|
|
ワークスペースを起動する前に、 |
|
|
CodeReady Workspaces ワークスペースの PVC 名の設定を定義します。それぞれの PVC ストラテジーは、この値を異なる方法で指定します。 |
| ワークスペースの Persistent Volume Claim(永続ボリューム要求、PVC)のストレージクラスを定義します。空の文字列は「use default」を意味します。 | |
|
| CodeReady Workspaces ワークスペースの Persistent Volume Claim(永続ボリューム要求、PVC)のサイズを定義します。「永続ストレージについて」を参照してください。 |
|
| OpenShift で永続ボリューム要求 (PVC)のメンテナンスジョブを実行する際に起動する Pod |
|
| OpenShift クラスターのメンテナンスジョブに使用されるコンテナーのイメージプルポリシー |
|
| 永続ボリューム要求のメンテナンスジョブの Pod メモリー制限を定義します。 |
|
| Persistent Volume Claim(永続ボリューム要求、PVC)のアクセスモードを定義します。アクセスモードを変更する一般的な PVC ストラテジー向けの CodeReady Workspaces Operator は、同時に実行されるワークスペースの数に影響します。CodeReady Workspace を実行している OpenShift インスタンスが RWX アクセスモードで永続ボリュームを使用している場合には、同時に実行するワークスペース数の上限は、CodeReady Workspace の制限設定 (メモリー、CPU など) でのみバインドされます。「永続ストレージについて」を参照してください。 |
|
|
CodeReady Workspaces Server がワークスペース Persistent Volume Claim(永続ボリューム要求、PVC)の作成後にバインドする必要があるかどうかを定義します。デフォルト値は |
|
|
サーバーを公開するために使用される Ingress のアノテーションを定義します。値は Ingress コントローラーの種類によって異なります。OpenShift インフラストラクチャーは Ingress ではなくルートを使用するため、このプロパティーは無視されます。単一ホストデプロイメントストラテジーが機能する CodeReady Workspaces Operator は、URL の書き換えをサポートするコントローラーを使用する必要があります(そのため、サーバーはアプリケーションルートの変更をサポートする必要がありません)。 |
|
|
サーバーを公開する Ingress のパスを宣言する方法についての「recipe」(レシピ) を定義します。 |
|
| 明確化できるように、CodeReady Workspaces サーバーによって作成されるすべての Ingress に追加する追加のラベル。 |
|
| OpenShift インフラによって作成される Pod のセキュリティーコンテキストを定義します。これは OpenShift インフラによって無視されます。 |
|
| OpenShift インフラによって作成される Pod のセキュリティーコンテキストを定義します。Pod の全コンテナーに適用される特別な補助グループです。OpenShift インフラは、このグループを無視します。 |
|
|
OpenShift インフラストラクチャーによって作成される Pod の猶予期間を定義します。デフォルト値: |
|
|
|
|
| ホストごとの並行非同期 Web 要求の最大数。 |
|
| Kubernetes クライアント共有 http クライアントの接続プールにおけるアイドル状態の接続の最大数 |
|
| Kubernetes クライアント共有 http クライアントの接続プールのキープアライブのタイムアウト (分単位) |
|
| Transport Layer Security(TLS)を有効にして Ingress を作成します。OpenShift インフラストラクチャーではルートは TLS に対応します。 |
| TLS でワークスペース Ingress を作成する際に使用すべきシークレットの名前。OpenShift インフラストラクチャーでは、このプロパティーは無視されます。 | |
|
|
ワークスペース Ingress に使用する必要のある TLS Secret のデータ。 |
|
| ワークスペース Ingress に使用する必要のある TLS Secret の証明書データ。証明書は、Base64 アルゴリズムでエンコードする必要があります。OpenShift インフラストラクチャーでは、このプロパティーは無視されます。 |
|
|
ランタイムの整合性チェックが実行される期間を定義します。ランタイムに一貫性のない状態がある場合、ランタイムは自動的に停止します。値は 0 をより大きな値、または |
|
|
すべてのユーザーのワークスペースに伝播される追加の CA TLS 証明書を含む、CodeReady Workspaces サーバー namespace の設定マップの名前。プロパティーを OpenShift 4 インフラストラクチャーに設定し、 |
|
|
追加の CA TLS 証明書を含むワークスペース namespace の設定マップの名前。ワークスペース namespace にある |
|
|
CA バンドルがマウントされるワークスペースコンテナーでパスを設定します。 |
|
ユーザーワークスペースの CA 証明書の設定マップに追加するラベルのコンマ区切りの一覧。 | |
|
|
|
4.1.2.5. OpenShift インフラパラメーター
表4.5 OpenShift インフラパラメーター
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
|
ユーザーワークスペースの CA 証明書の設定マップに追加するラベルのコンマ区切りの一覧。 |
|
| 明確化できるように、CodeReady Workspaces サーバーによって作成されるすべての Route に追加する追加のラベル。 |
|
|
ワークスペースルートの接尾辞として使用する必要のあるホスト名。たとえば、 |
|
| OpenShift OAuth が有効な場合には、CodeReady Workspaces サーバーのサービスアカウントで OpenShift プロジェクトを初期化します。 |
4.1.2.6. 実験的なプロパティー
表4.6 実験的なプロパティー
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| ワークスペースツール設定を解決し、プラグインの依存関係をワークスペースにコピーする CodeReady Workspaces プラグインブローカーアプリケーションの Docker イメージCodeReady Workspaces Operator はデフォルトでこれらのイメージを上書きします。CodeReady Workspaces が Operator を使用してインストールされている場合は、ここでイメージを変更しても、効果がありません。 |
|
| CodeReady Workspaces プラグインアーティファクトブローカーの Docker イメージ。このブローカーは、ワークスペース Pod で init コンテナーとして実行されます。このジョブは、プラグインの ID (レジストリー内のプラグインへの参照または、プラグインの meta.yaml へのリンク) の一覧を取り、ワークスペース向けに要求されたプラグインごとに、正しい .vsix and .theia 拡張子が /plugins ディレクトリーにダウンロードされていることを確認します。 |
|
|
プラグインをワークスペースにプロビジョニングする際にプラグインブローカーのデフォルト動作を設定します。true に設定すると、プラグインブローカーは可能な場合にプラグインのマージを試行します(つまり、それらは同じサイドカーイメージで実行され、設定が競合することはありません)。この値は、devfile で |
|
| ワークスペースツール設定を解決し、プラグインの依存関係をワークスペースにコピーする CodeReady Workspaces プラグインブローカーアプリケーションの Docker イメージ |
|
| プラグインブローカーの待機中に結果の最大期間を制限するタイムアウトを分単位で定義します。 |
|
| ワークスペースプラグインレジストリーのエンドポイント。有効な HTTP URL でなければなりません。例: http://che-plugin-registry-eclipse-che.192.168.65.2.nip.io CodeReady Workspaces プラグインレジストリーが不要な場合、値 'NULL' を使用する必要があります。 |
|
| ワークスペースプラグインレジストリーの内部エンドポイント。有効な HTTP URL でなければなりません。例: http://devfile-registry.che.svc.cluster.local:8080 CodeReady Workspaces プラグインレジストリーが不要な場合、値 'NULL' を使用する必要があります。 |
|
| devfile レジストリーエンドポイント。有効な HTTP URL でなければなりません。例: http://che-devfile-registry-eclipse-che.192.168.65.2.nip.io CodeReady Workspaces プラグインレジストリーが不要な場合、値 'NULL' を使用する必要があります。 |
|
| devfile レジストリー 'internal' エンドポイント。有効な HTTP URL でなければなりません。例: http://plugin-registry.che.svc.cluster.local:8080 CodeReady Workspaces プラグインレジストリーが不要な場合、値 'NULL' を使用する必要があります。 |
|
|
ダッシュボードなどのクライアントがワークスペースの作成/更新時にユーザーに提案するストレージタイプに使用できる値を定義する設定プロパティー。使用できる値: - |
|
|
ダッシュボードなどのクライアントがワークスペースの作成/更新時にユーザーに提案するストレージタイプのデフォルト値を定義する設定プロパティー。 |
|
|
セキュアなサーバーが認証で保護される方法を設定します。適切な値: |
|
|
署名のない要求をルーティングするための |
|
| jwtproxy 発行者トークンの有効期間。 |
|
| 署名なしの要求をルーティングする認証ページのパス (任意)。 |
|
| jwtproxy イメージ。 |
|
| jwtproxy メモリー要求。 |
|
| jwtproxy メモリー制限。 |
|
| jwtproxy CPU 要求。 |
|
| jwtproxy CPU 制限。 |
4.1.2.7. 主なWebSocketエンドポイントの設定
表4.7 主なWebSocketエンドポイントの設定
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| JSON RPC 処理プールの最大サイズ。プールサイズが超過すると、メッセージの実行が拒否されます。 |
|
| 初期 JSON 処理プール。主な JSON RPC メッセージを処理するために使用されるスレッドの最小数。 |
|
| Json RPC メッセージの処理に使用するキューの設定。 |
|
| Prometheus メトリクスで公開される HTTP サーバーエンドポイントのポート |
4.1.2.8. CORS 設定
表4.8 CORS 設定
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| 許可される要求元を指定します。WS Master の CORS フィルターはデフォルトで無効にされます。環境変数 'CHE_CORS_ENABLED=true' を使用してオンにします。 |
|
| 認証情報 (cookie、ヘッダー、TLS クライアント証明書) を使用して要求の処理を許可するかどうかを示します。 |
4.1.2.9. Factory のデフォルト
表4.9 Factory のデフォルト
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
|
CodeReady Workspaces 固有のワークスペース記述子が含まれないリモート git リポジトリーから作成される Factory 用に作成されるエディターおよびプラグイン。複数のプラグインは、以下のようにコンマで区切る必要があります。例: |
|
| リポジトリーベースの Factory(GitHub など)を検索する devfile のファイル名。Factory は、プロパティーで列挙される順序でこれらのファイルの特定を試みます。 |
4.1.2.10. devfile のデフォルト
表4.10 devfile のデフォルト
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| CodeReady Workspaces 固有のワークスペース記述子が含まれないリモート Git リポジトリーから作成される Factory に使用されるエディター。 |
|
| SCM リポジトリーからファイルを取得する URL フェッチャーのファイルサイズ制限。 |
|
| devfile v2 を補完する追加ファイルで、リポジトリーに含まれる場合があり、取得するには Factory の SCM リゾルバーサービスへのリンクとして参照する必要があります。 |
|
|
指定されていない場合に Devfile にプロビジョニングする必要があるデフォルトのエディター。エディター形式は、 |
|
|
デフォルトのエディター用にプロビジョニングする必要があるデフォルトのプラグイン。ユーザー定義の devfile で明示的に参照されていないこの一覧のすべてのプラグインはプロビジョニングされますが、これはデフォルトのエディターが使用されているか、またはユーザー定義のエディターが (異なるバージョンの場合でも) デフォルトと同じである場合に限ります。形式は、コンマ区切りの |
|
| ユーザー namespace からシークレットを選択するためにラベルのコンマ区切りの一覧を定義します。これは、ファイルまたは環境変数としてワークスペースコンテナーにマウントされます。すべての指定されるラベルに一致するシークレットのみが選択されます。 |
|
| 非同期ストレージ機能がワークスペース設定で有効にされ、環境でサポートされる場合に、プラグインが追加されます。 |
|
| CodeReady Workspaces 非同期ストレージの Docker イメージ |
|
|
オプションでワークスペース Pod のノードセレクターを設定します。形式は、コンマ区切りの key=value ペアです (例: |
|
|
オプションでワークスペース Pod の容認を設定します。形式は、テイントの容認の JSON 配列を表す文字列か、または |
|
| 最後に使用されたワークスペースの停止後の非同期ストレージ Pod のシャットダウンのタイムアウト。0 以下の値は、シャットダウン機能を無効にするものとして解釈されます。 |
|
| 非同期ストレージ Pod が機能を停止する期間を定義します (デフォルトでは 30 分ごと)。 |
|
| Factory の統合に使用される Bitbucket エンドポイント。bitbucket サーバー URL のコンマ区切りの一覧、または統合が予想されない場合は NULL。 |
|
| Factory の統合に使用される GitLab エンドポイント。GitLab サーバー URL のコンマ区切りの一覧、または統合が予想されない場合は NULL。 |
|
| OAuth 2 統合が設定された GitLab サーバーのアドレス |
4.1.2.11. Che システム
表4.11 Che システム
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| System Super Privileged Mode (システムのスーパー特権モード)。getByKey、getByNameSpace、stopWorkspaces、および getResources の manageSystem パーミッションの追加パーミッションをユーザーに付与します。これらは、デフォルトでは管理者には提供されず、これらのパーミッションにより、管理者はadmin 権限でそれらのワークスペースに名前を指定し、ワークスペースへの可視性を得ることができます。 |
|
|
|
4.1.2.12. Workspace の制限
表4.12 Workspace の制限
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| ワークスペースは、開発を行う際のユーザー向けの基本的なランタイムです。ワークスペースの作成方法や、消費されるリソースを制限するパラメーターを設定できます。ユーザーが新規ワークスペースの作成時にワークスペースに割り当てることができる RAM の最大量。RAM スライダーは、この最大値に合わせて調整されます。 |
|
| システムがワークスペースを一時停止した後にこれを停止する際に、ユーザーがワークスペースでアイドル状態になる期間 (ミリ秒単位)。アイドル状態は、ユーザーがワークスペースと対話しない期間です。つまり、エージェントのいずれも対話を受け取っていない期間を意味します。ブラウザーウィンドウを開いたままにするとアイドル状態になります。 |
|
| システムが一時停止するまでの、アクティビティーを問わず、ワークスペースが実行される期間 (ミリ秒単位)。一定期間後にワークスペースを自動的に停止する場合は、このプロパティーを設定します。デフォルトはゼロで、実行タイムアウトがないことを意味します。 |
4.1.2.13. ユーザーワークスペースの制限
表4.13 ユーザーワークスペースの制限
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| 単一ユーザーがワークスペースの実行に割り当てることができる RAM の合計量。ユーザーは、この RAM を単一のワークスペースに割り当てるか、または複数のワークスペースに分散することができます。 |
|
| ユーザーが作成できるワークスペースの最大数。追加のワークスペースを作成しようとすると、ユーザーにはエラーメッセージが表示されます。これは、実行中および停止中のワークスペースの合計数に適用されます。 |
|
| 単一ユーザーが持てる実行中のワークスペースの最大数。ユーザーがこのしきい値に達し、追加のワークスペースを開始しようとすると、エラーメッセージと共にプロンプトが表示されます。ユーザーは、実行中のワークスペースを停止してから別のワークスペースをアクティべートする必要があります。 |
4.1.2.14. 組織ワークスペースの制限
表4.14 組織ワークスペースの制限
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
| 単一組織 (チーム) がワークスペースの実行に割り当てることができる RAM の合計量。組織の所有者はこの RAM を割り当てることができますが、チームのワークスペース全体で適切に割り当てられているように見えます。 |
|
| 組織が所有できるワークスペースの最大数。追加のワークスペースを作成しようとすると、組織にはエラーメッセージが表示されます。これは、実行中および停止中のワークスペースの合計数に適用されます。 |
|
| 単一組織が持てる実行中のワークスペースの最大数。組織がこのしきい値に達し、追加のワークスペースを開始しようとすると、エラーメッセージと共にプロンプトが表示されます。組織は、実行中のワークスペースを停止してから別のワークスペースをアクティべートする必要があります。 |
4.1.2.15. マルチユーザー固有の OpenShift インフラストラクチャー設定
表4.15 マルチユーザー固有の OpenShift インフラストラクチャー設定
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
|
Keycloak に登録されている OpenShift アイデンティティープロバイダーのエイリアス。これは、現行の CodeReady Workspaces ユーザーが所有する OpenShift namespace にワークスペース OpenShift リソースを作成するために使用されます。 |
4.1.2.16. Keycloak の設定
表4.16 Keycloak の設定
環境変数名 | デフォルト値 | 詳細 |
---|---|---|
|
|
|
|
| keycloak アイデンティティープロバイダーサーバーへの内部ネットワークサービス URL |
|
|
Keycloak レルムを使用してユーザーを認証するために使用されます。 |
|
|
ダッシュボード、IDE、および CLI でユーザーを認証する |
|
| OSO OAuth トークンにアクセスするための URL |
|
| Github OAuth トークンにアクセスするための URL |
|
|
|
|
|
OIDC オプションの |
|
|
使用する Keycloak Javascript アダプターの URL。NULL に設定すると、デフォルト値が |
|
| この仕様 (Obtaining OpenID Provider Configuration Information) で詳細に検出エンドポイントを指定する別の OIDC プロバイダーのベース URL。 |
|
|
固定されたリダイレクト URL のみをサポートする別の OIDC プロバイダーを使用する場合は true に設定します。このプロパティーは、 |
|
| 定義されていない場合、JWT トークンの解析時にユーザー名の要求がユーザーの表示名として使用されます。フォールバック値は「preferred_username」です。 |
|
|
「embedded」モードまたは「delegated」モードで使用できる OAuth 認証サービスの設定。「embedded」に設定すると、サービスは、(Single User モードの場合のように) CodeReady Workspaces の OAuthAuthenticator のラッパーとして機能します。「delegated」に設定すると、サービスは Keycloak IdentityProvider メカニズムを使用します。このプロパティーが正しく設定されていない場合は、ランタイム例外 |
|
| CodeReady Workspaces データベースからユーザーを削除する際の Keycloak サーバーからのユーザーの削除を有効にするための設定。デフォルトで、これは無効にされます。CodeReady Workspaces データベースでユーザーを削除する際に Keycloak からの関連ユーザーの削除が実行される特別なケースでは有効にされある場合があります。適切に機能するには、管理ユーザー名 ${che.keycloak.admin_username} とパスワード ${che.keycloak.admin_password} を設定する必要があります。 |
|
| Keycloak 管理者のユーザー名。CodeReady Workspaces データベースからユーザーを削除する際に Keycloak からユーザーを削除するために使用します。${che.keycloak.cascade_user_removal_enabled} が 'true' に設定されている場合にのみ機能します。 |
|
| Keycloak 管理者パスワード。CodeReady Workspaces データベースからユーザーを削除する際に Keycloak からユーザーを削除するために使用します。${che.keycloak.cascade_user_removal_enabled} が 'true' に設定されている場合にのみ機能します。 |
|
|
ユーザー名の調整の設定。CodeReady Workspaces は、ユーザー名を Kubernetes オブジェクト名とラベルの一部として使用する必要があるため、アイデンティティープロバイダーが通常許可する場合よりもフォーマットの要件が厳しくなります (DNS に準拠する必要があります)。この調整は、コンマ区切りのキー/値のペアで表されます。これらは元のユーザー名の String.replaceAll 関数への引数として順次使用されます。キーは正規表現で、値は正規表現に一致するユーザー名の文字を置き換える置換文字列です。変更したユーザー名は CodeReady Workspaces データベースのみに保存され、アイデンティティープロバイダーには再び公開されません。DNS に準拠する文字を代替文字列として使用することが推奨されます (キー/値のペアの値)。例: |