Skip to content

Allow editor and project cloner images and tags to be specified via environment variables

new MR: Allow tools_injector_image to be overridden via... (!146930 - merged)

original MR: Allow images to be specified by ENV variables (!134984 - closed)

Description

As an instance admin, I want to be able to specify the editor image which is used for remote development workspaces so that I can use a custom image instead of the default image.

Allow the editor image_name and image_tag in ee/lib/remote_development/workspaces/create/editor_component_injector.rb and ee/lib/remote_development/workspaces/create/project_cloner_component_injector.rb to be specified via ENV vars at the GitLab instance level.

This is an initial prerequisite iteration to support Abstract editor configuration as a configuratio... (#396418), Abstract editor configuration as a configuratio... (#396418) and other issues in the epic Create capability for additional editors that c... (&10635)

Also consider adding Allow configuring list of allowed container reg... (&12520) as an example which includes UI configuration.

Acceptance Criteria

  • Allow the following ENV vars to override the defaults in ee/lib/remote_development/workspaces/create/editor_component_injector.rb and ee/lib/remote_development/workspaces/create/project_cloner_component_injector.rb:
    • GITLAB_REMOTE_DEVELOPMENT_TOOLS_INJECTOR_IMAGE
    • GITLAB_REMOTE_DEVELOPMENT_PROJECT_CLONER_IMAGE

Technical Requirements

  • The usage of ENV vars should be completely decoupled from the actual config values which are passed in the value argument which is injected into the various domain logic main.rb classes via the Result type.
  • This will allow us to iterate on the UI and UX of how we obtain the config values without any impact to the domain logic.

Design Requirements

No UI components

Impact Assessment

This is a first prerequisite to support Create capability for additional editors that c... (&10635)

Edited by Chad Woolley