HomeGuidesChangelog
GuidesDiscussionChangelogLog In

Base Images

Base Images are the "starting point" for Project environments

Base Images are pre-built containers that serve as the "starting point" for Project environments.

Hosting

Base Images are maintained via two types of repositories. First a public git repo (https://github.com/gigantum/base-images) stores metadata about each revision of each Base. This is used by the Client to know the capabilities of a Base and installed packages. Second, public container repositories on DockerHub store the actual Docker images.

Configuration

The Client by default is configured to use https://github.com/gigantum/base-images as its Base repository. The Client supports both replacing this repository and adding additional repositories via it's configuration file.

For example, the repository https://github.com/my-fake-namespace/base-images could be used instead of the default bases by creating the file ~/gigantum/.labmanager/config.yaml with the contents

# Environment Management Configuration
# URLs can specify a non-default branch using the format <url>@<branch>
environment:
  repo_url:
    - "https://github.com/my-fake-namespace/base-images.git"
  iframe:
    enabled: false
    allowed_origin: localhost:10000

If you instead want to add the Bases in addition to the defaults, config.yaml would look like:

# Environment Management Configuration
# URLs can specify a non-default branch using the format <url>@<branch>
environment:
  repo_url:
    - "https://github.com/gigantum/base-images.git"
    - "https://github.com/my-fake-namespace/my-base-images.git"
  iframe:
    enabled: false
    allowed_origin: localhost:10000

Custom Bases

Custom Base images can be created and hosted by following the instructions in the README at https://github.com/gigantum/base-images. While a registry running inside a private network will work, currently all image repositories must be set public, as the Client cannot associate docker credentials with a registry.