Make configurable images in both plugin and devfile registry

[l0rd]

Is your enhancement related to a problem? Please describe.

In Air Gap mode a user needs to start a workspace using images from an internal/private container registry (not docker.io, not quay.io).

Che server and other components images can be configured using che.properties (and config maps).

But editors and plugins sidecars images are not currently configurable: they are hardcoded with the plugin registry. The same is true to the stack images in the devfile registry.

Describe the solution you'd like

A user should be able to configure the plugin sidecars and the sample stack images URL and the repository.

Additional context

A possible solution would be to use a configmap and a bash script used as entrypoint that replaces the images.

The configmap would look like:

apiVersion: v1
kind: ConfigMap
metadata:
  name: che-containers-registry
data:
  CHE_SIDECAR_CONTAINERS_REGISTRY_URL: "https://enterprise.container.registry:3000/"
  CHE_SIDECAR_CONTAINERS_REGISTRY_REPOSITORY: "che_sidecars"

Used in the deployment yaml as

...
   containers:
   - image: {{ .Values.chePluginRegistryImage }}
      imagePullPolicy: {{ .Values.chePluginRegistryImagePullPolicy }}
      envFrom:
      - configMapRef:
          name: che-containers-registry

And the containers entrypoint should call a script that replaces the images url and repo in the index.json and the plugins meta.yaml.

[nickboldt]

If we implement the idea of injecting plugins directly into Theia runtime without the need for theia-runtime-endpoint... do we obviate the need for this?

Also what about these images, from https://github.com/eclipse/che-devfile-registry/blob/master/arbitrary-users-patch/base_images

quay.io/eclipse/che-java8-maven
quay.io/eclipse/che-java11-maven

Will this approach work for overriding those? #productization

[nickboldt]

FWIW the current simple implementation of this is to sed-replace all references to docker.io\\|quay.io\\|registry.access.redhat.com\\|registry.redhat.io

with a user-defined myquay.mycorp.com registry, then rebuild the image.

https://github.com/redhat-developer/codeready-workspaces/blob/master/dependencies/che-plugin-registry/scripts/replace_container_repos.sh
https://github.com/redhat-developer/codeready-workspaces/blob/master/dependencies/che-plugin-registry/airgap_build.sh

Obviously my approach is flawed and requires manual effort. :)

Mario's approach is by far better because it means we can inject these changes to a running container image without having to rebuild and republish it. \o/

[l0rd]

If we implement the idea of injecting plugins directly into Theia runtime without the need for theia-runtime-endpoint... do we obviate the need for this?

@nickboldt no. We still need it.

FWIW the current simple implementation of this is to sed-replace all references to docker.io\|quay.io\|registry.access.redhat.com\|registry.redhat.io

I have discussed with @slemeur and it's simpler to replace the registries hostnames and repositories only. I have updated this issue description.

[nickboldt]

Note that for testing containers before they're published to RHCC/RHIO, we will need this functionality in BOTH the plugin registry and the devfile registry so that any/all containers can be overridden to use a different base registry URL/repo/imagename:tag.

Then we can override registry.redhat.io/codeready-workspaces/stacks-java-rhel8:2.0 with quay.io/crw/stacks-java-rhel8:2.0-34 and test specific images prior to release.

[amisevsk]

PR for plugin registry: eclipse-che/che-plugin-registry#245

[amisevsk]

PR for devfile registry: eclipse-che/che-devfile-registry#110

[amisevsk]

PRs merged