Add document for che installation on eks#2808
Add document for che installation on eks#2808huonguyenlt wants to merge 2 commits intoeclipse-che:mainfrom
Conversation
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
⚡️ Deploying pull request preview... |
deerskindoll
left a comment
deerskindoll
left a comment
There was a problem hiding this comment.
first batch of suggestions. please check them out, edit the doc as necessary and I'll have a second look at it.
| .Install required components | ||
| . Install link:https://kubernetes.github.io/ingress-nginx/[Ingress-Nginx Controller] | ||
| + | ||
| [source,shell] |
There was a problem hiding this comment.
please check the Red Hat Style Guide section about commands with root privileges: https://redhat-documentation.github.io/supplementary-style-guide/#commands-with-root-privileges
you'll need to edit out mentions of shell in this doc
| :_content-type: PROCEDURE | ||
| :navtitle: Installing {prod-short} on the {eks} cluster | ||
| :description: Installing {prod-short} on the {eks} cluster | ||
| :keywords: installing-{prod-short}-on-the-eks-cluster |
There was a problem hiding this comment.
| :keywords: installing-{prod-short}-on-the-eks-cluster | |
| :keywords: installation, eks cluster |
| = Installing {prod-short} on the {eks} cluster | ||
|
|
||
| .Prerequisites | ||
| * A Che domain name |
There was a problem hiding this comment.
| * A Che domain name | |
| * A {prod-short} domain name |
|
|
||
| .Prerequisites | ||
| * A Che domain name | ||
| * A certificate for the che domain name: private and public keys in PEM format |
There was a problem hiding this comment.
| * A certificate for the che domain name: private and public keys in PEM format | |
| * A certificate (private and public keys in PEM format) for the {prod-short} domain name |
| .Prerequisites | ||
| * A Che domain name | ||
| * A certificate for the che domain name: private and public keys in PEM format | ||
| * An external OIDC provider, you need the following information from your provider: Issuer URL, Client ID, Client Secret |
There was a problem hiding this comment.
| * An external OIDC provider, you need the following information from your provider: Issuer URL, Client ID, Client Secret | |
| * An external OpenId Connect (OIDC) provider | |
| * An OIDC issuer URL | |
| * An OICD client ID | |
| * An OICD client secret |
| .Integrate the external OIDC provider with the EKS cluster | ||
| * Select your EKS cluster, and then select the `Access` tab. | ||
| * In the OIDC Identity Providers section, select Associate Identity Provider. | ||
| * On the Associate OIDC Identity Provider page, enter or select the following options, and then select Associate. |
There was a problem hiding this comment.
what's the correct name of the page, please? Associate OIDC Identity Provider or Associate Identity Provider
| $ {orch-cli} label secret che-tls app.kubernetes.io/part-of=che.eclipse.org -n {prod-namespace} | ||
| ---- | ||
|
|
||
| .Deploy che cluster |
There was a problem hiding this comment.
| .Deploy che cluster | |
| .Deploying {prod-short} cluster |
| ---- | ||
|
|
||
| .Deploy che cluster | ||
| . Prepare `CheCluster` manifest file |
There was a problem hiding this comment.
| . Prepare `CheCluster` manifest file | |
| . Prepare the `CheCluster` manifest file |
| :page-aliases: | ||
|
|
||
| [id="installing-{prod-short}-on-AWS-EKS.adoc"] | ||
| = Installing {prod-short} on the {eks} cluster |
There was a problem hiding this comment.
| = Installing {prod-short} on the {eks} cluster | |
| = Installing {prod-short} on an EKS cluster |
|
|
||
| [id="installing-{prod-short}-on-AWS-EKS.adoc"] | ||
| = Installing {prod-short} on the {eks} cluster | ||
|
|
There was a problem hiding this comment.
docs usually have a short introductory paragraph about the process they describe. can you add it, please?
examples:
ibuziuk
left a comment
ibuziuk
left a comment
There was a problem hiding this comment.
@huonguyenlt thank you for the contribution
Please, submit the ECA form required by the Eclipse Foundation - https://www.eclipse.org/legal/eca/
|
@huonguyenlt |
|
@tolusha does this means that I dont have to update this pr as the above review comments any more? |
|
Yes, I will do the rest if you don't mind |
|
It's ok to me |
|
Closed in favor of #2828 |
4 participants
What does this pull request change?
Installation guide on EKS #23209
What issues does this pull request fix or reference?
main
Specify the version of the product this pull request applies to
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.