Updated Tornjak documenation with Not-for-production labels (#297)

charts/spire/README.md

@@ -115,14 +115,14 @@ Kubernetes: `>=1.21.0-0`
 | global.spire.clusterName | string | `"example-cluster"` |  |
 | global.spire.image.registry | string | `""` | Override all Spire image registries at once |
 | global.spire.trustDomain | string | `"example.org"` | The trust domain to be used for the SPIFFE identifiers |
-| spiffe-csi-driver.enabled | bool | `true` |  |
+| spiffe-csi-driver.enabled | bool | `true` | Enables deployment of CSI driver |
-| spiffe-oidc-discovery-provider.enabled | bool | `false` |  |
+| spiffe-oidc-discovery-provider.enabled | bool | `false` | Enables deployment of OIDC discovery provider |
-| spire-agent.enabled | bool | `true` |  |
+| spire-agent.enabled | bool | `true` | Enables deployment of SPIRE Agent(s) |
 | spire-agent.nameOverride | string | `"agent"` |  |
-| spire-server.controllerManager.enabled | bool | `true` |  |
+| spire-server.controllerManager.enabled | bool | `true` | Enables deployment of Controller Manager |
-| spire-server.enabled | bool | `true` |  |
+| spire-server.enabled | bool | `true` | Enables deployment of SPIRE Server |
 | spire-server.nameOverride | string | `"server"` |  |
-| tornjak-frontend.enabled | bool | `false` |  |
+| tornjak-frontend.enabled | bool | `false` | Enables deployment of Tornjak frontend/UI (Not for production) |
 | spiffe-csi-driver.agentSocketPath | string | `"/run/spire/agent-sockets/spire-agent.sock"` | The unix socket path to the spire-agent |
 | spiffe-csi-driver.fullnameOverride | string | `""` |  |
 | spiffe-csi-driver.healthChecks.port | int | `9809` |  |
@@ -356,7 +356,7 @@ Kubernetes: `>=1.21.0-0`
 | spire-server.tolerations | list | `[]` |  |
 | spire-server.topologySpreadConstraints | list | `[]` |  |
 | spire-server.tornjak.config.dataStore | object | `{"driver":"sqlite3","file":"/run/spire/data/tornjak.sqlite3"}` | persistent DB for storing Tornjak specific information |
-| spire-server.tornjak.enabled | bool | `false` | Deploys Tornjak API (backend) |
+| spire-server.tornjak.enabled | bool | `false` | Deploys Tornjak API (backend) (Not for production) |
 | spire-server.tornjak.image | object | `{"pullPolicy":"IfNotPresent","registry":"ghcr.io","repository":"spiffe/tornjak-backend","tag":"v1.2.0","version":""}` | Tornjak API image |
 | spire-server.tornjak.image.tag | string | `"v1.2.0"` | Overrides the image tag |
 | spire-server.tornjak.image.version | string | `""` | This value is deprecated in favor of tag. (Will be removed in a future release) |

charts/spire/charts/spire-server/README.md

@@ -110,7 +110,7 @@ A Helm chart to install the SPIRE server.
 | tolerations | list | `[]` |  |
 | topologySpreadConstraints | list | `[]` |  |
 | tornjak.config.dataStore | object | `{"driver":"sqlite3","file":"/run/spire/data/tornjak.sqlite3"}` | persistent DB for storing Tornjak specific information |
-| tornjak.enabled | bool | `false` | Deploys Tornjak API (backend) |
+| tornjak.enabled | bool | `false` | Deploys Tornjak API (backend) (Not for production) |
 | tornjak.image | object | `{"pullPolicy":"IfNotPresent","registry":"ghcr.io","repository":"spiffe/tornjak-backend","tag":"v1.2.0","version":""}` | Tornjak API image |
 | tornjak.image.tag | string | `"v1.2.0"` | Overrides the image tag |
 | tornjak.image.version | string | `""` | This value is deprecated in favor of tag. (Will be removed in a future release) |

charts/spire/charts/spire-server/values.yaml

@@ -266,7 +266,7 @@ nodeAttestor:
 
 # tornjak - Tornjak specific configuration
 tornjak:
-  # -- Deploys Tornjak API (backend)
+  # -- Deploys Tornjak API (backend) (Not for production)
   enabled: false
   # -- Tornjak API image
   image:

charts/spire/charts/tornjak-frontend/README.md

@@ -24,7 +24,7 @@ A Helm chart to deploy Tornjak frontend
 ## Prerequisites
 
 This chart requires access to Tornjak Backend (`tornjakFrontend.apiServerURL`).
-This URL needs to be reachable from your webbrowser and can therefore not be a cluster internal URL.
+This URL needs to be reachable from your web browser and can therefore not be a cluster internal URL.
 
 Obtain the URL for Tornjak APIs. If deployed in the same cluster, locally,
 Tornjak APIs are typically available at `http://localhost:10000`.

charts/spire/charts/tornjak-frontend/README.md.gotmpl

@@ -26,7 +26,7 @@
 ## Prerequisites
 
 This chart requires access to Tornjak Backend (`tornjakFrontend.apiServerURL`).
-This URL needs to be reachable from your webbrowser and can therefore not be a cluster internal URL.
+This URL needs to be reachable from your web browser and can therefore not be a cluster internal URL.
 
 Obtain the URL for Tornjak APIs. If deployed in the same cluster, locally,
 Tornjak APIs are typically available at `http://localhost:10000`.

charts/spire/values.yaml

@@ -26,21 +26,27 @@ global:
 
 # subcharts
 spire-server:
+  # -- Enables deployment of SPIRE Server
   enabled: true
   nameOverride: server
 
   controllerManager:
+    # -- Enables deployment of Controller Manager
     enabled: true
 
 spire-agent:
+  # -- Enables deployment of SPIRE Agent(s)
   enabled: true
   nameOverride: agent
 
 spiffe-csi-driver:
+  # -- Enables deployment of CSI driver
   enabled: true
 
 spiffe-oidc-discovery-provider:
+  # -- Enables deployment of OIDC discovery provider
   enabled: false
 
 tornjak-frontend:
+  # -- Enables deployment of Tornjak frontend/UI (Not for production)
   enabled: false