Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move sidecars definitions into plugin-registry #18217

Closed
benoitf opened this issue Oct 27, 2020 · 2 comments · Fixed by eclipse-che/che-plugin-registry#693
Closed

move sidecars definitions into plugin-registry #18217

benoitf opened this issue Oct 27, 2020 · 2 comments · Fixed by eclipse-che/che-plugin-registry#693
Labels
area/plugin-registry kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.
Milestone

Comments

@benoitf
Copy link
Contributor

benoitf commented Oct 27, 2020

Is your task related to a problem? Please describe.

Currently, sidecars used in plug-ins are defined in the https://github.com/che-dockerfiles organisation.
It works pretty well for existing plug-ins but it make stuff complicated for contributing:

  • when a new plug-in need to be added into the registry with a custom sidecar: a sidecar repository need to be defined, then the image needs to be built and then we can create a PR to the plug-in registry
  • testing a plug-in by updating it's runtime (the sidecar) need to be done with 2 PR: one against the sidecar repository and one against the plug-in registry once the image is built. And image is built only if it gets approval and be merged.

Contributor experience should be smoother allowing to:

  • do not request the creation of a repository but simply open a PR against che-plugin-repository
  • let people test the plug-in with a custom image before even merging the sidecar definition.

Describe the solution you'd like

Allow to add sidecar definitions in the che-plugin-registry referencing the path where sidecar is defined.

example inside a chePlugin:

sidecar:
  path: "../../sidecars/java11"

and in sidecars/java11 folder:
it could contain Dockerfile, entrypoint.sh, etc

Describe alternatives you've considered

Additional context

Lifecycle might be different between sidecars and plug-ins.

@benoitf benoitf added kind/task Internal things, technical debt, and to-do tasks to be performed. area/plugin-registry labels Oct 27, 2020
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Oct 27, 2020
@ericwill ericwill removed the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Oct 27, 2020
@tolusha tolusha added the severity/P2 Has a minor but important impact to the usage or development of the system. label Oct 28, 2020
@ericwill ericwill mentioned this issue Oct 28, 2020
29 tasks
@ericwill
Copy link
Contributor

ericwill commented Nov 3, 2020

@benoitf any objections to using a monorepo for sidecar images in quay.io? For example: quay.io/che-sidecar-java:8-0cfbacb becomes quay.io/eclipse/che-plugin-sidecar:java8-0cfbacb

This removes the dependency of needing a new quay.io repo for every sidecar image.

@benoitf
Copy link
Contributor Author

benoitf commented Nov 3, 2020

no objection 👍 (any 'manual' step that can be removed is good (like creating quay.io repository and setting-up permissions)

ericwill added a commit to eclipse-che/che-plugin-registry that referenced this issue Nov 4, 2020
* Add sidecar PR check and build/push actions

Prepare the plugin-registry for sidecar definition migration.

Part of eclipse-che/che#18217

Signed-off-by: Eric Williams <ericwill@redhat.com>

* Fix shellcheck

Signed-off-by: Eric Williams <ericwill@redhat.com>

* Fix dead code, disable SC2199

Signed-off-by: Eric Williams <ericwill@redhat.com>

* Fixup

Refactor script a bit, change runners, clean up copyrights.

Signed-off-by: Eric Williams <ericwill@redhat.com>
ericwill added a commit to eclipse-che/che-plugin-registry that referenced this issue Nov 9, 2020
* Move sidecar definitions into the plugin registry

Part 1 of the migration. I am doing it in parts because doing it all at once
will likely cause a build timeout upon pushing.

Part of eclipse-che/che#18217

Signed-off-by: Eric Williams <ericwill@redhat.com>

* Handle java and java8 separately

Signed-off-by: Eric Williams <ericwill@redhat.com>
sideeffffect pushed a commit to sideeffffect/che-plugin-registry that referenced this issue Nov 10, 2020
…he#676)

* Move sidecar definitions into the plugin registry

Part 1 of the migration. I am doing it in parts because doing it all at once
will likely cause a build timeout upon pushing.

Part of eclipse-che/che#18217

Signed-off-by: Eric Williams <ericwill@redhat.com>

* Handle java and java8 separately

Signed-off-by: Eric Williams <ericwill@redhat.com>
ericwill added a commit to eclipse-che/che-plugin-registry that referenced this issue Nov 11, 2020
* Contribute remaining sidecar definitions to the plugin registry

README/CONTRIBUTING update will follow in a separate PR.

Part of eclipse-che/che#18217

Signed-off-by: Eric Williams <ericwill@redhat.com>

* Split PR into smaller pieces for ease of build time

Signed-off-by: Eric Williams <ericwill@redhat.com>
ericwill added a commit to eclipse-che/che-plugin-registry that referenced this issue Nov 12, 2020
eclipse-che/che#18217

Signed-off-by: Eric Williams <ericwill@redhat.com>
ericwill added a commit to eclipse-che/che-plugin-registry that referenced this issue Nov 12, 2020
Fixes eclipse-che/che#18217

Signed-off-by: Eric Williams <ericwill@redhat.com>
@ericwill ericwill added this to the 7.22 milestone Nov 18, 2020
ericwill added a commit to eclipse-che/che-plugin-registry that referenced this issue Nov 24, 2020
Part of eclipse-che/che#18217

Signed-off-by: Eric Williams <ericwill@redhat.com>
apupier added a commit to apupier/che-plugin-registry that referenced this issue Dec 4, 2020
repository eclipse-che/che#18217

Signed-off-by: Aurélien Pupier <apupier@redhat.com>
apupier added a commit to eclipse-che/che-plugin-registry that referenced this issue Dec 4, 2020
repository eclipse-che/che#18217

Signed-off-by: Aurélien Pupier <apupier@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/plugin-registry kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants