第1章 Dev Spaces のスタートガイド

新しいワークスペースを開始するための URL は、次の URL 構文で & を使用することにより、複数の任意の URL パラメーターの連結をサポートします。

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?<url_parameter_1>&<url_parameter_2>&<url_parameter_3>

https://<openshift_dev_spaces_fqdn> 1
#https://github.com/che-samples/cpp-hello-world 2
?new&che-editor=che-incubator/intellij-community/latest&devfilePath=tests/testdevfile.yaml 3

URL パラメーター che-editor= を使用して、ワークスペースの開始時にサポートされている IDE を指定できます。

このパラメーターは、次の 2 種類の値を受け入れます。

editor-image パラメーターを使用して、ワークスペースのカスタム IDE イメージを設定できます。

IDE イメージをオーバーライドする URL パラメーターは editor-image= です。

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?editor-image=<container_registry/image_name:image_tag>

または

https://<openshift_dev_spaces_fqdn>#https://github.com/eclipse-che/che-docs?che-editor=che-incubator/che-code/latest&editor-image=quay.io/che-incubator/che-code:next

新しいワークスペースを開始するために URL にアクセスすると、devfile に従って、リンクされた Git リポジトリーのクローンを使用して新しいワークスペースが作成されます。

状況によっては、devfile とリンクされた Git リポジトリーに関して重複する複数のワークスペースが必要になる場合があります。これを行うには、同じ URL にアクセスして、URL パラメーターを使用して新しいワークスペースを開始します。

複製ワークスペースを開始するための URL パラメーターは new です。

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?new

新しいワークスペースを開始するために URL にアクセスすると、OpenShift Dev Spaces は、リンクされた Git リポジトリーで、ファイル名が .devfile.yaml または devfile.yaml の devfile を検索します。リンクされた Git リポジトリー内の devfile は、このファイル命名規則に従う必要があります。

状況によっては、devfile に別の型にはまらないファイル名を指定する必要がある場合があります。

devfile の型にはまらないファイル名を指定するための URL パラメーターは df=<filename>.yaml です。

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?df=<filename>.yaml 1

新しいワークスペースを開始するために URL にアクセスすると、OpenShift Dev Spaces は、リンクされた Git リポジトリーの root ディレクトリーで、ファイル名が .devfile.yaml または devfile.yaml の devfile を検索します。リンクされた Git リポジトリー内の devfile のファイルパスは、このパス規則に従う必要があります。

状況によっては、リンクされた Git リポジトリー内の devfile に別の型にはまらないファイルパスを指定する必要がある場合があります。

devfile の型にはまらないファイルパスを指定するための URL パラメーターは devfilePath=<relative_file_path> です。

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?devfilePath=<relative_file_path> 1

新規ワークスペースを起動する URL にストレージタイプを指定する URL パラメーターが含まれていない場合、新規ワークスペースは一時ストレージまたは永続ストレージに作成されます。これは、CheCluster カスタムリソースのデフォルトストレージタイプとして定義されます。

ワークスペースのストレージタイプを指定する URL パラメーターは、storageType= <storage_type> です。

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?storageType=<storage_type> 1

新しいワークスペースを開始するための URL にアクセスすると、OpenShift Dev Spaces は origin リモートを、組織の OpenShift Dev Spaces インスタンスの FQDN URL の後に # で指定した Git リポジトリーになるように設定します。

ワークスペースの追加のリモートを複製および設定するための URL パラメーターは、remotes= です。

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?remotes={{<name_1>,<url_1>},{<name_2>,<url_2>},{<name_3>,<url_3>},...}

次のシナリオでは、image パラメーターを使用して、コンテナーイメージへのカスタム参照を使用できます。

コンテナーイメージへのパスの URL パラメーターは image= です。

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?image=<container_image_url>