Chapter 1. Customizing the devfile and plug-in registries

Procedure

1. Clone the devfile registry repository:

   $ git clone git@github.com:redhat-developer/codeready-workspaces.git
   $ cd codeready-workspaces/dependencies/che-devfile-registry

2. In the ./che-devfile-registry/devfiles/ directory, create a subdirectory <devfile-name>/ and add the devfile.yaml and meta.yaml files.

   File organization for a devfile

   ./che-devfile-registry/devfiles/
   └── <devfile-name>
       ├── devfile.yaml
       └── meta.yaml

3. Add valid content in the devfile.yaml file. For a detailed description of the devfile format, see the Making a workspace portable using a Devfile section.

4. Ensure that the meta.yaml file conforms to the following structure:

   Expand

   Table 1.1. Parameters for a devfile meta.yaml

   Attribute	Description
   description	Description as it appears on the user dashboard.
   displayName	Name as it appears on the user dashboard.
   globalMemoryLimit	The sum of the expected memory consumed by all the components launched by the devfile. This number will be visible on the user dashboard. It is informative and is not taken into account by the CodeReady Workspaces server.
   icon	Link to an .svg file that is displayed on the user dashboard.
   tags	List of tags. Tags usually include the tools included in the stack.

   Show more

   Example devfile meta.yaml

   displayName: Rust
   description: Rust Stack with Rust 1.39
   tags: ["Rust"]
   icon: https://www.eclipse.org/che/images/logo-eclipseche.svg
   globalMemoryLimit: 1686Mi

5. Build the containers for the custom devfile registry:

   $ docker build -t my-devfile-registry .

Procedure

1. Clone the plug-in registry repository:

   $ git clone git@github.com:redhat-developer/codeready-workspaces.git
   $ cd codeready-workspaces/dependencies/che-plugin-registry

2. In the ./che-plugin-registry/v3/plugins/ directory, create new directories <publisher>/<plugin-name>/<plugin-version>/ and a meta.yaml file in the last directory.

   File organization for a plugin

   ./che-plugin-registry/v3/plugins/
   ├── <publisher>
   │   └── <plugin-name>
   │       ├── <plugin-version>
   │       │   └── meta.yaml
   │       └── latest.txt

3. Add valid content to the meta.yaml file. See the “Using a Visual Studio Code extension in CodeReady Workspaces” section or the README.md file in the eclipse/che-plugin-registry repository for a detailed description of the meta.yaml file format.

4. Create a file named latest.txt with content the name of the latest <plugin-version> directory.

   Example

   $ tree che-plugin-registry/v3/plugins/redhat/java/
   che-plugin-registry/v3/plugins/redhat/java/
   ├── 0.38.0
   │   └── meta.yaml
   ├── 0.43.0
   │   └── meta.yaml
   ├── 0.45.0
   │   └── meta.yaml
   ├── 0.46.0
   │   └── meta.yaml
   ├── 0.50.0
   │   └── meta.yaml
   └── latest.txt
   $ cat che-plugin-registry/v3/plugins/redhat/java/latest.txt
   0.50.0

5. Build the containers for the custom plug-in registry:

   $ docker build -t my-devfile-registry .

1. Get the name of the OpenShift pod that hosts the plug-in registry container. To do this, filter the app=che-plugin-registry label:

   $ PLUGIN_REG_POD=$(oc get -o custom-columns=NAME:.metadata.name \
    --no-headers -l app=che-plugin-registry pod)

2. Create the new plug-in directory in the plug-in registry container, if it does not exist:

   $ ORG="my-org"
   $ PLUGIN="my-plug-in"
   $ VERSION="1.0.1"
   $ oc exec ${PLUGIN_REG_POD} -i -t -- \
     mkdir -p /var/www/html/v3/plugins/${ORG}/${PLUGIN}/${VERSION}

3. Copy the meta.yaml file in the container:

   LOCAL_META="${PWD}/meta.yaml"
   $ oc cp "${LOCAL_META}" \
     ${PLUGIN_REG_POD}:/var/www/html/v3/plugins/${ORG}/${PLUGIN}/${VERSION}

4. Update the index.json file of the registry:

   $ oc exec ${PLUGIN_REG_POD} -i -t -- \
     /var/www/html/index_v2.sh v3 > /var/www/html/v3/plugins/index.json

5. The new plug-in can now be used from a CodeReady Workspaces instance.

1. Get the name of the OpenShift pod that hosts the devfile registry container. To do this, filter the app=che-devfile-registry label:

   $ DEVFILE_REG_POD=$(oc get -o custom-columns=NAME:.metadata.name \
     --no-headers -l app=che-devfile-registry pod)

2. Create the new devfile directory in the devfile registry container, if it does not exist.

   $ STACK="my-stack"
   $ oc exec $\{DEVFILE_REG_POD} -i -t -- \
     mkdir -p /var/www/html/devfiles/$\{STACK}

3. Copy the devfile.yaml file and the meta.yaml file to the container.

   $ LOCAL_META="$(PWD)/meta.yaml"
   $ LOCAL_DEVFILE="$(PWD)/devfile.yaml"
   $ oc cp "$\{LOCAL_META}" \
     $\{DEVFILE_REG_POD}:/var/www/html/devfiles/$\{STACK}
   $ oc cp "$\{LOCAL_DEVFILE}" \
     $\{DEVFILE_REG_POD}:/var/www/html/devfiles/$\{STACK}

4. Update the index.json file of the registry.

   $ oc exec $\{DEVFILE_REG_POD} -i -t -- \
     /var/www/html/index.sh > /var/www/html/devfiles/index.json