[incubator/sparkoperator] Introduce crds directory for compatibility …

…with Helm v3 (#19236) * [incubator/sparkoperator] Introduce crds directory for compatibility with Helm v3 Signed-off-by: Xiang Dai <764524258@qq.com> * remove cleanupCrdsBeforeInstall Signed-off-by: Xiang Dai <764524258@qq.com> * feedback Signed-off-by: Xiang Dai <764524258@qq.com> * add note Signed-off-by: Xiang Dai <764524258@qq.com> * fix nits Signed-off-by: Xiang Dai <764524258@qq.com>
helm · Dec 10, 2019 · 0f5eef5 · 0f5eef5
1 parent b1dc159
commit 0f5eef5
Show file tree

Hide file tree

Showing 5 changed files with 5,114 additions and 5,101 deletions.
diff --git a/incubator/sparkoperator/Chart.yaml b/incubator/sparkoperator/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v1
 name: sparkoperator
 description: A Helm chart for Spark on Kubernetes operator
-version: 0.5.0
+version: 0.6.0
 appVersion: v1beta2-1.0.1-2.4.4
 keywords:
   - spark

diff --git a/incubator/sparkoperator/README.md b/incubator/sparkoperator/README.md
@@ -34,8 +34,7 @@ The following table lists the configurable parameters of the Spark operator char
 | `controllerThreads`       | Number of worker threads used by the SparkApplication controller | 10                                 |
 | `ingressUrlFormat`        | Ingress URL format                                           | ""                                     |
 | `logLevel`                | Logging verbosity level                                      | 2                                      |
-| `installCrds`             | Whether to install CRDs                                      | true                                   |
-| `cleanupCrdsBeforeInstall` | Remove CRDs before running the crd-install hook on changes. | `false` |
+| `installCrds`             | Wether the release should install CRDs. Regardless of this value, Helm v3+ will install the CRDs if those are not present already. Use `--skip-crds` with `helm install` if you want to skip CRD creation                                         | true                                   |
 | `metricsPort`             | Port for the metrics endpoint                                | 10254                                  |
 | `metricsEndpoint`         | Metrics endpoint                                             | "/metrics"                             |
 | `metricsPrefix`           | Prefix for the metrics                                       | ""                                     |
@@ -50,6 +49,19 @@ The following table lists the configurable parameters of the Spark operator char
 
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
 
+#### Upgrading
+
+##### To 0.6.0
+
+###### Breaking changes
+
+- `cleanupCrdsBeforeInstall` has been removed for Helm 3 compatibility. If you wish to replicate this behavior before upgrading, do so manually (`kubectl delete CustomResourceDefinition sparkapplications.sparkoperator.k8s.io scheduledsparkapplications.sparkoperator.k8s.io`)
+
+###### Non-breaking changes
+
+- CRDs have been moved to `/crds` directory, with template globbing, for both Helm 2 and 3 compatibility
+- `app.kubernetes.io/name=sparkoperator` label is added to CRDs if installed at this version, for easier manual cleanup after chart deletion (`kubectl delete CustomResourceDefinition -l app.kubernetes.io/name=sparkoperator`)
+
 #### Contributing
 
 When making changes to values.yaml, update the files in `ci/` by running `hack/update-ci.sh`.