This section describes how to build a custom devfiles registry. Following operations are covered:
-
Getting a copy of the source code necessary to build a devfiles registry.
-
Adding a new devfile.
-
Building the devfiles registry.
-
Clone the devfile registry repository:
$ git clone git@github.com:eclipse/che-devfile-registry.git $ cd che-devfile-registry
-
In the
./che-devfile-registry/devfiles/directory, create a subdirectory<devfile-name>/and add thedevfile.yamlandmeta.yamlfiles.File organization for a devfile./che-devfile-registry/devfiles/ └── <devfile-name> ├── devfile.yaml └── meta.yaml -
Add valid content in the
devfile.yamlfile. For a detailed description of the devfile format, see the Making a workspace portable using a Devfile section. -
Ensure that the
meta.yamlfile conforms to the following structure:Table 1. Parameters for a devfile meta.yamlAttribute Description descriptionDescription as it appears on the user dashboard.
displayNameName as it appears on the user dashboard.
globalMemoryLimitThe 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 Che server.
iconLink to an
.svgfile that is displayed on the user dashboard.tagsList of tags. Tags usually include the tools included in the stack.
Example devfilemeta.yamldisplayName: Rust description: Rust Stack with Rust 1.39 tags: ["Rust"] icon: https://www.eclipse.org/che/images/logo-eclipseche.svg globalMemoryLimit: 1686Mi -
Build the containers for the custom devfile registry:
$ docker build -t my-devfile-registry .