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

[docs] Document airgap/offline Che deployment process/options #14866

Closed
amisevsk opened this issue Oct 11, 2019 · 4 comments
Closed

[docs] Document airgap/offline Che deployment process/options #14866

amisevsk opened this issue Oct 11, 2019 · 4 comments
Assignees
Labels
area/doc Issues related to documentation area/install Issues related to installation, including offline/air gap and initial setup kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system.
Milestone

Comments

@amisevsk
Copy link
Contributor

Is your task related to a problem? Please describe.

Issues #14733, #14733, eclipse-che/che-plugin-registry#211, and eclipse-che/che-plugin-broker#70 add offline functionality to Che registries and workspaces. This functionality is going to be supported by the operator (#14734) and by chectl (#14699)

We should add a new section to the Che documentation on how to use these options and how to deploy Che in an airgap environment.

@amisevsk amisevsk added kind/task Internal things, technical debt, and to-do tasks to be performed. area/doc Issues related to documentation team/osio labels Oct 11, 2019
@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 11, 2019
@tolusha tolusha added severity/P1 Has a major impact to usage or development of the system. team/osio and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Oct 12, 2019
@davidfestal
Copy link
Contributor

davidfestal commented Oct 14, 2019

How does this issue relate to the following: #14088 (comment) ? Maybe it should replace it ?

@l0rd @nickboldt wdyt ?

@ibuziuk ibuziuk added this to the Backlog - Hosted Che milestone Oct 14, 2019
@nickboldt
Copy link
Contributor

nickboldt commented Oct 15, 2019

There are two types of doc required here:

a) how do I build an airgap-compliant image?
b) how do I use a previously-built airgap-compliant image?

Part (a) is about which flags to pass to build.sh or docker build to ensure you enable the offline caching mode when building and swap in the correct overrides for docker.io/quay.io with your own registry URL.

I can see this doc being useful for Che 7 extenders wanting to build custom registries to add/remove new plugins/devfiles. Or for CRW 2 airgap customers wishing the same thing - custom registries with more/less content than the OOTB default

Part (b) is... now that I have a build, how do I tell chectl to use MY images instead of the defaults?

This is also for Che 7 extenders but could also be useful for a CRW 2 customer who just wants to deploy the CRW 2 OOTB experience (non-customized registries) inside an airgap environment.

So it's either two documents or one two-part document. Given you might only need the second doc if you're not looking to customize registry content, I might suggest it's better as two docs.

@ibuziuk ibuziuk modified the milestones: Backlog - Hosted Che, 7.4.0 Oct 16, 2019
@nickboldt nickboldt added area/install Issues related to installation, including offline/air gap and initial setup team/productization labels Oct 16, 2019
@amisevsk
Copy link
Contributor Author

Draft document: https://gist.github.com/amisevsk/c98a48bba01f3fa72d7ab7dfea45fc36

There are a few known issues and still some work required in filling in various options (e.g. how to deploy using chectl).

@amisevsk
Copy link
Contributor Author

amisevsk commented Nov 6, 2019

PR merged.

@amisevsk amisevsk closed this as completed Nov 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/doc Issues related to documentation area/install Issues related to installation, including offline/air gap and initial setup kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system.
Projects
None yet
Development

No branches or pull requests

6 participants