3.3.2.2. OpenShift Dev Spaces サーバーコンポーネントのシステムプロパティーの参照
以下のドキュメントでは、OpenShift Dev Spaces サーバーコンポーネントの可能な設定プロパティーをすべて説明します。
3.3.2.2.1. OpenShift Dev Spaces サーバー
3.3.2.2.1.1. CHE_API
API サービス。ブラウザーは、この URL を使用して OpenShift Dev Spaces サーバーへの REST 通信を開始します。
- デフォルト
-
http://${CHE_HOST}:${CHE_PORT}/api
3.3.2.2.1.2. CHE_API_INTERNAL
API サービスの内部ネットワーク URL。バックエンドサービスは、この URL を使用して OpenShift Dev Spaces サーバーへの REST 通信を開始する必要があります。
- デフォルト
-
NULL
3.3.2.2.1.3. CHE_WEBSOCKET_ENDPOINT
OpenShift Dev Spaces WebSocket の主なエンドポイント。主な websocket の対話とメッセージング用の基本的な通信エンドポイントを提供します。
- デフォルト
-
ws://${CHE_HOST}:${CHE_PORT}/api/websocket
3.3.2.2.1.4. CHE_WEBSOCKET_INTERNAL_ENDPOINT
OpenShift Dev Spaces WebSocket の主な内部エンドポイント。主な websocket の対話とメッセージング用の基本的な通信エンドポイントを提供します。
- デフォルト
-
NULL
3.3.2.2.1.5. CHE_WORKSPACE_PROJECTS_STORAGE
プロジェクトは、OpenShift Dev Spaces サーバーから、各ワークスペースを実行するマシンに同期されます。これは、プロジェクトが配置されているマシンのディレクトリーです。
- デフォルト
-
/projects
3.3.2.2.1.6. CHE_WORKSPACE_PROJECTS_STORAGE_DEFAULT_SIZE
devfile 要求の OpenShift タイプのコンポーネントがプロジェクト PVC 作成を要求する場合に使用されます (unique および 'per workspace PVC ストラテジーの場合に適用されます。common PVC ストラテジーの場合は、これは che.infra.kubernetes.pvc.quantity プロパティーの値で書き換えられます)。
- デフォルト
-
1Gi
3.3.2.2.1.7. CHE_WORKSPACE_LOGS_ROOT__DIR
すべてのワークスペースログが置かれるマシン内のディレクトリーを定義します。環境変数などの値として、この値をマシンに指定します。これは、エージェントの開発者がこのディレクトリーを使用してエージェントのログをバックアップできるようにするためのものです。
- デフォルト
-
/workspace_logs
3.3.2.2.1.8. CHE_WORKSPACE_HTTP__PROXY
環境変数 HTTP_PROXY は、ワークスペースを起動するコンテナーで指定された値に設定します。
- デフォルト
- empty
3.3.2.2.1.9. CHE_WORKSPACE_HTTPS__PROXY
環境変数 HTTPS_PROXY は、ワークスペースを起動するコンテナーで指定された値に設定します。
- デフォルト
- empty
3.3.2.2.1.10. CHE_WORKSPACE_NO__PROXY
環境変数 NO_PROXY は、ワークスペースを起動するコンテナーで指定された値に設定します。
- デフォルト
- empty
3.3.2.2.1.11. CHE_WORKSPACE_AUTO__START
デフォルトでは、ユーザーがこの URL を使用してワークスペースにアクセスすると、ワークスペースは自動的に起動します (現時点で停止している場合)。この動作を無効にするには、このパラメーターを false に設定します。
- デフォルト
-
true
3.3.2.2.1.12. CHE_WORKSPACE_POOL_TYPE
ワークスペーススレッドプールの設定。このプールは、非同期の実行が必要なワークスペース関連の操作 (例: 起動/停止) に使用されます。設定可能な値は fixed および cached です。
- デフォルト
-
固定:
3.3.2.2.1.13. CHE_WORKSPACE_POOL_EXACT__SIZE
プールタイプが fixed と異なる場合に、このプロパティーは無視されます。これはプールのサイズを設定します。設定されると、multiplier プロパティーは無視されます。このプロパティーが設定されていない場合 (0, <0, NULL)、プールサイズはコア数と等しくなります。che.workspace.pool.cores_multiplier も参照してください。
- デフォルト
-
30
3.3.2.2.1.14. CHE_WORKSPACE_POOL_CORES__MULTIPLIER
プールタイプが fixed に設定されておらず、che.workspace.pool.exact_size が設定されている場合は、このプロパティーは無視されます。設定されている場合、プールサイズは N_CORES * multiplier になります。
- デフォルト
-
2
3.3.2.2.1.15. CHE_WORKSPACE_PROBE__POOL__SIZE
このプロパティーは、ワークスペースサーバーの liveness プローブに使用するスレッドの数を指定します。
- デフォルト
-
10
3.3.2.2.1.16. CHE_WORKSPACE_HTTP__PROXY__JAVA__OPTIONS
ワークスペース JVM の HTTP プロキシー設定。
- デフォルト
-
NULL
3.3.2.2.1.17. CHE_WORKSPACE_JAVA__OPTIONS
ワークスペースで実行されている JVM に追加される Java コマンドラインオプション。
- デフォルト
-
-XX:MaxRAM=150m-XX:MaxRAMFraction=2 -XX:+UseParallelGC -XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=20 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xms20m -Djava.security.egd=file:/dev/./urandom
3.3.2.2.1.18. CHE_WORKSPACE_MAVEN__OPTIONS
ワークスペースでエージェントを実行する JVM に追加される Maven コマンドラインオプション。
- デフォルト
-
-XX:MaxRAM=150m-XX:MaxRAMFraction=2 -XX:+UseParallelGC -XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=20 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xms20m -Djava.security.egd=file:/dev/./urandom
3.3.2.2.1.19. CHE_WORKSPACE_DEFAULT__MEMORY__LIMIT__MB
環境に RAM 設定のない各マシンの RAM 制限のデフォルト。0 以下の値値は、制限を無効にするものとして解釈されます。
- デフォルト
-
1024
3.3.2.2.1.20. CHE_WORKSPACE_DEFAULT__MEMORY__REQUEST__MB
環境内に明示的な RAM 設定のない各コンテナーの RAM 要求。この量はワークスペースコンテナーの作成時に割り当てられます。このプロパティーは、すべてのインフラストラクチャー実装でサポートされる訳ではありません。現時点で、これは OpenShift によってサポートされます。メモリー制限を超えるメモリー要求は無視され、制限サイズのみが使用されます。0 以下の値値は、制限を無効にするものとして解釈されます。
- デフォルト
-
200
3.3.2.2.1.21. CHE_WORKSPACE_DEFAULT__CPU__LIMIT__CORES
環境に CPU 設定のない各コンテナーの CPU 制限。浮動小数点のコア数 (例: 0.125) で、または Kubernetes 形式 (125m などの整数のミリコア数) を使用して指定します。0 以下の値値は、制限を無効にするものとして解釈されます。
- デフォルト
-
-1
3.3.2.2.1.22. CHE_WORKSPACE_DEFAULT__CPU__REQUEST__CORES
環境内に CPU 設定のない各コンテナーの CPU 要求。CPU 制限を超える CPU 要求は無視され、制限の数値のみが使用されます。0 以下の値値は、制限を無効にするものとして解釈されます。
- デフォルト
-
-1
3.3.2.2.1.23. CHE_WORKSPACE_SIDECAR_DEFAULT__MEMORY__LIMIT__MB
OpenShift Dev Spaces プラグイン設定に RAM 設定のない各サイドカーの RAM 制限。0 以下の値値は、制限を無効にするものとして解釈されます。
- デフォルト
-
128
3.3.2.2.1.24. CHE_WORKSPACE_SIDECAR_DEFAULT__MEMORY__REQUEST__MB
OpenShift Dev Spaces プラグイン設定に RAM 設定のない各サイドカーの RAM 要求。
- デフォルト
-
64
3.3.2.2.1.25. CHE_WORKSPACE_SIDECAR_DEFAULT__CPU__LIMIT__CORES
OpenShift Dev Spaces プラグイン設定に CPU 設定のない各サイドカーの CPU 制限のデフォルト。浮動小数点のコア数 (例: 0.125) で、または Kubernetes 形式 (125m などの整数のミリコア数) を使用して指定します。0 以下の値値は、制限を無効にするものとして解釈されます。
- デフォルト
-
-1
3.3.2.2.1.26. CHE_WORKSPACE_SIDECAR_DEFAULT__CPU__REQUEST__CORES
OpenShift Dev Spaces プラグイン設定に CPU 設定のない各サイドカーの CPU 要求のデフォルト。浮動小数点のコア数 (例: 0.125) で、または Kubernetes 形式 (125m などの整数のミリコア数) を使用して指定します。
- デフォルト
-
-1
3.3.2.2.1.27. CHE_WORKSPACE_SIDECAR_IMAGE__PULL__POLICY
サイドカーのイメージプルストラテジーを定義します。使用できる値は Always、Never、IfNotPresent です。その他の値については、Always は :latest タグが付いたイメージに、その他の場合は IfNotPresent が想定されます。
- デフォルト
-
Always
3.3.2.2.1.28. CHE_WORKSPACE_ACTIVITY__CHECK__SCHEDULER__PERIOD__S
非アクティブなワークスペースの一時停止ジョブの実行期間。
- デフォルト
-
60
3.3.2.2.1.29. CHE_WORKSPACE_ACTIVITY__CLEANUP__SCHEDULER__PERIOD__S
アクティビティーテーブルのクリーンアップ期間。アクティビティーテーブルには、サーバーが特定の時点で障害が発生するなどの予想されないエラーが生じる場合に、無効なデータまたは古いデータを含まれることがあります。デフォルトでは、クリーンアップジョブは 1 時間ごとに実行されます。
- デフォルト
-
3600
3.3.2.2.1.30. CHE_WORKSPACE_ACTIVITY__CLEANUP__SCHEDULER__INITIAL__DELAY__S
サーバーの起動後から最初のアクティビティーのクリーンアップジョブを開始するまでの遅延。
- デフォルト
-
60
3.3.2.2.1.31. CHE_WORKSPACE_ACTIVITY__CHECK__SCHEDULER__DELAY__S
OpenShift Dev Spaces サーバーが非アクティブタイムアウトに近い期間利用できない場合に、マスカレードチェックジョブが開始されるまでの遅延。
- デフォルト
-
180
3.3.2.2.1.32. CHE_WORKSPACE_CLEANUP__TEMPORARY__INITIAL__DELAY__MIN
一時ワークスペースのクリーンアップジョブの最初の実行を遅延させる時間。
- デフォルト
-
5
3.3.2.2.1.33. CHE_WORKSPACE_CLEANUP__TEMPORARY__PERIOD__MIN
実行を終了してから次の一時的なワークスペースのクリーンアップジョブの実行を開始するまでの間に遅延する時間
- デフォルト
-
180
3.3.2.2.1.34. CHE_WORKSPACE_SERVER_PING__SUCCESS__THRESHOLD
サーバーへの正常に順次実行される ping の数。この数を超えると、サーバーは利用可能な状態にあるものとして処理されます。OpenShift Dev Sspaces Operator: このプロパティーは、ワークスペース、エージェント、ターミナル、exec などの全サーバーに共通します。
- デフォルト
-
1
3.3.2.2.1.35. CHE_WORKSPACE_SERVER_PING__INTERVAL__MILLISECONDS
ワークスペースサーバーへの連続する ping の間隔 (ミリ秒単位)。
- デフォルト
-
3000
3.3.2.2.1.36. CHE_WORKSPACE_SERVER_LIVENESS__PROBES
liveness プローブを必要とするサーバー名の一覧
- デフォルト
-
wsagent/http,exec-agent/http,terminal,theia,jupyter,dirigible,cloud-shell,intellij
3.3.2.2.1.37. CHE_WORKSPACE_STARTUP__DEBUG__LOG__LIMIT__BYTES
ワークスペースの起動をデバッグする際に che-server で観察される単一コンテナーから収集されるログの制限サイズ。デフォルト値は 10MB=10485760 です。
- デフォルト
-
10485760
3.3.2.2.1.38. CHE_WORKSPACE_STOP_ROLE_ENABLED
true の場合、OpenShift OAuth が有効な場合に、編集権限を持つ「stop-workspace」ロールが「che」 ServiceAccount に付与されます。この設定は、OpenShift OAuth が有効な場合にワークスペースのアイドリングに主に必要になります。
- デフォルト
-
true
3.3.2.2.1.39. CHE_DEVWORKSPACES_ENABLED
DevWorkspaces を有効にして OpenShift Dev Spaces をデプロイするかどうかを指定します。このプロパティーは、DevWorkspaces のサポートもインストールされている場合、OpenShift DevSpacesOperator によって設定されます。このプロパティーは、このファクトを OpenShift Dev Spaces ダッシュボードにアドバタイズするために使用されます。このプロパティーの値を手動で変更することは推奨されません。
- デフォルト
-
false
