Secure Registry

What is a secure devfile registry?

A secure devfile registry is a devfile registry that a user can only access using credentials.

Where to host secure devfile registry?

A user can host a secure devfile registry on a private GitHub repository or an enterprise GitHub repository.

Adding a secure devfile registry on a GitHub repository

1. Create new private or enterprise GitHub repository to host the secure devfile registry and push the devfile registry to the created repository. The sample GitHub-hosted devfile registry can be found here.

2. Create a personal access token to access the secure devfile registry with repo as token scope.

3. Keyring setup: There is no specific keyring setup for secure devfile registry, you only need to ensure the keyring is working properly on your system.

   If you hit issues with keyring please follow the below instructions to troubleshoot with respect to the corresponding platforms.

   • Mac keychain
   • GNOME keyring setup on RedHat Enterprise Linux
   • GNOME keyring setup on Ubuntu Linux
   • Linux GNOME keyring
   • Windows credential manager

4. Add a secure devfile registry to odo.

   odo registry add <registry name> <registry URL> --token <token>
   • registry name: user-defined devfile registry name.
   • registry URL: the URL of GitHub repository that you create on step 1.
   • token: the personal access token that you created on step 2.

Steps for setting up a secure starter project on a GitHub repository

1. Create a new private or enterprise GitHub repository and push the starter project to the created repository. The sample GitHub-hosted starter project can be found here.

   Ensure the starterProjects section in the corresponding devfile of your secure devfile registry links to the secure starter project, for example:

   starterProjects:
     - name: nodejs-starter
       git:
         remotes:
           origin: "<secure starter project link>"

2. Create a personal access token to access the secure devfile registry with repo as token scope.

3. Create a devfile component from the secure devfile registry and download the secure starter project.

   odo create nodejs --registry <registry name> --starter --starter-token <starter project token>
   • registry name: user-defined devfile registry name.
   • starter project token: the personal access token that you create on step 2.

Note: GitHub only supports user-scoped personal access tokens. If the repository that hosts the secure registry and the repository that hosts the secure starter project are created under the same GitHub user, then the token can be used for both downloading the devfile and starter project. For that case you don't need to explicitly pass in the flag --starter-token <starter project token>, odo can automatically use one token to download both devfile and starter project.