Skip to content

Development Environments

What is a Development Environment?

A set of software tools used for a development project is called a Development Environment.

Tool types

Currently, the following tool types are supported:

- Build system
- Toolchain
- Debugger
- Deployer
- Test framework
- CI/CD server

When creating a new Development Environment the user can select any of the above types and then assign the required tools to them.

Warning

In the v0.3.0 we are going to change this behavior and let the users to define their own tool types.

Tool images

To put it simply, a container image is a set of software components alongside its dependencies, which can be run in a container. The idea is to build the tools from a Development Environment into their own images, so they can run isolatedly.

Registry

A registry can serve as a storage for tool images, where they can be kept without occupying space on the developer's computer. This storage enables convenient sharing of images with others, ensuring uniform tool usage among all collaborators on the same project. When an image is uploaded to a registry, it initiates the creation of a repository. This repository is responsible for keeping track of the various versions of the image.

Note

An image repository stores the different versions of the same image.
An image registry is a collection of image repositories.

The DEM also uses registries in the background to store the tool images. To list the currently available registries use the dem list-reg command. The dem add-reg and dem del-reg commands can be used to add or delete registries.

Note

The DEM supports the Docker Hub and Docker Registry

If you'd like to request support for other registry types, please create a new descussion.

Development Environment Catalogs

A catalog is a collection of Development Environment descriptors available to install. A descriptor stores the location of the required tool images. The DEM can handle multiple catalogs. To list the currently available ones use the dem list-cat command. The dem add-cat and dem del-cat commands can be used to add or delete catalogs.

Note

axem has its own catalog, which is by default available for DEM.

Development Platform

The collection of the available catalogs and registries is the Development Platform. The users can install new Development Environments in a self-service manner, which are available in the Platform.

platform

Getting a Development Environment

There are three ways to get a Development Environment:

  • install one from a Catalog
  • create a new one locally
  • load an exported Development Environment descriptor

Installing from a catalog

An organization can create a Development Environment Catalog and share it with its members. This guarantees that each and every member uses the same toolset in the same environment.

organization

The members can list the available Development Environments in the organization's catalog with the following command:
dem list --all --env

Use the dem pull command to install the selected Development Environment.

  1. First the DEM installs the Development Environment descriptor.
  2. Then downloads the necessary tool images, which are not yet available on the host PC.

See the dem pull command for more details.

Creating a new Development Environment locally

DEM provides a TUI for creating a new Development Environment that can be started with the dem create command.

See the dem create command for more details.

Load a Development Environment

A locally already available Development Environment can be exported in JSON format with the dem export command. The exported JSON describes the required tool images and the location of the registries where they stores. This file can be shared and on another PC can be imported with the dem load command. After the DEM loaded the descriptor, it will pull the required tool images.

See the dem export and dem load commands for more details.