Updates comments on extraEnvVars

nucleuscloud · Sep 18, 2024 · 97d0fb5 · 97d0fb5
1 parent 93b11df
commit 97d0fb5
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/backend/charts/api/README.md b/backend/charts/api/README.md
@@ -36,7 +36,7 @@ A Helm chart for the Neosync Backend API
 | db.port | int | `5432` | The database port |
 | db.username | string | `nil` | The username that will be used for authentication |
 | deploymentAnnotations | object | `{}` | Provide a map of deployment annotations that will be attached to the deployment's annotations |
-| extraEnvVars | list | `[]` | Provide extra environment variables that will be applied to the deployment. |
+| extraEnvVars | list | `[]` | Provide extra environment variables that will be applied to the deployment's user-container. |
 | fullnameOverride | string | `nil` | Fully overrides the chart name |
 | host | string | `"0.0.0.0"` | Sets the host that the backend will listen on. 0.0.0.0 is common for Kubernetes workloads. |
 | image.pullPolicy | string | `nil` | Overrides the default K8s pull policy |
@@ -58,7 +58,7 @@ A Helm chart for the Neosync Backend API
 | migrations.db.port | int | `5432` | The database port |
 | migrations.db.schemaDir | string | `"/migrations"` | The directory where the migrations are located. |
 | migrations.db.username | string | `nil` | The username that will be used for authentication |
-| migrations.extraEnvVars | list | `[]` | Provide extra environment variables that will be applied to the deployment. |
+| migrations.extraEnvVars | list | `[]` | Provide extra environment variables that will be applied to the migration init container. |
 | nameOverride | string | `nil` | Override the name specified on the Chart, which defaults to .Chart.Name |
 | neosyncCloud.enabled | bool | `false` | Whether or not this is NeosyncCloud |
 | neosyncCloud.workerApiKeys | list | `[]` | Worker API keys that have been allowlisted to for use |

diff --git a/backend/charts/api/values.yaml b/backend/charts/api/values.yaml
@@ -81,7 +81,7 @@ migrations:
     migrationsTableQuoted: false
     # -- Extra database options that will be appended to the query string
     options:
-  # -- Provide extra environment variables that will be applied to the deployment.
+  # -- Provide extra environment variables that will be applied to the migration init container.
   extraEnvVars: []
 
 # Set requests and limits on the backend to change its performance
@@ -239,7 +239,7 @@ protometrics:
 # -- The strategy to use when rolling out new replicas
 updateStrategy:
 
-# -- Provide extra environment variables that will be applied to the deployment.
+# -- Provide extra environment variables that will be applied to the deployment's user-container.
 extraEnvVars: []
 
 # -- Provide sidecars that will be appended directly to the deployment next to the user-container

diff --git a/backend/dev/helm/api/values.yaml b/backend/dev/helm/api/values.yaml
@@ -21,6 +21,9 @@ migrations:
     password: foofar
     disableSsl: true
     schemaDir: /app/migrations
+  extraEnvVars:
+    - name: foo
+      value: bar
 
 terminationGracePeriodSeconds: 300
 shutdownTimeoutSeconds: 5

diff --git a/charts/neosync/README.md b/charts/neosync/README.md
@@ -44,7 +44,7 @@ A Helm chart for Neosync that contains the api, app, and worker
 | api.db.port | int | `5432` | The database port |
 | api.db.username | string | `nil` | The username that will be used for authentication |
 | api.deploymentAnnotations | object | `{}` | Provide a map of deployment annotations that will be attached to the deployment's annotations |
-| api.extraEnvVars | list | `[]` | Provide extra environment variables that will be applied to the deployment. |
+| api.extraEnvVars | list | `[]` | Provide extra environment variables that will be applied to the deployment's user-container. |
 | api.fullnameOverride | string | `nil` | Fully overrides the chart name |
 | api.host | string | `"0.0.0.0"` | Sets the host that the backend will listen on. 0.0.0.0 is common for Kubernetes workloads. |
 | api.image.pullPolicy | string | `nil` | Overrides the default K8s pull policy |
@@ -66,7 +66,7 @@ A Helm chart for Neosync that contains the api, app, and worker
 | api.migrations.db.port | int | `5432` | The database port |
 | api.migrations.db.schemaDir | string | `"/migrations"` | The directory where the migrations are located. |
 | api.migrations.db.username | string | `nil` | The username that will be used for authentication |
-| api.migrations.extraEnvVars | list | `[]` | Provide extra environment variables that will be applied to the deployment. |
+| api.migrations.extraEnvVars | list | `[]` | Provide extra environment variables that will be applied to the migration init container. |
 | api.nameOverride | string | `nil` | Override the name specified on the Chart, which defaults to .Chart.Name |
 | api.neosyncCloud.enabled | bool | `false` | Whether or not this is NeosyncCloud |
 | api.neosyncCloud.workerApiKeys | list | `[]` | Worker API keys that have been allowlisted to for use |