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

EKS user journey #1715

Merged
merged 31 commits into from
Nov 8, 2023
Merged

EKS user journey #1715

merged 31 commits into from
Nov 8, 2023

Conversation

ritawatson
Copy link
Contributor

@ritawatson ritawatson commented Oct 27, 2023

Describe the Change

This PR cleans up the EKS user journey doc. It includes the following:

  • Information to configure OIDC and provides links to the appropriate docs.
  • A section on how to access the EKS cluster.
  • A separate doc to configure an AWS KMS key.

This PR also adds use case information about private IP CIDRs in EKS clusters.
In addition, some quick cleanup is done in the Add AWS account doc to fix grammar and follow our internal style.

Review Changes

💻 Preview URL

🎫 PEM-2574
🎫 PCP-1982

@netlify
Copy link

netlify bot commented Oct 27, 2023

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 995655b
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/654bcfbda849dd00088d8f82
😎 Deploy Preview https://deploy-preview-1715--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ritawatson ritawatson changed the title Revise steps EKS user journey Oct 27, 2023
@ritawatson ritawatson added the documentation Improvements or additions to documentation label Oct 27, 2023
@ritawatson ritawatson marked this pull request as ready for review November 1, 2023 19:20
@ritawatson ritawatson requested a review from a team as a code owner November 1, 2023 19:20
|**Cluster Endpoint Access**| This setting provides access to the Kubernetes API endpoint. Select **Private**, **Public** or **Private & Public**. For more information, refer to the [Amazon EKS cluster endpoint access control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) reference guide.|
|**Public Access CIDRs** |This setting controls which IP address CIDR ranges can access the cluster. To fully allow unrestricted network access, enter `0.0.0.0/0` in the field. For more information, refer to the [Amazon EKS cluster endpoint access control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) reference guide.|
|**Private Access CIDRs** |This setting controls which private IP address CIDR ranges can access the cluster. Private CIDRs provide a way to specify private, self-hosted, and air-gapped networks or Private Cloud Gateway (PCG) that may be located in other VPCs connected to the VPC hosting the cluster endpoint.<br /><br />To restrict network access, enter the IP address CIDR range that will provide access to the cluster. Although `0.0.0.0/0` is pre-populated in this field, only IPs that can reach the private endpoint are those within the VPC or any other connected VPCs. For example, while using `0.0.0.0/0` would allow traffic throughout the VPC and all peered VPCs, specifying the VPC CIDR `10.0.0.0/16` would limit traffic to an individual VPC. For more information, refer to the [Amazon EKS cluster endpoint access control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) reference guide.|
|**Enable Encryption**| Use this option for secrets encryption. You must have an existing AWS Key Management Service (KMS) key you can use. Toggle the **Enable encryption** option and use the **drop-down Menu** in the **ARN** field to select the KMS key ARN.<br /><br />If you do not have a KMS key and want to create one to use this option, review [Enable Secrets Encryption for EKS Cluster](enable-secrets-encryption-kms-key.md). Once your KMS key is created, return to this Cluster Config step to enable secrets encryption and specify the KMS key ARN. |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'config' instead of 'Config'.

@ritawatson ritawatson merged commit 7e40ede into master Nov 8, 2023
7 checks passed
@ritawatson ritawatson deleted the user-journey-cleanup-eks-first-cluster branch November 8, 2023 18:27
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Nov 8, 2023
* Revise steps

* Fixed tables

* Clean up steps, improve flow

* Add info based on prototype.

* Verify steps, add resources

* Several small changes

* Add links to existing OIDC documentation

* Add links to other docs

* Last changes from final workflow walkthrough

* Updates for internal style, grammar: add aws acct

* Fix repeated 'the'

* Vale fixes

* Incorporate first comments

* Revise info block, add link

* Added review comments

* Fix typo in policy name

* Revised KMS key creation section

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Incorporate review comments for KMS key

* Fix typo

* Create new page for KMS key

* Add Access EKS Cluster section

* Minor change to Access EKS Cluster

* Replace kubelogin prereq w. aws-iam-authenticator

* Revised Access EKS Cluster, step 9, prereqs

* docs: updates and clarifications

* Fix typo

---------

Co-authored-by: Karl Cardenas <[email protected]>
(cherry picked from commit 7e40ede)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Nov 8, 2023
* Revise steps

* Fixed tables

* Clean up steps, improve flow

* Add info based on prototype.

* Verify steps, add resources

* Several small changes

* Add links to existing OIDC documentation

* Add links to other docs

* Last changes from final workflow walkthrough

* Updates for internal style, grammar: add aws acct

* Fix repeated 'the'

* Vale fixes

* Incorporate first comments

* Revise info block, add link

* Added review comments

* Fix typo in policy name

* Revised KMS key creation section

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Incorporate review comments for KMS key

* Fix typo

* Create new page for KMS key

* Add Access EKS Cluster section

* Minor change to Access EKS Cluster

* Replace kubelogin prereq w. aws-iam-authenticator

* Revised Access EKS Cluster, step 9, prereqs

* docs: updates and clarifications

* Fix typo

---------

Co-authored-by: Karl Cardenas <[email protected]>
(cherry picked from commit 7e40ede)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0
version-3-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-3-4:
- Refactor/restructure cluster & app profiles sections (#1551)
- docs: updated URLs to use file path context
version-4-1

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 1715

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

ritawatson added a commit that referenced this pull request Nov 8, 2023
* Revise steps

* Fixed tables

* Clean up steps, improve flow

* Add info based on prototype.

* Verify steps, add resources

* Several small changes

* Add links to existing OIDC documentation

* Add links to other docs

* Last changes from final workflow walkthrough

* Updates for internal style, grammar: add aws acct

* Fix repeated 'the'

* Vale fixes

* Incorporate first comments

* Revise info block, add link

* Added review comments

* Fix typo in policy name

* Revised KMS key creation section

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Incorporate review comments for KMS key

* Fix typo

* Create new page for KMS key

* Add Access EKS Cluster section

* Minor change to Access EKS Cluster

* Replace kubelogin prereq w. aws-iam-authenticator

* Revised Access EKS Cluster, step 9, prereqs

* docs: updates and clarifications

* Fix typo

---------

Co-authored-by: Karl Cardenas <[email protected]>
(cherry picked from commit 7e40ede)

Co-authored-by: Rita Watson <[email protected]>
ritawatson added a commit that referenced this pull request Nov 8, 2023
* Revise steps

* Fixed tables

* Clean up steps, improve flow

* Add info based on prototype.

* Verify steps, add resources

* Several small changes

* Add links to existing OIDC documentation

* Add links to other docs

* Last changes from final workflow walkthrough

* Updates for internal style, grammar: add aws acct

* Fix repeated 'the'

* Vale fixes

* Incorporate first comments

* Revise info block, add link

* Added review comments

* Fix typo in policy name

* Revised KMS key creation section

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Incorporate review comments for KMS key

* Fix typo

* Create new page for KMS key

* Add Access EKS Cluster section

* Minor change to Access EKS Cluster

* Replace kubelogin prereq w. aws-iam-authenticator

* Revised Access EKS Cluster, step 9, prereqs

* docs: updates and clarifications

* Fix typo

---------

Co-authored-by: Karl Cardenas <[email protected]>
(cherry picked from commit 7e40ede)

Co-authored-by: Rita Watson <[email protected]>
ritawatson added a commit that referenced this pull request Nov 8, 2023
* Revise steps

* Fixed tables

* Clean up steps, improve flow

* Add info based on prototype.

* Verify steps, add resources

* Several small changes

* Add links to existing OIDC documentation

* Add links to other docs

* Last changes from final workflow walkthrough

* Updates for internal style, grammar: add aws acct

* Fix repeated 'the'

* Vale fixes

* Incorporate first comments

* Revise info block, add link

* Added review comments

* Fix typo in policy name

* Revised KMS key creation section

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Incorporate review comments for KMS key

* Fix typo

* Create new page for KMS key

* Add Access EKS Cluster section

* Minor change to Access EKS Cluster

* Replace kubelogin prereq w. aws-iam-authenticator

* Revised Access EKS Cluster, step 9, prereqs

* docs: updates and clarifications

* Fix typo

---------

Co-authored-by: Karl Cardenas <[email protected]>
ritawatson added a commit that referenced this pull request Nov 8, 2023
* Revise steps

* Fixed tables

* Clean up steps, improve flow

* Add info based on prototype.

* Verify steps, add resources

* Several small changes

* Add links to existing OIDC documentation

* Add links to other docs

* Last changes from final workflow walkthrough

* Updates for internal style, grammar: add aws acct

* Fix repeated 'the'

* Vale fixes

* Incorporate first comments

* Revise info block, add link

* Added review comments

* Fix typo in policy name

* Revised KMS key creation section

* Apply suggestions from code review



* Apply suggestions from code review



* Incorporate review comments for KMS key

* Fix typo

* Create new page for KMS key

* Add Access EKS Cluster section

* Minor change to Access EKS Cluster

* Replace kubelogin prereq w. aws-iam-authenticator

* Revised Access EKS Cluster, step 9, prereqs

* docs: updates and clarifications

* Fix typo

---------

Co-authored-by: Karl Cardenas <[email protected]>
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Dec 18, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants