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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

5. Build the containers for the custom devfile registry:

   $ docker build -t my-devfile-registry .

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

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

   $ docker build -t my-devfile-registry .

   Copy to Clipboard Toggle word wrap

1. Check out the plugin registry sources.

   $ git clone https://github.com/eclipse/che-plugin-registry; \
     cd che-plugin-registry

   Copy to Clipboard Toggle word wrap

2. Create a meta.yaml in some local folder. This can be done from scratch or by copying from an existing plug-in’s meta.yaml file.

   $ PLUGIN="v3/plugins/new-org/new-plugin/0.0.1"; \
     mkdir -p ${PLUGIN}; cp v3/plugins/che-incubator/cpptools/0.1/* ${PLUGIN}/
     echo "${PLUGIN##*/}" > ${PLUGIN}/../latest.txt

   Copy to Clipboard Toggle word wrap
3. If copying from an existing plug-in, make changes to the meta.yaml file to suit your needs. Make sure your new plug-in has a unique title, displayName and description. Update the firstPublicationDate to today’s date.

4. These fields in meta.yaml must match the path defined in PLUGIN above.

   publisher: new-org
   name: new-plugin
   version: 0.0.1

   Copy to Clipboard Toggle word wrap

5. Get the name of the Pod that hosts the plug-in registry container. To do this, filter the component=plugin-registry label:

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

   Copy to Clipboard Toggle word wrap

6. Regenerate the registry’s index.json file to include your new plug-in.

   $ cd che-plugin-registry; \
       "$(pwd)/build/scripts/generate_latest_metas.sh" v3 && \
       "$(pwd)/build/scripts/check_plugins_location.sh" v3 && \
       "$(pwd)/build/scripts/set_plugin_dates.sh" v3 && \
       "$(pwd)/build/scripts/check_plugins_viewer_mandatory_fields.sh" v3 && \
       "$(pwd)/build/scripts/index.sh" v3 > v3/plugins/index.json

   Copy to Clipboard Toggle word wrap

7. Copy the new index.json and meta.yaml files from your new local plug-in folder to the container.

   $ cd che-plugin-registry; \
     LOCAL_FILES="$(pwd)/${PLUGIN}/meta.yaml $(pwd)/v3/plugins/index.json"; \
     oc exec ${PLUGIN_REG_POD} -i -t -- mkdir -p /var/www/html/${PLUGIN}; \
     for f in $LOCAL_FILES; do e=${f/$(pwd)\//}; echo "Upload ${f} -> /var/www/html/${e}"; \
       oc cp "${f}" ${PLUGIN_REG_POD}:/var/www/html/${e}; done

   Copy to Clipboard Toggle word wrap
8. The new plug-in can now be used from the existing CodeReady Workspaces instance’s plug-in registry. To discover it, go to the CodeReady Workspaces dashboard, then click the Workspaces link. From there, click the gear icon to configure one of your workspaces. Select the Plugins tab to see the updated list of available plug-ins.

1. Check out the devfile registry sources.

   $ git clone https://github.com/eclipse/che-devfile-registry; \
     cd che-devfile-registry

   Copy to Clipboard Toggle word wrap

2. Create a devfile.yaml and meta.yaml in some local folder. This can be done from scratch or by copying from an existing devfile.

   $ STACK="new-stack"; \
     mkdir -p devfiles/${STACK}; cp devfiles/nodejs/* devfiles/${STACK}/

   Copy to Clipboard Toggle word wrap
3. If copying from an existing devfile, make changes to the devfile to suit your needs. Make sure your new devfile has a unique displayName and description.

4. Get the name of the Pod that hosts the devfile registry container. To do this, filter the component=devfile-registry label:

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

   Copy to Clipboard Toggle word wrap

5. Regenerate the registry’s index.json file to include your new devfile.

   $ cd che-devfile-registry; \
     "$(pwd)/build/scripts/check_mandatory_fields.sh" devfiles; \
     "$(pwd)/build/scripts/index.sh" > index.json

   Copy to Clipboard Toggle word wrap

6. Copy the new index.json, devfile.yaml and meta.yaml files from your new local devfile folder to the container.

   $ cd che-devfile-registry; \
     LOCAL_FILES="$(pwd)/${STACK}/meta.yaml $(pwd)/${STACK}/devfile.yaml $(pwd)/index.json"; \
     oc exec ${DEVFILE_REG_POD} -i -t -- mkdir -p /var/www/html/devfiles/${STACK}; \
     for f in $LOCAL_FILES; do e=${f/$(pwd)\//}; echo "Upload ${f} -> /var/www/html/devfiles/${e}"
       oc cp "${f}" ${DEVFILE_REG_POD}:/var/www/html/devfiles/${e}; done

   Copy to Clipboard Toggle word wrap
7. The new devfile can now be used from the existing CodeReady Workspaces instance’s devfile registry. To discover it, go to the CodeReady Workspaces dashboard, then click the Workspaces link. From there, click Add Workspace to see the updated list of available devfiles.