Add global.mongodb section (#164)

* Add global.mongodb section * Update getting-started/templates/systemlink-values.yaml Co-authored-by: Melissa Hilliard <[email protected]> * global.secrets.mongodb --------- Co-authored-by: Melissa Hilliard <[email protected]>
ni · Sep 29, 2023 · 4da6c60 · 4da6c60
1 parent d285028
commit 4da6c60
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/getting-started/templates/systemlink-secrets.yaml b/getting-started/templates/systemlink-secrets.yaml
@@ -4,6 +4,26 @@
 ## This is a YAML-formatted file.
 ## Declare override values for variables.
 
+global:
+  secrets:
+    mongodb:
+      ## <ATTENTION> - If `global.mongodb.install` is false, configure the external MongoDB connection string to be used by services in this deployment.
+      #
+      # If you are setting credentials per service (e.g. assetservice.secrets.mongodb.servicePassword) leave the placeholders
+      # <username> and <password> in the connection string. These will be replaced dynamically when deploying.
+      #
+      # If you have provisioned MongoDB to use a single set of credentials replace <username>:<password> with the values desired.
+      #
+      # <database> is required and will be replaced dynamically.
+      #
+      # examples:
+      # - MongoDB Atlas: mongodb+srv://<username>:<password>@my-atlas-cluster.mongodb.net/<database>
+      # - MongoDB Community: mongodb://<username>:<password>@my-mongodb-cluster-0,my-mongodb-cluster-1,my-mongodb-cluster-2/<database>?replicaSet=rs0
+      # - MongoDB Community (single set of credentials): mongodb://myusername:myPassw0rD@my-mongodb-cluster-0,my-mongodb-cluster-1,my-mongodb-cluster-2/<database>?replicaSet=rs0
+      #
+      # If `global.mongodb.install` is `true` leave the connection string as a blank string or comment it out.
+      connection_string: ""
+
 ## Secrets that apply to the entire application.
 ##
 secrets:

diff --git a/getting-started/templates/systemlink-values.yaml b/getting-started/templates/systemlink-values.yaml
@@ -84,6 +84,16 @@ global:
     ## CDN endpoint for telemetry-driven content. NI does not recommend changing this value.
     ##
     cdnEndpoint: "https://web-sdk.ni.com/"
+  ##
+  ## MongoDB Database Configuration.
+  ## Many Systemlink Enterprise services utilize MongoDB databases for data storage. Customers can deploy their own MongoDB instance 
+  ## or utilize a managed solution such as MongoDB Atlas. Once provisioned provide the connection details in global.secrets.mongodb.connection_string.
+  ##
+  mongodb:
+    ## Enable or disable installation of per-service MongoDB instances. 
+    #  <ATTENTION> - If you do *not* have your own MongoDB instance set this (`global.mongodb.install`) to `true`.
+    ##
+    install: false 
 
 ## Core configuration for the RabbitMQ message broker
 ##