Merge pull request #283 from openziti/controller-subcharts

clarify subcharts

charts/ziti-controller/Chart.yaml

@@ -16,4 +16,4 @@ dependencies:
 description: Host an OpenZiti controller in Kubernetes
 name: ziti-controller
 type: application
-version: 1.1.4
+version: 1.1.5

charts/ziti-controller/README.md

@@ -2,7 +2,7 @@
 
 # ziti-controller
 
-![Version: 1.1.4](https://img.shields.io/badge/Version-1.1.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.15](https://img.shields.io/badge/AppVersion-1.1.15-informational?style=flat-square)
+![Version: 1.1.5](https://img.shields.io/badge/Version-1.1.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.15](https://img.shields.io/badge/AppVersion-1.1.15-informational?style=flat-square)
 
 Host an OpenZiti controller in Kubernetes
 
@@ -28,18 +28,32 @@ The client API must be published with a TLS passthrough Ingress, NodePort, or Lo
 helm repo add openziti https://docs.openziti.io/helm-charts/
 ```
 
-This chart requires Certificate, Issuer, and Bundle resources to be applied before installing the chart. Sub-charts `cert-manager`, and `trust-manager` will be installed automatically. You may disable the sub-charts if you wish to provide these resources separately, but if you do so then please use the sub-chart values at the foot of Values.yaml to ensure those charts are correctly configured.
-
 ### Install Required Custom Resource Definitions
 
-This step satisfies Helm's requirement that the CRDs used in the umbrella chart
-already exist in Kubernetes before installing the controller chart.
+This chart requires declaring the Certificate, Issuer, and Bundle custom resource APIs before installation.
 
 ```bash
 kubectl apply -f https://github.com/cert-manager/cert-manager/releases/latest/download/cert-manager.crds.yaml
 kubectl apply -f https://raw.githubusercontent.com/cert-manager/trust-manager/v0.9.0/deploy/crds/trust.cert-manager.io_bundles.yaml
 ```
 
+## Optional Sub-Charts
+
+Ziti Controller requires Cert Manager and Trust Manager operators running in the cluster. You may use existing deployments of either or install either or both as sub-charts by setting additional input values on the command line.
+
+```bash
+--set cert-manager.enabled="true" --set trust-manager.enabled="true"
+```
+
+Or, as YAML:
+
+```yaml
+cert-manager:
+  enabled: true
+trust-manager:
+  enabled: true
+```
+
 ## Minimal Installation
 
 This first example shows a minimal installation for a Kubernetes distribution that provides TLS pass-through for Service type LoadBalancer, e.g., k3s, k3d, Minikube. This is useful for environments where there's no cost, or justifiable cost, associated with provisioning a LoadBalancer with TLS passthrough.

charts/ziti-controller/README.md.gotmpl

@@ -29,18 +29,32 @@ The client API must be published with a TLS passthrough Ingress, NodePort, or Lo
 helm repo add openziti https://docs.openziti.io/helm-charts/
 ```
 
-This chart requires Certificate, Issuer, and Bundle resources to be applied before installing the chart. Sub-charts `cert-manager`, and `trust-manager` will be installed automatically. You may disable the sub-charts if you wish to provide these resources separately, but if you do so then please use the sub-chart values at the foot of Values.yaml to ensure those charts are correctly configured.
-
 ### Install Required Custom Resource Definitions
 
-This step satisfies Helm's requirement that the CRDs used in the umbrella chart
-already exist in Kubernetes before installing the controller chart.
+This chart requires declaring the Certificate, Issuer, and Bundle custom resource APIs before installation.
 
 ```bash
 kubectl apply -f https://github.com/cert-manager/cert-manager/releases/latest/download/cert-manager.crds.yaml
 kubectl apply -f https://raw.githubusercontent.com/cert-manager/trust-manager/v0.9.0/deploy/crds/trust.cert-manager.io_bundles.yaml
 ```
 
+## Optional Sub-Charts
+
+Ziti Controller requires Cert Manager and Trust Manager operators running in the cluster. You may use existing deployments of either or install either or both as sub-charts by setting additional input values on the command line.
+
+```bash
+--set cert-manager.enabled="true" --set trust-manager.enabled="true"
+```
+
+Or, as YAML:
+
+```yaml
+cert-manager:
+  enabled: true
+trust-manager:
+  enabled: true
+```
+
 ## Minimal Installation
 
 This first example shows a minimal installation for a Kubernetes distribution that provides TLS pass-through for Service type LoadBalancer, e.g., k3s, k3d, Minikube. This is useful for environments where there's no cost, or justifiable cost, associated with provisioning a LoadBalancer with TLS passthrough.