Merge branch 'master' into release-v3.11

d2iq-archive · Jun 4, 2020 · d24fe5a · d24fe5a
2 parents 819606a + e1a7489
commit d24fe5a
Show file tree

Hide file tree

Showing 17 changed files with 64 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,7 @@ and this project adheres to
 
 ## [Unreleased]
 
-## [3.11.6-0.2.0] - 2020-06-02
+## [3.11.6-1.0.0] - 2020-06-04
 
 ### Changed
 
@@ -89,9 +89,9 @@ and this project adheres to
 - Unpriviledged container execution
 
 [unreleased]:
-  https://github.com/mesosphere/kudo-cassandra-operator/compare/v3.11.6-0.2.0...HEAD
-[3.11.6-0.2.0]:
-  https://github.com/mesosphere/kudo-cassandra-operator/compare/v3.11.5-0.1.2...v3.11.6-0.2.0
+  https://github.com/mesosphere/kudo-cassandra-operator/compare/v3.11.6-1.0.0...HEAD
+[3.11.6-1.0.0]:
+  https://github.com/mesosphere/kudo-cassandra-operator/compare/v3.11.5-0.1.2...v3.11.6-1.0.0
 [3.11.5-0.1.2]:
   https://github.com/mesosphere/kudo-cassandra-operator/compare/v3.11.5-0.1.1...v3.11.5-0.1.2
 [3.11.5-0.1.1]:

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -359,8 +359,10 @@ This is achieved by creating and merging a PR _against the stable branch_ where:
 1.  (as needed) the various `*_VERSION` variables are set as necessary for base
     tech and the operator version, according to the versioning scheme shown
     above,
-1.  necessary files are updated by running `./tools/compile_template.sh` and
-    `./tools/generate_parameters_markdown.sh`
+1.  necessary files are updated by running:
+    - `./tools/compile_template.sh`
+    - `./tools/generate_parameters_markdown.sh`
+    - `./tools/format_files.sh`
 
 #### Creating Release Notes
 

diff --git a/README.md b/README.md
@@ -56,6 +56,7 @@ kubectl kudo install cassandra
 
 | Version                                                                                          | Apache Cassandra version | Operator version | Minimum KUDO Version | Status | Release date |
 | ------------------------------------------------------------------------------------------------ | ------------------------ | ---------------- | -------------------- | ------ | ------------ |
+| [3.11.6-1.0.0](https://github.com/mesosphere/kudo-cassandra-operator/releases/tag/v3.11.6-1.0.0) | 3.11.6                   | 1.0.0            | 0.13.0               | GA     | 2020-06-04   |
 | [3.11.5-0.1.2](https://github.com/mesosphere/kudo-cassandra-operator/releases/tag/v3.11.5-0.1.2) | 3.11.5                   | 0.1.2            | 0.10.0               | beta   | 2020-01-22   |
 | [3.11.5-0.1.1](https://github.com/mesosphere/kudo-cassandra-operator/releases/tag/v3.11.5-0.1.1) | 3.11.5                   | 0.1.1            | 0.8.0                | beta   | 2019-12-12   |
 | [3.11.4-0.1.0](https://github.com/mesosphere/kudo-cassandra-operator/releases/tag/v3.11.4-0.1.0) | 3.11.4                   | 0.1.0            | 0.8.0                | beta   | 2019-11-13   |
diff --git a/benchmarks/README.md b/benchmarks/README.md
@@ -6,7 +6,7 @@
 
 ```bash
 kudo_cassandra_operator_name="cassandra"
-kudo_cassandra_operator_version="0.2.0"
+kudo_cassandra_operator_version="1.0.0"
 kudo_cassandra_instance_name="cassandra"
 kudo_cassandra_instance_namespace="cassandra"
 kudo_cassandra_statefulset_name="node"

diff --git a/benchmarks/kassandra_stress_replica_set.yaml.template b/benchmarks/kassandra_stress_replica_set.yaml.template
@@ -21,7 +21,7 @@ spec:
       containers:
       - name: cassandra-stress
         # TODO(mpereira): make this parameterizable.
-        image: mesosphere/cassandra:3.11.6-0.2.0
+        image: mesosphere/cassandra:3.11.6-1.0.0
         resources:
           requests:
             # TODO(mpereira): make this parameterizable.

diff --git a/docs/accessing.md b/docs/accessing.md
@@ -58,7 +58,7 @@ echo ${cassandra_image}
 Example output:
 
 ```
-mesosphere/cassandra:3.11.6-0.1.2
+mesosphere/cassandra:3.11.6-1.0.0
 ```
 
 #### 4. Run a command which accesses cassandra in a pod

diff --git a/docs/backup.md b/docs/backup.md
@@ -126,7 +126,7 @@ Example output:
 ```
 Plan(s) for "cassandra" in namespace "default":
 .
-└── cassandra (Operator-Version: "cassandra-0.1.2" Active-Plan: "deploy")
+└── cassandra (Operator-Version: "cassandra-1.0.0" Active-Plan: "deploy")
     ├── Plan deploy (serial strategy) [COMPLETE]
     │   └── Phase nodes (parallel strategy) [COMPLETE]
     │       └── Step node [COMPLETE]
@@ -376,7 +376,7 @@ kubectl kudo plan status --instance=$INSTANCE_NAME -n $NAMESPACE
 ```
 Plan(s) for "cassandra" in namespace "default":
 .
-└── cassandra (Operator-Version: "cassandra-0.1.2" Active-Plan: "deploy")
+└── cassandra (Operator-Version: "cassandra-1.0.0" Active-Plan: "deploy")
     ├── Plan deploy (serial strategy) [IN_PROGRESS]
     │   └── Phase nodes (parallel strategy) [IN_PROGRESS]
     │       └── Step node [IN_PROGRESS]

diff --git a/docs/installing.md b/docs/installing.md
@@ -53,10 +53,9 @@ kubectl kudo install cassandra \
 ```
 
 By default a 3-node Cassandra cluster is installed, with each Cassandra node
-requiring 1 CPU and 4GiB memory. Alongside each Cassandra node a Prometheus
-exporter container is also run, requiring 1 CPU and 512MiB memory each.
+requiring 1 CPU and 4GiB memory.
 
-The total resources needed are 6 CPUs and 13.5GiB memory
+The total resources needed are 3 CPUs and 12GiB memory
 
 The command above will start the operator instance installation. To check the
 installation progress, the KUDO CLI provides us with the `plan status` command.

diff --git a/docs/monitoring.md b/docs/monitoring.md
@@ -4,12 +4,11 @@ This guide explains how to set up monitoring for KUDO Cassandra.
 
 ## Description
 
-The KUDO Cassandra operator will export metrics to Prometheus by default. It
-achieves this using a Prometheus exporter based on the
+The KUDO Cassandra operator can export metrics to Prometheus. It achieves this
+using a Prometheus exporter based on the
 [criteo/cassandra_exporter](https://github.com/criteo/cassandra_exporter).
 
-When the `PROMETHEUS_EXPORTER_ENABLED` parameter is at its default value of
-`true`:
+When the `PROMETHEUS_EXPORTER_ENABLED` parameter is set to `true`:
 
 - A `prometheus-exporter` container will run in the same pod as every Cassandra
   `node` container. It will listen for connections on
@@ -27,7 +26,7 @@ When the `PROMETHEUS_EXPORTER_ENABLED` parameter is at its default value of
   [Grafana](https://grafana.com/) set up in the cluster. The
   [kube-prometheus](https://github.com/coreos/kube-prometheus) project provides
   both of them.
-- KUDO CLI installed (only necessary if you _had_ disabled this feature before).
+- KUDO CLI installed.
 
 The examples below assume that the instance and namespace names are stored in
 the following shell variables. With this assumptions met, you should be able to
@@ -42,11 +41,10 @@ namespace_name=default
 
 ### 1. Make sure that Prometheus Exporter is enabled on the KUDO Cassandra instance
 
-This parameter is `true` by default, so you only need to worry about this if you
-explicitly disabled it.
+This parameter is `false` by default, so you need to enable it explicitly.
 
-If you do not remember, you can check the value of the parameter on a running
-instance with a command like:
+You can check the value of the parameter on a running instance with a command
+like:
 
 ```bash
 kubectl get instance --template '{{.spec.parameters.PROMETHEUS_EXPORTER_ENABLED}}{{"\n"}} $instance_name -n $namespace_name'
@@ -92,6 +90,9 @@ match the
 [labels on the `ServiceMonitor` resource](../operator/templates/service-monitor.yaml#L7)
 created by the KUDO Cassandra operator.
 
+The Prometheus exporter container that is run alongside each Cassandra node
+requires 1 CPU and 512MiB memory each.
+
 ## Custom Configuration
 
 To use the custom