Add some initial documentation

ph1ll · Mar 4, 2024 · a3222fb · a3222fb
1 parent 4896d16
commit a3222fb
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 8 deletions.
diff --git a/charts/netbird/Chart.yaml b/charts/netbird/Chart.yaml
@@ -15,18 +15,18 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.10
+version: 0.1.11
 
 dependencies:
   - name: dashboard
     condition: dashboard.enabled
-    version: 0.1.10
+    version: 0.1.11
   - name: management
     condition: management.enabled
-    version: 0.1.10
+    version: 0.1.11
   - name: signal
     condition: signal.enabled
-    version: 0.1.10
+    version: 0.1.11
 
 maintainers:
   - name: ph1ll
diff --git a/charts/netbird/README.md b/charts/netbird/README.md
@@ -0,0 +1,5 @@
+# Netbird
+
+A chart for [Netbird](https://netbird.io/).
+
+This chart is currently under development and could change at anytime. It is not recommended for production use.
diff --git a/charts/netbird/charts/dashboard/Chart.yaml b/charts/netbird/charts/dashboard/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.10
+version: 0.1.11
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/netbird/charts/management/Chart.yaml b/charts/netbird/charts/management/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.10
+version: 0.1.11
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/netbird/charts/management/templates/pvc.yaml b/charts/netbird/charts/management/templates/pvc.yaml
@@ -10,5 +10,5 @@ spec:
     - ReadWriteOnce
   resources:
     requests:
-      storage: "{{ .Values.persistence.size }}"
+      storage: "{{ .Values.persistence.size | default "1Gi" }}"
 {{- end -}}
diff --git a/charts/netbird/charts/signal/Chart.yaml b/charts/netbird/charts/signal/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.10
+version: 0.1.11
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/netbird/values.yaml b/charts/netbird/values.yaml
@@ -14,6 +14,9 @@ global:
         # cert-manager.io/cluster-issuer: letsencrypt
       grpc: {}
         # cert-manager.io/cluster-issuer: letsencrypt
+        ##
+        ## The following annotations are required for use with ingress-nginx
+        ##
         # nginx.ingress.kubernetes.io/backend-protocol: GRPC
         # nginx.ingress.kubernetes.io/configuration-snippet: |
         #     grpc_ssl_verify off;
@@ -22,26 +25,81 @@ global:
         #     grpc_send_timeout 1d;
 
 dashboard:
+  ##
+  ## Set to true to enable the dashboard
+  ##
   enabled: false
   auth:
+    ##
+    ## The value for 'AUTH_AUDIENCE'
+    ##
     audience: ""
+    ##
+    ## The value for 'AUTH_CLIENT_ID'
+    ##
     clientId: ""
+    ##
+    ## The value for 'AUTH_CLIENT_SECRET'
+    ##
+    ## Use 'value' to insecurely set or use 'existingSecret' to use an existing secret. 'existingSecret'
+    ## will override any 'value'.
+    ##
     clientSecret:
       value: ""
+      ##
+      ## This secret can be created as follows:
+      ##
+      ##   kubectl -n netbird create secret generic netbird-dashboard --from-literal=NETBIRD_AUTH_CLIENT_SECRET=<secret>
+      ##
       existingSecret: ""
+    ##
+    ## The value for 'AUTH_AUTHORITY'
+    ##
     authority: ""
+    ##
+    ## The value for 'AUTH_SUPPORTED_SCOPES'
+    ##
     supportedScopes: ""
+    ##
+    ## The value for 'AUTH_REDIRECT_URI'
+    ##
     redirectUri: ""
+    ##
+    ## The value for 'AUTH_SILENT_REDIRECT_URI'
+    ##
     silentRedirectUri: ""
+  ##
+  ## The value for 'USE_AUTH0'
+  ##
   useAuth0: false
+  ##
+  ## The value for 'NETBIRD_TOKEN_SOURCE'
+  ##
   tokenSource: ""
 
 management:
+  ##
+  ## Set to true to enable the management service
+  ##
   enabled: false
   configuration:
+    ##
+    ## This secret can be created from an existing management.json file as follows:
+    ##
+    ##   kubectl -n netbird create secret generic netbird-management-configuration --from-file=./management.json
+    ##
+    ## See https://docs.netbird.io/selfhosted/selfhosted-guide for a guide to creating the management.json.
+    ##
+    ## Ensure the management.json has been populated with a value for 'DataStoreEncryptionKey', which 
+    ## can be generated using 'openssl rand -base64 32'.
+    ##
     existingSecret: ""
   persistence:
     enabled: false
+    size: 1Gi
 
 signal:
+  ##
+  ## Set to true to enable the signal service
+  ##
   enabled: false