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

Added EKS install docs and updated node version in docs build #1042

Merged
merged 1 commit into from
Sep 5, 2023

Conversation

bradfordcp
Copy link
Member

@bradfordcp bradfordcp commented Aug 30, 2023

Added installation guide for EKS including:

  • Links to EKS docs for provisioning of k8s resources
  • IAM worker node role policy requirements
  • Node group hardware requirements and considerations
  • Discussion around control plane vs data plane modes
  • Installation steps for Helm & Kustomize with examples for both control plane and data plane
  • Next step links to sample K8ssandraCluster objects and role-based guides.

Which issue(s) this PR fixes:
Fixes #1043

What this PR does:
Adds a new quickstart to `/install/eks

Which issue(s) this PR fixes:
N/A

Checklist

  • Changes manually tested
  • Automated Tests added/updated
  • Documentation added/updated
  • CHANGELOG.md updated (not required for documentation PRs)
  • CLA Signed: DataStax CLA

@bradfordcp bradfordcp requested a review from a team as a code owner August 30, 2023 20:26
@codecov
Copy link

codecov bot commented Aug 30, 2023

Codecov Report

Merging #1042 (5780fea) into main (6099857) will decrease coverage by 0.06%.
The diff coverage is n/a.

❗ Current head 5780fea differs from pull request most recent head 8714639. Consider uploading reports for the commit 8714639 to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1042      +/-   ##
==========================================
- Coverage   57.43%   57.37%   -0.06%     
==========================================
  Files         100      100              
  Lines       10045    10045              
==========================================
- Hits         5769     5763       -6     
- Misses       3783     3787       +4     
- Partials      493      495       +2     

see 2 files with indirect coverage changes

@adejanovski adejanovski self-requested a review August 31, 2023 14:25
Comment on lines 38 to 41
* Single region, shared-cluster - K8ssandra Operator is deployed in `Control Plane` mode on the cluster. It can manage the creation of `K8ssandraCluster` objects and reconcile them locally into Cassandra clusters and nodes.
* Single region, dedicated cluster roles - K8ssandra Operator is deployed in `Control Plane` mode on a small, dedicated, k8s cluster. A separate cluster running in `Data Plane` mode contains larger instances which will be used to run Cassandra. This creates a separation between roles for each cluster (management vs production).
* Multiple region, shared cluster - One region is configured with K8ssandra Operator running in `Control Plane` mode, this cluster will run both the management operators and Cassandra nodes. Additional regions are configured in `Data Plane` mode focusing solely on Cassandra nodes and services.
* Multiple region, dedicated clusters - This model is similar to the last with the exception of a dedicated management cluster running in one of the regions. This follows the same pattern as the single region, dedicated cluster roles scenario.
Copy link
Contributor

@annieden annieden Aug 31, 2023

Choose a reason for hiding this comment

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

Suggested change
* Single region, shared-cluster - K8ssandra Operator is deployed in `Control Plane` mode on the cluster. It can manage the creation of `K8ssandraCluster` objects and reconcile them locally into Cassandra clusters and nodes.
* Single region, dedicated cluster roles - K8ssandra Operator is deployed in `Control Plane` mode on a small, dedicated, k8s cluster. A separate cluster running in `Data Plane` mode contains larger instances which will be used to run Cassandra. This creates a separation between roles for each cluster (management vs production).
* Multiple region, shared cluster - One region is configured with K8ssandra Operator running in `Control Plane` mode, this cluster will run both the management operators and Cassandra nodes. Additional regions are configured in `Data Plane` mode focusing solely on Cassandra nodes and services.
* Multiple region, dedicated clusters - This model is similar to the last with the exception of a dedicated management cluster running in one of the regions. This follows the same pattern as the single region, dedicated cluster roles scenario.
* Single-region, shared-cluster - K8ssandra Operator is deployed in `Control-Plane` mode on the cluster. It can manage the creation of `K8ssandraCluster` objects and reconcile them locally into Cassandra clusters and nodes.
* Single-region, dedicated cluster roles - K8ssandra Operator is deployed in `Control-Plane` mode on a small, dedicated, K8s cluster. A separate cluster running in `Data-Plane` mode contains larger instances in which to run Cassandra. This creates a separation between management vs. production roles for each cluster.
* Multiple-region, shared cluster - One region is configured with K8ssandra Operator running in `Control-Plane` mode. This cluster runs both the management operators and Cassandra nodes. Configure additional regions in `Data-Plane` mode to focus solely on Cassandra nodes and services.
* Multiple-region, dedicated clusters - This scenario is similar to a shared cluster with the exception of a dedicated management cluster running in one of the regions. This follows the same pattern as the single-region, dedicated cluster roles scenario.

Copy link
Contributor

Choose a reason for hiding this comment

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

Line 41 "This follows the same pattern as the single-region, dedicated cluster roles scenario." this sentence seems superfluous and may be able to be deleted?

Copy link
Member Author

Choose a reason for hiding this comment

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

this sentence seems superfluous and may be able to be deleted?

That's probably fair, I was drawing a parallel, but it isn't really necessary.

Adding dashes between Control / Data and Plane differs from the introduction of the modes previously in the doc. We should be uniform in our presentation. Which one is appropriate so I don't make this mistake again 😁 ?

Copy link
Contributor

Choose a reason for hiding this comment

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

The dashes are uniformly used in the MC customer-facing doc and are used because they modify the noun 'plane'.

Copy link
Member Author

Choose a reason for hiding this comment

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

Awesome, I wasn't indicating the suggestion was wrong. Rather that we must make sure it's applied uniformly across this page (and other pages) in the K8ssandra Operator docs. Would you like me to create a ticket indicating this is the standard to be used across our docs?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure! consistency would be good!

Copy link
Contributor

@annieden annieden left a comment

Choose a reason for hiding this comment

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

Asked a couple of questions and tightened up the text and substituted present tense when future tense was used. Once the changes are made, I can re-review and approve!

Copy link
Contributor

@adejanovski adejanovski left a comment

Choose a reason for hiding this comment

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

Looks good to me ✅

Copy link
Contributor

@annieden annieden left a comment

Choose a reason for hiding this comment

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

Left answers to your questions inline - approving

@bradfordcp
Copy link
Member Author

Squashed all the changes from review, letting the tests run and we should be good to go.

Updated node in docs build
@sonarcloud
Copy link

sonarcloud bot commented Sep 5, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@bradfordcp bradfordcp merged commit 8614857 into main Sep 5, 2023
60 checks passed
@bradfordcp bradfordcp deleted the docs/eks-quickstart branch September 5, 2023 21:13
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.

Create an installation guide for EKS
3 participants