5.2. CodeReady Workspaces サーバーコンポーネントコンポーネントシステムプロパティーの参照
ここでは、CodeReady Workspaces サーバーコンポーネントのすべての設定プロパティーを説明します。
表5.1 CHECE サーバー
環境変数名 | デフォルト値 | description |
---|---|---|
|
| CodeReady Workspaces が内部データオブジェクトを保存するフォルダー |
|
| API サービス。ブラウザーがこの URL を使用して CodeReady Workspaces サーバーへの REST 通信を開始する |
|
| CodeReady Workspaces websocket メジャーエンドポイント。主要な websocket 対話/テーマングの基本通信エンドポイントを提供します。 |
|
| CodeReady Workspaces websocket マイナーエンドポイント。websocket のマイナーな対話/テーマングの基本通信エンドポイントを提供します。 |
|
| プロジェクトは、CodeReady Workspaces サーバーから各ワークスペースを実行するマシンに同期されます。これは、プロジェクトがマウントされる ws ランタイムのディレクトリーです。 |
|
| プロジェクトは、CodeReady Workspaces サーバーから各ワークスペースを実行するマシンに同期されます。これは、プロジェクトが置かれるマシンのディレクトリーです。 |
|
| devfile OpenShift/os タイプコンポーネントがプロジェクト PVC の作成を要求する場合に使用されます(一意のおよびWorkspace PVC ストラテジーの場合に適用されます)。一般的な PVC ストラテジーの場合、これは che.infra.kubernetes.pvc.quantity プロパティーの値で書き換えられます。 |
|
| すべてのワークスペースログが配置されるマシン内のディレクトリーを定義します。エージェント開発者がこのディレクトリーを使用してバックアップエージェントのログに使用できるように、このフォルダーの値は環境変数などのマシンに提供する必要があります。 |
| ランタイムによって使用されるプロキシーを設定します。 | |
| ランタイムによって使用されるワークスペースの電源設定 | |
| ランタイムによるワークスペースの利用による昇格の設定 | |
|
| クラスター全体のプロキシーが設定されると、che-operator は特別な configmap を作成し、OpenShift Network Operator が ca-bundle に挿入できるようにします。さらに、この configmap の名前でキー CHE_TRUSTEDCABUNDLES__CONFIGMAP を CodeReady Workspaces サーバー configmap(および対応する ENV 変数)に追加します。そのため、プロキシーモードが有効になっているかどうかを検出できます。このプロパティーは、特に必要でない限り手動で設定する必要はありません。 |
|
| デフォルトでは、ユーザーがその URL を使用してワークスペースにアクセスすると、ワークスペースは停止すると自動的に起動します。これを無効にするには、false に設定します。 |
|
| ワークスペーススレッドプールの設定。このプールは、開始/停止などの非同期実行を必要とするワークスペース関連の操作に使用されます。使用できる値は 'fixed', 'cached' です。 |
|
| このプロパティーは、プールタイプが 'fixed' と異なる場合に無視されます。プールの正確なサイズを設定します(multiplier プロパティーが設定された場合)。このプロパティーが(0, < 0, NULL)が設定されていないと、プールサイズがコア数に切り替わります。この値は、乗数内で変更できます。 |
|
| このプロパティーは、プールタイプが「fixed」とは異なるか、または正確なプールサイズが設定されている場合に無視されます。設定した場合、プールサイズは N_CORES * multiplier になります。 |
|
| このプロパティーは、ワークスペースサーバーの liveness プローブに使用するスレッドのサイズを指定します。 |
|
| ワークスペース JVM の HTTP プロキシー設定 |
|
| ワークスペース内で実行される JVM に追加する Java コマンドラインオプション。 |
|
| ワークスペース内でエージェントを実行する JVM に追加された Maven コマンドラインオプション。 |
|
| Maven サーバーを実行する JVM に追加するデフォルトの java コマンドラインオプション。 |
|
| 環境内の RAM 設定のない各マシンに対する RAM 制限のデフォルト。0 より小さい値または 0 の値は制限の無効化として解釈されます。 |
|
| 環境に明示的な RAM 設定がない各コンテナーに対する RAM 要求のデフォルトです。この容量はワークスペースコンテナー作成に割り当てられます。この容量は、すべてのインフラストラクチャー実装でこのプロパティーがサポートされない可能性があります。現時点では、デフォルトのメモリー要求がメモリー制限を超える場合に OpenShift および OpenShift Container Platform でサポートされ、要求は無視され、制限のみが使用されます。0 より小さい値または 0 の値は要求の無効化として解釈されます。 |
|
| 環境内の CPU 設定のない各コンテナーの CPU 制限のデフォルト。浮動小数点コア数(例: 0.125)または K8S 形式の整数ミリコア(例: 125m 小さい値)、または 0 を制限の無効化として解釈することができます。 |
|
| 環境で CPU 設定のない各コンテナーに対する CPU 要求のデフォルト。デフォルトの CPU 要求が CPU の制限を超える場合、要求は無視され、制限のみが使用されます。0 より小さい値または等しい値は、この要求の無効化として解釈されます。 |
|
| CodeReady Workspaces プラグイン設定の RAM 設定のない各サイドカーの RAM 制限およびデフォルトを要求します。0 より小さい値または 0 の値は制限の無効化として解釈されます。 |
|
|
{ |
|
| CodeReady Workspaces プラグイン設定の CPU 設定のない各サイドカーの CPU 制限および要求のデフォルト。浮動小数点コア数(例: 0.125)または K8S 形式の整数ミリコア(例: 125m 小さい値)、または 0 を無効化制限として解釈することができます。 |
|
|
{ |
|
| サイドカーコンテナーのイメージプルストラテジーを定義します。使用できる値は、Always、Never、IfNotPresent です。その他の値は、未指定のポリシー(:latest タグが指定されている場合や IfNotPresent が指定されている場合)として解釈されます。 |
|
| 非アクティブなワークスペースでは、ジョブの実行が中断されます。 |
|
| アクティビティーテーブルのクリーンアップの間隔。異常な時点でサーバーがクラッシュした場合など、予期せぬエラーが発生した場合、アクティビティーテーブルには無効または古いデータを含めることができます。デフォルトでは、クリーンアップジョブを 1 時間ごとに実行します。 |
|
| 最初のアクティビティークリーンアップジョブを開始するサーバーの起動後の遅延。 |
|
| 最初のワークスペースアイドル状態チェックジョブが開始され、ws マスターが停止状態に近い期間に利用できない場合に、大量一時中断が発生しないようにするためです。 |
|
| 停止した一時的なワークスペースのクリーンアップジョブの実行期間。 |
|
| Periodof は、一時的なワークスペースのクリーンアップジョブの実行を停止しました。 |
|
| 利用できるものとして扱われる、サーバーへの連続した ping の数。注記: このプロパティーはワークスペースエージェント、ターミナル、実行など、すべてのサーバーで共通です。 |
|
| ワークスペースサーバーへの連続した ping の間隔(ミリ秒単位)。 |
|
| liveness プローブを必要とするサーバー名の一覧 |
|
| ワークスペースの起動時に che-server によって確認できる単一コンテナーから収集されるログの制限サイズ。デフォルトは 10MB=10485760 です。 |
|
| true の場合、OpenShift OAuth が有効な場合に、編集権限を持つ 'stop-workspace' ロールが 'che' ServiceAccount に付与されます。この設定は、OpenShift OAuth が有効な場合にワークスペースのアイドリングに主に必要です。 |
表5.2 templates
環境変数名 | デフォルト値 | description |
---|---|---|
|
| コードテンプレートおよびサンプルを含む JSON ファイルが含まれるフォルダー |
表5.3 認証パラメーター
環境変数名 | デフォルト値 | description |
---|---|---|
|
| CodeReady Workspaces には単一のアイデンティティー実装があるため、ユーザーエクスペリエンスは変更されません。true の場合、API レベルでユーザーの作成を有効にします。 |
|
| 認証エラーページアドレス |
| 予約ユーザー名 | |
|
| GitHub OAuth を設定して、リモートリポジトリーへの認証を自動化することができます。まず、このアプリケーションを GitHub OAuth に登録する必要があります。 |
|
| GitHub OAuth を設定して、リモートリポジトリーへの認証を自動化することができます。まず、このアプリケーションを GitHub OAuth に登録する必要があります。 |
|
| Youcansetup GitHub OAuth はリモートリポジトリーへの認証を自動化します。まず、このアプリケーションを GitHub OAuth に登録する必要があります。 |
|
| YoucansetupGitHub OAuth はリモートリポジトリーへの認証を自動化します。まず、このアプリケーションを GitHub OAuth に登録する必要があります。 |
|
| YoucansetupGitHubOAuth は、リモートリポジトリーへの認証を自動化します。まず、このアプリケーションを GitHub OAuth に登録する必要があります。 |
|
| OpenShift OAuth クライアントの設定。OpenShift OAuth トークンの取得に使用されます。 |
|
| Configurationof OpenShift OAuth クライアント。OpenShift OAuth トークンの取得に使用されます。 |
|
| ConfigurationofOpenShift OAuth クライアント。OpenShift OAuth トークンの取得に使用されます。 |
|
| ConfigurationofOpenShiftOAuth クライアント。OpenShift OAuth トークンの取得に使用されます。 |
表5.4 internal
環境変数名 | デフォルト値 | description |
---|---|---|
|
| CodeReady Workspaces 拡張機能は、実行を時間ベースでスケジュールできます。これにより、定期的なスケジュールで起動される拡張機能に割り当てられるスレッドプールのサイズを設定します。 |
|
| JAX-RS & web ソケット通信ユーザーを管理する Java Web Services ツールキットです。Neverrest に埋め込まれた非同期メカニズムを無効にします。 |
|
| 同時に処理される可能性のある非同期要求の数 |
|
| キューのサイズ。消費後に非同期リクエストを処理できない場合は、キューに追加されます。 |
|
| 要求のタイムアウト(分単位)。タイムアウトリクエストが実行されなかったり、要求の結果がクライアントに返されなかった場合は、破棄される可能性があります。 |
|
| 待機中、実行中および終了したリクエストのキャッシュのサイズ。 |
|
| 非同期サービスへのパス |
|
| DB の初期化と移行構成 |
|
| DBinitialization and migration configuration |
| DBinitialization and migration configuration | |
|
| DBinitialization andmigration configuration |
|
| DBinitialization andmigrationconfiguration |
|
| DBinitialization andmigrationconfiguration |
表5.5 Kubernetes Infra パラメーター
環境変数名 | デフォルト値 | description |
---|---|---|
| Infra が使用する Kubernetes クライアントの設定 | |
| Infra が使用する Kubernetes クライアントの設定 | |
|
| OpenShift infra でサーバーに公開される方法を定義します。CodeReady Workspaces に実装されたストラテジーの一覧: default-host、マルチホスト、シングルホスト |
|
| ワークスペースプラグインおよびエディターが単一ホストモードで公開される方法を定義します。サポート対象の公開: -「native」: OpenShift Ingress を使用したサーバーを公開します。Kubernetes でのみ動作します。 |
|
プロパティー | |
|
非推奨 - このプロパティーの値を変更しないでください。変更しないと、既存のワークスペースでデータが緩やかになります。新しいインストールでは設定しないでください。すべてのワークスペースが作成される Kubernetes namespace を定義します。設定されていない場合、すべてのワークスペースが新しい namespace に作成されます。ここで、namespace = workspace id は <username> および <userid> プレースホルダーを使用できます(例: che-workspace-<username>)。この場合、ユーザーごとに新規 namespace が作成されます。新規 namespace を作成するパーミッションを持つサービスアカウントを使用する必要があります。OpenShift infra では無視されます。代わりに | |
|
| ユーザーのワークスペースが上書きされない場合に作成される Kubernetes デフォルト namespace を定義します。<username>、<userid>、および <workspaceid> プレースホルダーを使用できます(例: che-workspace-<username>)。この場合、ユーザー(またはワークスペース)ごとに新しい namespace が作成されます。OpenShift infra によって、プロジェクトの指定に使用されます。 |
|
| ユーザーがデフォルトとは異なる Kubernetes namespace(または OpenShift プロジェクト)を指定できるかどうかを定義します。OAuth を設定せずに true を設定することは、NOT RECOMMENDED です。このプロパティーは OpenShift インフラストラクチャーによっても使用されます。 |
|
|
すべてのワークスペース Pod にバインドする必要のある Kubernetes Service Account name を定義します。Kubernetes Infrastructure はサービスアカウントを作成しないため、存在する必要がある点に注意してください。OpenShift インフラストラクチャーは、プロジェクトが事前定義されているかどうかを確認します( |
|
| オプションで、ワークスペースサービスアカウントで使用する追加のクラスターロールを指定します。クラスターロール名がすでに存在している必要があり、CodeReady Workspaces サービスアカウントは、これらのクラスターロールをワークスペースサービスアカウントに関連付けるためにロールバインディングを作成できる必要があります。名前はコンマ区切りになります。このプロパティーは 'che.infra.kubernetes.cluster_role_name' を非推奨にします。 |
|
| Kubernetes ワークスペースの開始時間を制限する期間を定義します。 |
|
| Kubernetes Ingress が準備状態になる期間を制限するタイムアウトを分単位で定義します。 |
|
| ワークスペースの起動中に、プロパティーで定義されたリカバリー不可能なイベントが発生すると、タイムアウトするまでワークスペースを直ちに終了します。これは、リカバリーできないイベントをキャッチする可能性があるため、この SHOULD NOT に mere 'Failed' 理由が含まれる可能性があるためです。失敗したコンテナーの起動は、CodeReady Workspaces サーバーによって明示的に処理されます。 |
|
| バックアッププロジェクトやログなど、SQL ワークスペースが必要とする Persistent Volume Claim(永続ボリューム要求、PVC)を使用するか、無効であるかを定義します。 |
|
| ワークスペースの PVC を選択する際に使用するストラテジーを定義します。サポートされるストラテジー: - 'common' All workspaces in the same Kubernetes Namespace は、同じ PVC を再利用します。PVC の名前は 'che.infra.kubernetes.pvc.name' で設定できます。既存の PVC が使用されるか、または新規(存在しない)が作成されます。- 各ワークスペースのボリュームについて「一意」分離 PVC が使用されます。PVC の名前は '{che.infra.kubernetes.pvc.name} + '-' + '{generated_8_chars}' として評価されます。既存の PVC が使用されるか、または新規 PVC が存在しない場合に作成されます。PVC の名前は '{che.infra.kubernetes.pvc.name} + '-' + '{WORKSPACE_ID}' として評価されます。既存の PVC が使用されるか、または新規 PVC が存在しない場合に作成されます。 |
|
| ワークスペースを起動する前に、永続ボリュームにワークスペースのサブパスディレクトリーを作成するジョブを実行するかどうかを定義します。ワークスペースのサブパスボリュームマウントとして一部のバージョンで必要となり、root パーミッションで作成されるため、ユーザーとして実行するワークスペースで変更できません(ここでは、プロジェクトを CodeReady Workspaces のワークスペースにインポートするエラーを示しています)。デフォルトは 'true' ですが、Openshift/Kubernetes のバージョンがユーザーパーミッションを持つサブディレクトリーを作成する場合は false に設定する必要があります。関連する問題: https://github.com/kubernetes/kubernetes/issues/41638 では、このプロパティーは 'common' PVC ストラテジーが使用される場合にのみ有効になります。 |
|
| che ワークスペースの PVC 名の設定を定義します。それぞれの PVC ストラテジーはこの値を異なる方法で提供します。che.infra.kubernetes.pvc.strategy プロパティーは doc を参照してください。 |
| ワークスペースの Persistent Volume Claim(永続ボリューム要求、PVC)のストレージクラスを定義します。空の文字列は 'default' を意味します。 | |
|
| che ワークスペースの Persistent Volume Claim(永続ボリューム要求、PVC)のサイズを定義します。本書は https://docs.openshift.com/container-platform/4.4/storage/understanding-persistent-storage.html で説明されています 。 |
|
| OpenShift で Persistent Volume Claim(永続ボリューム要求、PVC)メンテナンスジョブを実行する際に起動される Pod |
|
| Kubernetes/OpenShift クラスターのメンテナンスジョブに使用するコンテナーのイメージプルポリシー |
|
| Persistent Volume Claim(永続ボリューム要求、PVC)メンテナンスジョブの Pod メモリー制限を定義します。 |
|
| Persistent Volume Claim(永続ボリューム要求、PVC)アクセスモードを定義します。アクセスモードの一般的な PVC ストラテジーの変更には、同時に実行するワークスペースの数に影響することに注意してください。che が RWX アクセスモードで PV を使用している場合、(RAM、CPU など)などのシック制限設定でのみ、ワークスペースを実行する制限が制限されます。アクセスモードの詳細情報は、https://docs.openshift.com/container-platform/4.4/storage/understanding-persistent-storage.html を参照してください 。 |
|
|
CodeReady Workspaces Server が作成後に PVC がバインドされるのを待つかどうかを定義します。これはすべての PVC ストラテジーによって使用されます。 |
|
| インストーラーサーバー用に定義されたポート範囲をデフォルトで使用し、インストーラーは独自のポートを使用しますが、別のインストーラーサーバーと競合すると、OpenShift インフラストラクチャーはこの範囲から最初に使用できるようにインストーラーを再設定します。 |
|
| インストーラーサーバー用のポートの定義デフォルトで、インストーラーは独自のポートを使用しますが、別のインストーラーサーバーと競合すると、OpenShift インフラストラクチャーはこの範囲から最初に利用可能なインストーラーを再設定します。 |
|
|
公開されるサーバーに使用される Ingress のアノテーションを定義します。値は Ingress コントローラーの種類によって異なります。OpenShift インフラストラクチャーは Ingress ではなく Routes を使用するため、このプロパティーを無視します。単一ホストのデプロイメントストラテジーが機能するには、URL の書き換えに対応するコントローラーを使用する必要があります(このため、URL はアプリケーションルートの変更をサポートする必要がないときに異なるサーバーを参照できるように)。che.infra.kubernetes.ingress.path.rewrite_transform プロパティーは、URL Rewriting をサポートするために ingress のパスを変換する方法を定義し、このプロパティーは選択した Ingress コントローラーに実際に URL を書き換え、パス変換(選択した ingress コントローラーで必要な場合)を実行するように Ingress 自体のアノテーションを定義します。たとえば、nginx Ingress コントローラー 0.22.0 以降の値には、 |
|
| サーバーを公開する Ingress のパスを宣言する方法「recipe」を定義します。%s' はサーバーのベース公開 URL を表し、フォワードスラッシュで終了することが保証されます。このプロパティーは String.format()メソッドへの有効な入力で、%s' への参照を 1 つだけ含める必要があります。che.infra.kubernetes.ingress.annotations_json プロパティーの説明を参照してください。Ingress アノテーションとパスを指定する際のこれらの 2 つのプロパティーがどのように相互に対話するかを確認してください。定義されていない場合、このプロパティーはデフォルトでは:%s'(引用符なし)に設定されます。これは、Ingress コントローラーで使用するためにパスが変換されないことを意味します。 |
|
| Kubernetes Infra によって作成される Pod のセキュリティーコンテキストを定義します。これは OpenShift インフラストラクチャーによって無視されます。 |
|
| Kubernetes Infra によって作成される Pod のセキュリティーコンテキストの定義。これは OpenShift インフラストラクチャーによって無視されます。 |
|
|
Kubernetes / OpenShift インフラストラクチャーが作成する Pod の正常な終了期間を定義します。Kubernetes / OpenShift ワークスペースの Pod のデフォルトは '0' です。これにより、Pod を即時に終了し、ワークスペースを停止するために必要な時間が大幅に短縮されます。注記: |
|
|
KubernetesClient |
|
|
KubernetesClient |
|
| Kubernetes-client 共有 http クライアントの接続プールにおけるアイドル接続の最大数 |
|
| Kubernetes-client 共有 http クライアントの接続プールの keep-alive タイムアウト(分単位) |
|
| OpenShift インフラストラクチャーで Transport Layer Security(TLS)が有効になっている Ingress を作成します。ルートは TLS-enabled になります。 |
| OpenShift インフラストラクチャーが TLS に依存しない状態でワークスペース Ingress を作成する際に使用するシークレットの名前 | |
|
| Ingress およびキーに使用する必要のある TLS Secret のデータは、Base64 アルゴリズムでエンコードする必要があります。これらのプロパティーは OpenShift インフラストラクチャーによって無視されます。 |
|
| Ingress およびキーに使用する必要のある Datafor TLS Secret は、Base64 アルゴリズムでエンコードする必要があります。これらのプロパティーは OpenShift インフラストラクチャーによって無視されます。 |
|
|
ランタイムの整合性チェックを実行する期間を定義します。ランタイムに一貫性のない状態がある場合、ランタイムは自動的に停止されます。値は 0 または |
表5.6 OpenShift Infra パラメーター
環境変数名 | デフォルト値 | description |
---|---|---|
| 非推奨 - このプロパティーの値を変更しないでください。変更しないと、既存のワークスペースでデータが緩やかになります。新しいインストールでは設定しないでください。すべてのワークスペースが作成される OpenShift namespace を定義します。設定されていない場合、すべてのワークスペースが新規プロジェクトに作成されます。ここで、project name = workspace id と <userid> プレースホルダー(例: che-workspace-<username>)を使用できます。この場合、ユーザーごとに新規プロジェクトが作成されます。新規プロジェクトを作成するパーミッションのある OpenShift oauth またはサービスアカウントを使用する必要があります。このプロパティーによって参照されるプロジェクトが存在する場合は、すべてのワークスペースに使用されます。存在しない場合、che.infra.kubernetes.namespace.default によって指定された namespace が作成され、使用されます。 | |
|
| CA バンドルが Openshift 4 に保存される trust-store 設定マップの名前を設定します。このマップは、最初に CodeReady Workspaces インストーラー(演算子など)が名前で作成することになり、CodeReady Workspaces サーバーはこれをワークスペースの起動時に特定のラベル(下記参照)で検索し、同じマップを作成してワークスペースの namespace にマウントします。プロパティーは、ワークスペースの namespace でマップの名前を定義します。 |
|
| Openshift 4 の自動証明書挿入に使用される config マップのラベル名。 |
|
| CA バンドルがマウントされているワークスペースコンテナーにパスを設定します。 |
|
| シングルポートモードワイルドカードドメインホストおよびポート。nip.io がデフォルトで使用されます。 |
|
| Singleport mode wildcard domain host & port. nip.io がデフォルトで使用されます。 |
|
| IP を挿入せずに単一ポートカスタム DNS を有効にします。 |
表5.7 実験的なプロパティー
環境変数名 | デフォルト値 | description |
---|---|---|
|
| ワークスペースツール設定を解決し、プラグインの依存関係をワークスペースにコピーする CodeReady Workspaces プラグインブローカーアプリケーションの Docker イメージ |
|
|
ワークスペースツール設定を解決し、プラグインの依存関係をワークスペースにコピーする |
|
| ワークスペースツール設定を解決し、プラグインの依存関係をワークスペースにコピーする CodeReady Workspaces プラグインブローカーアプリケーションの Docker イメージ |
|
| プラグインブローカーを待機する最大期間を制限するタイムアウトを分単位で定義します。 |
|
|
ワークスペースツールプラグインレジストリーエンドポイント。有効な HTTP URL でなければなりません。 |
|
|
devfile レジストリーのエンドポイント。有効な HTTP URL でなければなりません。 |
|
| Dashboard のようなクライアントがワークスペースの作成/更新時にユーザーに提案する必要のあるストレージタイプの利用可能な値を定義する configuration プロパティー。利用可能な値: - 'persistent': Persistent Storage slow I/O but persistent. - 'ephemeral': Ephemeral Storage allow for faster I/O allow for faster I/O, not persistent. - 'async': Experimental feature: Asynchronous storage is combination of Ephemeral and Persistent storage.I/O を高速化し、変更を保持することで、開始ワークスペースの停止および復元時にバックアップが実行されます。は: - che.infra.kubernetes.pvc.strategy='common' - che.limits.user.workspaces.run.count=1 - che.infra.kubernetes.namespace.false - che.infra.kubernetes.namespace.default には <username> がリストから削除される場合にのみ機能します。 |
|
| Dashboard などのクライアントがワークスペースの作成/更新時にユーザーに提案する必要のあるストレージタイプのデフォルト値を定義する configuration プロパティー。「 async」値は実験的なため、デフォルトタイプとして推奨されません。 |
|
| 認証でセキュアなサーバーを保護する方法を設定します。適切な値 - 'default': jwtproxy はパススルーモードで設定されます。そのため、サーバーは要求を認証する必要があります。- 'jwtproxy': jwtproxy は要求を認証します。そのため、サーバーは認証されたもののみを受信します。 |
|
| 署名されていないリクエストをルーティングするための Jwtproxy 発行者文字列、トークンライフタイム、およびオプションの認証ページパス。 |
|
| 署名されていないリクエストをルーティングするための Jwtproxyissuer 文字列、トークンライフタイム、およびオプションの認証ページパス。 |
|
| 署名されていないリクエストをルーティングするための Jwtproxyissuerstring、トークンライフタイム、およびオプションの認証ページパス。 |
|
| 署名されていないリクエストをルーティングするための Jwtproxyissuerstring,token のライフタイムおよびオプションの認証ページパス。 |
|
| 署名されていないリクエストをルーティングするための Jwtproxyissuerstring,tokenlifetime およびオプションの auth ページのパス。 |
|
| 署名されていないリクエストをルーティングするための Jwtproxyissuerstring,tokenlifetimeand オプションの auth ページのパス。 |
表5.8 主要な「/websocket」エンドポイントの設定
環境変数名 | デフォルト値 | description |
---|---|---|
|
| プールサイズが超過するメッセージ実行が拒否される場合の JSON RPC 処理プールの最大サイズ。 |
|
| 初期 json 処理プール。主要な JSON RPC メッセージを処理するために使用されるスレッドの最小数。 |
|
| Json RPC メッセージを処理するために使用されるキューの設定。 |
表5.9 主要な「/websocket-minor」エンドポイントの設定
環境変数名 | デフォルト値 | description |
---|---|---|
|
| プールサイズが超過するメッセージ実行が拒否される場合の JSON RPC 処理プールの最大サイズ。 |
|
| 初期 json 処理プール。マイナー JSON RPC メッセージを処理するために使用されるスレッドの最小数。 |
|
| Json RPC メッセージを処理するために使用されるキューの設定。 |
|
| Prometheus メトリクスで公開される http サーバーエンドポイントのポート |
表5.10 CORS 設定
環境変数名 | デフォルト値 | description |
---|---|---|
|
| WS Master の CORS フィルターはデフォルトで無効になっています。環境変数 'CHE_CORS_ENABLED=true' を使用して、'cors.allowed.origins' が要求元が許可されていることを示しています。 |
|
| 'coRS.support.credentials' は、クレデンシャル(クッキー、ヘッダー、TLS クライアント証明書)によるリクエストの処理を許可するかどうかを示します。 |
表5.11 ファクトリーのデフォルト
環境変数名 | デフォルト値 | description |
---|---|---|
|
| CodeReady Workspaces 固有のワークスペース記述子を含まないリモート git リポジトリーから作成されるファクトリーに使用されるエディターおよびプラグイン(.factory.json の .devfile など)複数のプラグインはコンマ区切りである必要があります。たとえば、pluginFooPublisher/pluginFooVersion,pluginBarPublisher/pluginBarName/pluginBarVersion |
|
|
複数のプラグイン(例: pluginFooPublisher/pluginFooVersion,pluginBarPublisher/pluginBarVersion)に、 |
|
| リポジトリーベースのファクトリーを検索する devfile ファイル名(GitHub など)。ファクトリーは、プロパティーで列挙される順序でこれらのファイルを見つけようとします。 |
表5.12 devfile のデフォルト
環境変数名 | デフォルト値 | description |
---|---|---|
|
|
指定した Editor が editorPublisher/editorName |
|
|
デフォルトエディター用にプロビジョニングする必要のあるデフォルトのプラグイン。ユーザー定義の devfile で明示的に記載されていないこの一覧のプラグインはすべてプロビジョニングされますが、デフォルトのエディターが使用される場合やユーザー定義エディターがデフォルトのバージョンと同じである場合(異なるバージョンであっても)。形式は、コンマ区切りの |
|
| ユーザー namespace からシークレットを選択するためのコンマ区切りリストを定義します。これは、ファイルまたは env 変数としてワークスペースコンテナーにマウントされます。指定のラベルに一致するシークレットのみが選択されます。 |
|
| ワークスペース設定で Async ストレージ機能が有効化され、環境でサポートされる場合にプラグインが追加されました。 |
|
| CodeReady Workspaces async ストレージの Docker イメージ |
|
| 最後に使用されたワークスペースを停止した後にの非同期ストレージ Pod のシャットダウンのタイムアウト。0 より小さい値または等しい値は、シャットダウン機能の無効化として解釈されます。 |
|
| Asynchronous Storage Pod の停止機能(デフォルトでは 30 分)を実行する期間を定義します。 |
表5.13 CHECH システム
環境変数名 | デフォルト値 | description |
---|---|---|
|
| System Super Privileged モード。manageSystem パーミッションを持つユーザーに、getByKey、getByNameSpace、stopWorkspaces、および getResourcesInformation の追加パーミッションを付与します。これらはデフォルトでは管理者に付与されず、これらのパーミッションにより、管理者がこれらのワークスペースに管理者権限を付与すると共に、ワークスペースに対して可視性を得ることができます。 |
|
| 'che.admin.name' ユーザーにシステムパーミッションを付与します。すでにユーザーが存在する場合は、コンポーネントの起動中にユーザーがデータベースに永続化されるときに最初のログイン中に - であれば発生します。 |
表5.14 ワークスペースの制限
環境変数名 | デフォルト値 | description |
---|---|---|
|
| ワークスペースは、開発を行う際のユーザー向けの基本的なランタイムです。ワークスペースの作成方法や消費されるリソースを制限するパラメーターを設定できます。新しいワークスペースの作成時にユーザーがワークスペースに割り当てることができる RAM の最大量。RAM スライザーはこの最大値に調整されます。 |
|
| システムがワークスペースを一時停止し、停止する際に、ユーザーがワークスペースでアイドル状態である期間。Idleness は、ユーザーがワークスペースと対話していない期間で、エージェントの 1 つが対話を受信していないことを意味します。ブラウザーウィンドウがアイドル状態のままになる |
|
| システムが一時停止するまでの、アクティビティーに関係なくワークスペースが実行される期間(ミリ秒単位)。一定期間後にワークスペースを自動的に停止する場合は、このプロパティーを設定します。デフォルトはゼロです。つまり、実行タイムアウトは発生しません。 |
表5.15 ユーザーワークスペースの制限
環境変数名 | デフォルト値 | description |
---|---|---|
|
| 1 人のユーザーが稼働中のワークスペースに割り当てることができる RAM の合計容量。ユーザーはこの RAM を 1 つのワークスペースに割り当てたり、複数のワークスペースに分散したりできます。 |
|
| ユーザーが作成できるワークスペースの最大数。ユーザーは、追加のワークスペースを作成しようとするとエラーメッセージが表示されます。これは、稼働中のワークスペースと停止したワークスペースの合計数に適用されます。 |
|
| 単一ユーザーが使用できる稼働中のワークスペースの最大数。ユーザーがこのしきい値に達し、追加のワークスペースを開始しようとすると、エラーメッセージが出力されます。ユーザーは実行中のワークスペースを停止して別のワークスペースをアクティベートする必要があります。 |
表5.16 組織ワークスペースの制限
環境変数名 | デフォルト値 | description |
---|---|---|
|
| 1 つの組織(team)が実行中のワークスペースに割り当てることができる RAM の合計容量。組織の所有者はこの RAM を割り当てることができますが、チームのワークスペース全体に適しています。 |
|
| 組織が所有できるワークスペースの最大数。追加のワークスペースを作成しようとすると、組織にエラーメッセージが表示されます。これは、稼働中のワークスペースと停止したワークスペースの合計数に適用されます。 |
|
| 1 つの組織が許可される稼働中のワークスペースの最大数。組織がこのしきい値に達し、追加のワークスペースを開始しようとすると、エラーメッセージが出力されます。組織は実行中のワークスペースを停止して別のワークスペースをアクティベートする必要があります。 |
|
| メール通知に使用されるアドレス |
表5.17 組織への通知設定
環境変数名 | デフォルト値 | description |
---|---|---|
|
| 組織に関する通知のサイレントおよびテンプレート |
|
| Organizationnotifications sunjects and templates |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
表5.18 マルチユーザー固有の OpenShift インフラストラクチャーの設定
環境変数名 | デフォルト値 | description |
---|---|---|
|
|
Keycloak に登録された Openshift アイデンティティープロバイダーのエイリアス。現在の CodeReady Workspaces ユーザーが所有する Openshift namespace でワークスペース OpenShift リソースを作成するために使用されます。 |
表5.19 Keycloak の設定
環境変数名 | デフォルト値 | description |
---|---|---|
|
|
|
|
|
Keycloak レルムは、 |
|
| Dashboard、ide、および cli がユーザーを認証するために使用する che.keycloak.realm の Keycloak クライアント ID |
表5.20 redhat Che 固有の設定
環境変数名 | デフォルト値 | description |
---|---|---|
|
| OSO oauth トークンにアクセスするための URL |
|
| Github oauth トークンにアクセスするための URL |
|
| exp または nbf の要求を検証する際にクロックスキューに対して許容する秒数。 |
|
|
OIDC オプションの |
|
|
使用する Keycloak Javascript アダプターへの URL。NULL に設定した場合、デフォルト値は |
|
| 以下の仕様で詳細に説明されているように、検出エンドポイントを提供する代替 OIDC プロバイダーのベース URL 。 |
|
|
修正されたリダイレクト URL のみをサポートする代替 OIDC プロバイダーを使用する場合は true に設定します。 |
|
| フォールバック値が「preferred_username」で定義されていない場合は、JWT トークンの解析時にユーザー名として使用するユーザー名要求 |
|
| 'embedded' または 'Delegated' モードで使用できる OAuth 認証サービスの設定。'embedded' に設定すると、サービスは CodeReady Workspaces の OAuthAuthenticator にラッパーとして機能します(Single User モード)。「委譲」に設定すると、サービスは Keycloak IdentityProvider メカニズムを使用します。このプロパティーが適切に設定されていない場合は、ランタイム例外wii がスローされます。 |