Update docs to accommmodate SPIRE being disabled by default in OSS

otterize · Aug 30, 2023 · 94f2d0f · 94f2d0f
1 parent ea7e72b
commit 94f2d0f
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 8 deletions.
diff --git a/docs/_common/install-otterize-kafka.md b/docs/_common/install-otterize-kafka.md
@@ -3,7 +3,9 @@ Use Helm to install the latest version of Otterize:
    helm repo add otterize https://helm.otterize.com
    helm repo update
    helm install -n otterize-system --create-namespace \
-   --set intentsOperator.operator.mode=defaultShadow --set intentsOperator.operator.enableNetworkPolicyCreation=false otterize otterize/otterize-kubernetes
+   --set intentsOperator.operator.mode=defaultShadow --set intentsOperator.operator.enableNetworkPolicyCreation=false \
+   --set global.deployment.spire=true --set global.deployment.credentialsOperator=true \
+   otterize otterize/otterize-kubernetes
    ```
 
 You can add the `--wait` flag for Helm to wait for deployment to complete and all pods to be Ready, or manually watch for all pods to be `Ready` using `kubectl get pods -n otterize-system -w`.
diff --git a/docs/_common/install-otterize-mtls.md b/docs/_common/install-otterize-mtls.md
@@ -0,0 +1,10 @@
+Use Helm to install the latest version of Otterize:
+   ```shell
+   helm repo add otterize https://helm.otterize.com
+   helm repo update
+   helm install -n otterize-system --create-namespace \
+   --set global.deployment.spire=true --set global.deployment.credentialsOperator=true \
+   otterize otterize/otterize-kubernetes
+   ```
+
+You can add the `--wait` flag for Helm to wait for deployment to complete and all pods to be Ready, or manually watch for all pods to be `Ready` using `kubectl get pods -n otterize-system -w`.
diff --git a/docs/quick-tutorials/k8s-mtls.mdx b/docs/quick-tutorials/k8s-mtls.mdx
@@ -38,7 +38,7 @@ So either forego browser visualization and:
 Otterize requires about 200 MBs and 200 mCPU for all components (including a SPIRE deployment) to install and run properly on Minikube and EKS clusters.
 :::
 
-{@include: ../_common/install-otterize.md}
+{@include: ../_common/install-otterize-mtls.md}
 
 </details>
 

diff --git a/docs/reference/configuration/otterize-chart/README.mdx b/docs/reference/configuration/otterize-chart/README.mdx
@@ -10,12 +10,12 @@ For example, it configures the credentials operator to work with the deployed SP
 # Parameters
 
 ## Deployment parameters
-| Key                              | Description                                    | Default |
-|----------------------------------|------------------------------------------------|---------|
-| `deployment.spire`               | Whether or not to deploy spire.                | `true`  |
-| `deployment.credentialsOperator` | Whether or not to deploy credentials-operator. | `true`  |
-| `deployment.intentsOperator`     | Whether or not to deploy intents-operator.     | `true`  |
-| `deployment.networkMapper`       | Whether or not to deploy network-mapper.       | `true`  |
+| Key                                     | Description                                                                      | Default |
+|-----------------------------------------|----------------------------------------------------------------------------------|---------|
+| `global.deployment.spire`               | Whether or not to deploy SPIRE.  Required for mTLS, if not using Otterize Cloud. | `true`  |
+| `global.deployment.credentialsOperator` | Whether or not to deploy credentials-operator. Required for mTLS.                | `false` |
+| `global.deployment.intentsOperator`     | Whether or not to deploy intents-operator.                                       | `true`  |
+| `global.deployment.networkMapper`       | Whether or not to deploy network-mapper.                                         | `true`  |
 
 ## Global parameters
 These parameters are used by multiple charts, and must be kept the same for the correct functioning of the separate components.