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

Add document for che installation on eks #2808

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

huonguyenlt
Copy link

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.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

Copy link

github-actions bot commented Nov 3, 2024

Click here to review and test in web IDE: Contribute

Copy link

github-actions bot commented Nov 3, 2024

⚡️ Deploying pull request preview...

Copy link
Contributor

@deerskindoll deerskindoll left a 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]
Copy link
Contributor

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:keywords: installing-{prod-short}-on-the-eks-cluster
:keywords: installation, eks cluster

= Installing {prod-short} on the {eks} cluster

.Prerequisites
* A Che domain name
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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.
Copy link
Contributor

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.Deploy che cluster
.Deploying {prod-short} cluster

----

.Deploy che cluster
. Prepare `CheCluster` manifest file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
= 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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ibuziuk ibuziuk requested a review from tolusha November 7, 2024 12:24
@ibuziuk
Copy link
Member

ibuziuk commented Nov 7, 2024

@tolusha please, review as part of the #2808

Copy link
Member

@ibuziuk ibuziuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@huonguyenlt thank you for the contribution
Please, submit the ECA form required by the Eclipse Foundation - https://www.eclipse.org/legal/eca/

@tolusha
Copy link
Contributor

tolusha commented Nov 7, 2024

@huonguyenlt
Let me create another PR describing installing Che on EKS based on yours.

@huonguyenlt
Copy link
Author

@tolusha does this means that I dont have to update this pr as the above review comments any more?

@tolusha
Copy link
Contributor

tolusha commented Nov 8, 2024

Yes, I will do the rest if you don't mind

@huonguyenlt
Copy link
Author

It's ok to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants