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

Document how to install Eclipse Che on major k8s providers #22392

Open
1 of 6 tasks
Tracked by #22670
tolusha opened this issue Jul 26, 2023 · 1 comment
Open
1 of 6 tasks
Tracked by #22670

Document how to install Eclipse Che on major k8s providers #22392

tolusha opened this issue Jul 26, 2023 · 1 comment
Labels
area/doc Issues related to documentation area/install Issues related to installation, including offline/air gap and initial setup help wanted Community, we are fully engaged on other issues. Feel free to take this one. We'll help you! kind/task Internal things, technical debt, and to-do tasks to be performed. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.

Comments

@tolusha
Copy link
Contributor

tolusha commented Jul 26, 2023

Is your task related to a problem? Please describe

We don't have any docs describing how to install Eclipse Che on k8s cluster [1], but instead we have a lot of requests like this [2].

[1] https://eclipse.dev/che/docs/stable/administration-guide/installing-che/
[2] Eclipse che on Plain Kubernetes - Is it possible if so, detailed steps required. Minikube is NOT idel #21743
[3] Document how to setup an OIDC provider #21304

Describe the solution you'd like

In general, we have to know a couple of things before deploying Eclipse Che on k8s cluster:

  • kubernetes public domain
  • OIDC provider url
  • client id
  • client secret
  1. Prepare patch file
cat >>cr-patch.yaml <<EOF
apiVersion: org.eclipse.che/v2
spec:
  networking:
    domain: <DOMAIN>
    auth:
      identityProviderURL: <IDENTITY_PROVIDER_URL>
      oAuthClientName: <CLIENT_ID>
      oAuthSecret: <CLIENT_SECRET>
EOF
  1. Run command to deploy Eclipse Che
chectl server:deploy --platform k8s --che-operator-cr-patch-yaml cr-patch.yaml --skip-oidc-provider-check

The main problem is in configuring OIDC provider and users would like to have a clear doc how to do this. I found a couple of successful user's stories while going through similar issues [1] [2] [3] [4] [5]. The main idea is to translate those stories in the article for che-docs

Describe alternatives you've considered

No response

Additional context

No response

@tolusha tolusha added kind/task Internal things, technical debt, and to-do tasks to be performed. help wanted Community, we are fully engaged on other issues. Feel free to take this one. We'll help you! area/doc Issues related to documentation labels Jul 26, 2023
@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 Jul 26, 2023
@dmytro-ndp dmytro-ndp removed the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Jul 26, 2023
@tolusha tolusha added the area/install Issues related to installation, including offline/air gap and initial setup label Sep 7, 2023
@ibuziuk ibuziuk mentioned this issue Oct 3, 2023
@l0rd
Copy link
Contributor

l0rd commented Oct 18, 2023

Another related issue #21304

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 help wanted Community, we are fully engaged on other issues. Feel free to take this one. We'll help you! kind/task Internal things, technical debt, and to-do tasks to be performed. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
None yet
Development

No branches or pull requests

4 participants