Chapter 1. Get started with OpenShift Dev Spaces

Procedure

1. Optional: Visit your OpenShift Dev Spaces dashboard pages to authenticate to your organization’s instance of OpenShift Dev Spaces.

2. Enter the URL in your browser or in the Git Repository URL field on the Create Workspace page to start a new workspace:

   https://<openshift_dev_spaces_fqdn>#<git_repository_url>

   To append optional parameters, add ?<optional_parameters> to the URL. See Chapter 2, Optional parameters for the URLs for starting a new workspace for supported parameters.

   For example:

   • 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

     URL syntax per Git provider:

     Expand

     Table 1.1. GitHub

     URL pattern
     Default branch: https://<openshift_dev_spaces_fqdn>#https://<github_host>/<user_or_org>/<repository>
     Specified branch: https://<openshift_dev_spaces_fqdn>#https://<github_host>/<user_or_org>/<repository>/tree/<branch_name>
     Pull request branch: https://<openshift_dev_spaces_fqdn>#https://<github_host>/<user_or_org>/<repository>/pull/<pull_request_id>
     Git+SSH: https://<openshift_dev_spaces_fqdn>#git@<github_host>:<user_or_org>/<repository>.git

     Show more

     For GitHub, you can also use a URL of a directory containing a devfile, or a direct URL to the devfile. The devfile name must be devfile.yaml or .devfile.yaml. Other Git providers do not support this feature.

     Expand

     Table 1.2. GitLab

     URL pattern
     Default branch: https://<openshift_dev_spaces_fqdn>#https://<gitlab_host>/<user_or_org>/<repository>
     Specified branch: https://<openshift_dev_spaces_fqdn>#https://<gitlab_host>/<user_or_org>/<repository>/-/tree/<branch_name>
     Git+SSH: https://<openshift_dev_spaces_fqdn>#git@<gitlab_host>:<user_or_org>/<repository>.git

     Show more
     Expand

     Table 1.3. Bitbucket Server

     URL pattern
     Default branch: https://<openshift_dev_spaces_fqdn>#https://<bb_host>/scm/<project-key>/<repository>.git
     Default branch (user profile repository): https://<openshift_dev_spaces_fqdn>#https://<bb_host>/users/<user_slug>/repos/<repository>/
     Specified branch: https://<openshift_dev_spaces_fqdn>#https://<bb_host>/users/<user-slug>/repos/<repository>/browse?at=refs%2Fheads%2F<branch-name>
     Git+SSH: https://<openshift_dev_spaces_fqdn>#git@<bb_host>:<user_slug>/<repository>.git

     Show more
     Expand

     Table 1.4. Microsoft Azure DevOps

     URL pattern
     Default branch: https://<openshift_dev_spaces_fqdn>#https://<organization>@dev.azure.com/<organization>/<project>/_git/<repository>
     Specified branch: https://<openshift_dev_spaces_fqdn>#https://<organization>@dev.azure.com/<organization>/<project>/_git/<repository>?version=GB<branch>
     Git+SSH: https://<openshift_dev_spaces_fqdn>#git@ssh.dev.azure.com:v3/<organization>/<project>/<repository>

     Show more

Procedure

1. Optional: Visit your OpenShift Dev Spaces dashboard pages to authenticate to your organization’s instance of OpenShift Dev Spaces.

2. Enter the devfile URL in your browser to start a new workspace.

   For a public repository:

   https://<openshift_dev_spaces_fqdn>#<devfile_url>

   For a private repository, include your personal access token in the URL:

   https://<openshift_dev_spaces_fqdn>#https://<token>@<host>/<path_to_devfile>

   where:

   <token>

   Your personal access token that you generated on the Git provider’s website. This method works for GitHub, GitLab, Bitbucket, Microsoft Azure, and other providers that support Personal Access Token.

   Important

   Automated Git credential injection does not work with token-embedded URLs. To configure Git credentials separately, see Section 7.6, “Use a Git provider access token”.

   To append optional parameters, add ?<optional_parameters> to the URL. See Chapter 2, Optional parameters for the URLs for starting a new workspace for supported parameters.

   For example:

   • Public repository: https://<openshift_dev_spaces_fqdn>#https://raw.githubusercontent.com/che-samples/cpp-hello-world/main/devfile.yaml
   • Private repository: https://<openshift_dev_spaces_fqdn>#https://<token>@raw.githubusercontent.com/che-samples/cpp-hello-world/main/devfile.yaml