-
Notifications
You must be signed in to change notification settings - Fork 165
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
Add document for che installation on eks #2808
base: main
Are you sure you want to change the base?
Conversation
⚡️ Deploying pull request preview... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
: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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.Deploy che cluster | |
.Deploying {prod-short} cluster |
---- | ||
|
||
.Deploy che cluster | ||
. Prepare `CheCluster` manifest file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
= 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs usually have a short introductory paragraph about the process they describe. can you add it, please?
examples:
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 modified
step reports no vale warnings.