Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

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

組織ですでに OpenShift Dev Spaces インスタンスを実行している場合は、新しいワークスペースを開始し、ワークスペースを管理し、ワークスペースから Git サーバーに対して自分自身を認証する方法を学習することで、新しいユーザーとして開始できます。

1.1. Git リポジトリー URL からのワークスペースの開始
リンクのコピー

この手順のコンテキストでは、「Git リポジトリー URL」はリポジトリーの git クローン URL を指します。通常、SCM リポジトリーのメインページにある Clone タンをクリックすると、この URL を取得できます。または、リポジトリーのメインページにアクセスしている場合は、ブラウザーのアドレスバーから URL をコピーすることもできます。ブランチまたはタグを選択すると、URL に参照パラメーターが追加されます。

注記

GitHub の場合は、devfile があるディレクトリーのリポジトリー URL、または devfile のリポジトリー URL を使用することもできます。devfile の名前は devfile.yaml または .devfile.yaml にする必要があります。

この機能は他の Git プロバイダーではサポートされていません。

OpenShift Dev Spaces を使用すると、ブラウザーで URL を使用して、Git リポジトリーのクローンを含む新しいワークスペースを開始できます。このようにして、GitHub、GitLab、Bitbucket、または Microsoft Azure DevOps サーバーインスタンスでホストされている Git リポジトリーのクローンを作成できます。

ヒント

OpenShift Dev Spaces ダッシュボードの Create Workspace ページにある Git Repository URL フィールドを使用して、Git リポジトリーの URL を入力し、新しいワークスペースを開始することもできます。

重要
  • SSH URL を使用して新しいワークスペースを開始する場合は、SSH キーを伝播する必要があります。詳細は、Git 操作に SSH キーを使用するための DevWorkspaces の設定 を参照してください。
  • SSH URL がプライベートリポジトリーを参照する場合は、devfile.yaml コンテンツを取得できるようにアクセストークンを適用する必要があります。これは、SCM 認証ページの受け入れ、または パーソナルアクセストークン 手順の実行のいずれかで実行できます。
重要

プライベートリポジトリーにアクセスできるように、パーソナルアクセストークンを設定します。「Git プロバイダーアクセストークンの使用」 を参照してください。

前提条件

  • 組織に、OpenShift Dev Spaces の実行中のインスタンスがある。
  • 組織の OpenShift Dev Spaces インスタンスの FQDN URL はわかっています: https://<openshift_dev_spaces_fqdn>
  • オプション: Git サーバーへの認証 が設定されています。

  • Git リポジトリーのメンテナーは、devfile.yaml または .devfile.yaml ファイルを Git リポジトリーのルートディレクトリーに保持します。(代替ファイル名とファイルパスは、「新しいワークスペースを開始するための URL の任意のパラメーター」 を参照してください。)

    ヒント

    devfile を含まない Git リポジトリーの URL を指定して、新しいワークスペースを開始することもできます。これにより、Universal Developer Image and with Microsoft Visual Studio Code - Open Source をワークスペース IDE として使用するワークスペースが作成されます。

手順

Git リポジトリーのクローンを使用して新しいワークスペースを開始するには、以下を行います。

  1. オプション: OpenShift Dev Spaces ダッシュボードページにアクセスして、組織の OpenShift Dev Spaces のインスタンスを認証します。

  2. URL にアクセスして、基本的な構文を使用して新しいワークスペースを開始します。 

    https://<openshift_dev_spaces_fqdn>#<git_repository_url>
    Copy to Clipboard Toggle word wrap
    ヒント

    この URL は、任意のパラメーターを使用して拡張できます。 

    https://<openshift_dev_spaces_fqdn>#<git_repository_url>?<optional_parameters>
    1
    Copy to Clipboard Toggle word wrap
    1
    「新しいワークスペースを開始するための URL の任意のパラメーター」 を参照してください。
    ヒント

    Git+SSH URL を使用して、新しいワークスペースを開始できます。Git 操作に SSH キーを使用するための DevWorkspaces の設定 を参照してください。

    例1.1 新しいワークスペースを開始するための URL

    • https://<openshift_dev_spaces_fqdn>#https://github.com/che-samples/cpp-hello-world
    • https://<openshift_dev_spaces_fqdn>#git@github.com:che-samples/cpp-hello-world.git

    例1.2 GitHub インスタンスリポジトリーのクローンを使用して、新しいワークスペースを開始するための URL 構文

    • https://<openshift_dev_spaces_fqdn>#https://<github_host>/<user_or_org>/<repository> は、デフォルトブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#https://<github_host>/<user_or_org>/<repository>/tree/<branch_name> は、指定されたブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#https://<github_host>/<user_or_org>/<repository>/pull/<pull_request_id> は、プルリクエストのブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#git@<github_host>:<user_or_org>/<repository>.git は、Git+SSH URL から新しいワークスペースを開始します。

    例1.3 GitLab インスタンスリポジトリーのクローンを使用して、新しいワークスペースを開始するための URL 構文

    • https://<openshift_dev_spaces_fqdn>#https://<gitlab_host>/<user_or_org>/<repository> は、デフォルトブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#https://<gitlab_host>/<user_or_org>/<repository>/-/tree/<branch_name> は、指定されたブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#git@<gitlab_host>:<user_or_org>/<repository>.git は、Git+SSH URL から新しいワークスペースを開始します。

    例1.4 BitBucket Server リポジトリーのクローンを使用して新しいワークスペースを開始するための URL 構文

    • https://<openshift_dev_spaces_fqdn>#https://<bb_host>/scm/<project-key>/<repository>.git は、デフォルトブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#https://<bb_host>/users/<user_slug>/repos/<repository>/ は、リポジトリーがユーザープロファイルの下に作成された場合、デフォルトブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#https://<bb_host>/users/<user-slug>/repos/<repository>/browse?at=refs%2Fheads%2F<branch-name> は、指定されたブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#git@<bb_host>:<user_slug>/<repository>.git は、Git+SSH URL から新しいワークスペースを開始します。

    例1.5 Microsoft Azure DevOps Git リポジトリーのクローンを使用して新しいワークスペースを開始するための URL 構文

    • https://<openshift_dev_spaces_fqdn>#https://<organization>@dev.azure.com/<organization>/<project>/_git/<repository> は、デフォルトのブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#https://<organization>@dev.azure.com/<organization>/<project>/_git/<repository>?version=GB<branch> は、特定のブランチのクローンを使用して、新しいワークスペースを開始します。
    • https://<openshift_dev_spaces_fqdn>#git@ssh.dev.azure.com:v3/<organization>/<project>/<repository> は、Git+SSH URL から新しいワークスペースを開始します。

    ブラウザータブで新しいワークスペースを開始するための URL を入力すると、ワークスペース開始ページが表示されます。

    新しいワークスペースの準備ができると、ワークスペース IDE がブラウザータブにロードされます。

    Git リポジトリーのクローンは、新しいワークスペースのファイルシステムに存在します。

    ワークスペースには、次のような一意の URL があります: https://<openshift_dev_spaces_fqdn>/<user_name>/<unique_url>

関連情報

1.1.1. 新しいワークスペースを開始するための URL の任意のパラメーター
リンクのコピー

新しいワークスペースを開始すると、OpenShift Dev Spaces は devfile の指示に従ってワークスペースを設定します。URL を使用して新しいワークスペースを開始する場合は、ワークスペースをさらに設定する任意のパラメーターを URL に追加できます。これらのパラメーターを使用して、ワークスペース IDE を指定し、複製ワークスペースを開始し、devfile ファイル名またはパスを指定できます。

1.1.1.1. URL パラメーターの連結
リンクのコピー

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

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

例1.6 Git リポジトリーの URL と任意の URL パラメーターを使用して新しいワークスペースを開始するための URL

ブラウザーの完全な URL:

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

URL の部分の説明: 

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
Copy to Clipboard Toggle word wrap
1
OpenShift Dev Spaces URL
2
新しいワークスペースに複製される Git リポジトリーの URL。
3
連結された任意の URL パラメーター。

1.1.1.2. IDE の URL パラメーター
リンクのコピー

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

ヒント

ソースコード Git リポジトリーで /.che/che-editor.yaml ファイルを追加または編集して、ワークスペース用に複製できない場合は、che-editor= パラメーターを使用します。

注記

che-editor= パラメーターは /.che/che-editor.yaml ファイルをオーバーライドします。

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

  • che-editor=<editor_key> 

    https://<openshift_dev_spaces_fqdn>#<git_repository_url>?che-editor=<editor_key>
    Copy to Clipboard Toggle word wrap
    Expand
    表1.1 サポートされている IDE の URL パラメーター <editor_key> の値
    IDEステータス<editor_key> 値注記

    Microsoft Visual Studio Code - Open Source

    利用可能

    • che-incubator/che-code/latest
    • che-incubator/che-code/insiders
    • latest は、URL パラメーターまたは che-editor.yaml が使用されていない場合に新しいワークスペースに読み込まれるデフォルトの IDE です。
    • insiders は開発版です。

    JetBrains IntelliJ IDEA コミュニティー版

    非推奨

    • che-incubator/che-idea/latest
    • che-incubator/che-idea/next
    • latest は安定版です。
    • next 開発版です。

    JetBrains IntelliJ IDEA Ultimate Edition (JetBrains Gateway 経由)

    テクノロジープレビュー

    • che-incubator/che-idea-server/latest
    • che-incubator/che-idea-server/next
    • latest は安定版です。
    • next 開発版です。

  • che-editor=<url_to_a_file> 

    https://<openshift_dev_spaces_fqdn>#<git_repository_url>?che-editor=<url_to_a_file>
    1
    Copy to Clipboard Toggle word wrap
    1
    devfile の内容 を含むファイルへの URL。
    ヒント
    • URL は、RAW ファイルの内容を指している必要があります。
    • このパラメーターを che-editor.yaml ファイルで使用するには、ファイルを別の名前またはパスでコピーし、ファイルから inline の行を削除します。

1.1.1.3. IDE イメージの URL パラメーター
リンクのコピー

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

重要
  • Git リポジトリーに /.che/che-editor.yaml ファイルが含まれていると、カスタムエディターが新しい IDE イメージで上書きされます。
  • Git リポジトリーに /.che/che-editor.yaml ファイルがない場合は、デフォルトのエディターが新しい IDE イメージで上書きされます。
  • サポートされている IDE をオーバーライドしてターゲットエディターイメージを変更する場合は、che-editor と editor-image URL パラメーターの両方を一緒に使用できます。

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

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?editor-image=<container_registry/image_name:image_tag>
Copy to Clipboard Toggle word wrap

以下に例を示します。

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

or

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

1.1.1.4. 重複するワークスペースを開始するための URL パラメーター
リンクのコピー

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

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

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

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?new
Copy to Clipboard Toggle word wrap
注記

現在 URL の使用を開始したワークスペースがある場合、new URL パラメーターを指定せずに URL に再度アクセスすると、エラーメッセージが表示されます。

1.1.1.5. devfile ファイル名の URL パラメーター
リンクのコピー

新しいワークスペースを開始するために 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
Copy to Clipboard Toggle word wrap
1
<filename>.yaml は、リンクされた Git リポジトリー内の devfile の型にはまらないファイル名です。
ヒント

df=<filename>.yaml パラメーターにも長いバージョン (devfilePath=<filename>.yaml) があります。

1.1.1.6. devfile ファイルパスの URL パラメーター
リンクのコピー

新しいワークスペースを開始するために 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
Copy to Clipboard Toggle word wrap
1
<relative_file_path> は、リンクされた Git リポジトリー内の devfile の型にはまらないファイルパスです。

1.1.1.7. ワークスペースストレージの URL パラメーター
リンクのコピー

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

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

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?storageType=<storage_type>
1
Copy to Clipboard Toggle word wrap
1
使用できる <storage_type> の値:
  • ephemeral
  • per-user (永続)
  • per-workspace (永続)
ヒント

ephemeral または per-workspace ストレージタイプを使用すると、複数のワークスペースを同時に実行できますが、これはデフォルト per-user ストレージタイプでは不可能です。

関連情報

1.1.1.8. 追加のリモートの URL パラメーター
リンクのコピー

新しいワークスペースを開始するための 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>},...}
Copy to Clipboard Toggle word wrap
重要
  • 追加のリモートのいずれにも origin という名前を入力しない場合、<git_repository_url> からのリモートが複製され、デフォルトで origin という名前が付けられ、想定されるブランチが自動的にチェックアウトされます。
  • 追加のリモートの 1 つに名前 origin を入力すると、そのデフォルトブランチは自動的にチェックアウトされますが、<git_repository_url> からのリモートはワークスペース用に複製されません。

1.1.1.9. コンテナーイメージの URL パラメーター
リンクのコピー

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

  • Git リポジトリーに devfile が含まれていないため、カスタムイメージを使用して新しいワークスペースを開始したい場合。
  • Git リポジトリーには devfile が含まれており、devfile の components セクションにリストされている最初のコンテナーイメージをオーバーライドしたい場合。

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

https://<openshift_dev_spaces_fqdn>#<git_repository_url>?image=<container_image_url>
Copy to Clipboard Toggle word wrap

例

https://<openshift_dev_spaces_fqdn>#https://github.com/eclipse-che/che-docs?image=quay.io/devfile/universal-developer-image:ubi8-latest

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat