-
Notifications
You must be signed in to change notification settings - Fork 79
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
Conversation
Codecov Report
@@ 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 |
* 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. |
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.
* 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. |
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.
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?
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.
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 😁 ?
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.
The dashes are uniformly used in the MC customer-facing doc and are used because they modify the noun 'plane'.
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.
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?
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.
Sure! consistency would be good!
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.
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!
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.
Looks good to me ✅
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.
Left answers to your questions inline - approving
5780fea
to
f0cd340
Compare
Squashed all the changes from review, letting the tests run and we should be good to go. |
Updated node in docs build
f0cd340
to
8714639
Compare
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
Added installation guide for EKS including:
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