GoogleCloudPlatform · acolver · Sep 29, 2023 · Sep 15, 2023 · Sep 20, 2023 · Sep 22, 2023
@@ -4,3 +4,4 @@ sidebar_position: 4
 # Troubleshooting
 
 Please feel free to reach out and to create a [GitHub issue](https://github.com/GoogleCloudPlatform/rad-lab/issues) in case of any issues or concerns.
+
@@ -35,6 +35,7 @@ Firebase environment variables can be found in project settings section of your
 - `NEXT_PUBLIC_NOTIFICATION_TOPIC` - Topic created for notifications
 - `NEXT_PUBLIC_NOTIFICATION_SUB` - Subscription created for notifications
 - `NEXT_PUBLIC_GIT_API_URL` - Url of the public repo to pull the deployment modules
+- `SECRET_MANAGER_LOCATION` - Google Cloud region of the Secret Manager instance
 
 ## Git Hub repo envs
 

@@ -16,7 +16,23 @@ Some variables are common to all modules. Upon first log in, and Admin will set
 - Billing ID
 - Organization ID (without `organizations/`-prefix)
 - Folder ID (without `folders/`-prefix)
-- Preferred Google Cloud Region and Zone
+- Email Notification(enable/disable email notifications)
+
+#### Email Notifications
+You can optionally enable RAD Lab notification for deployment events. This includes deployment creations, updates, and deletions.
+
+If enabled, the following users/groups (defined in the module's Terraform variables) will receive email notifications:
+- The individual taking the action
+- `trusted_users`
+- `trusted_groups`
+- `owner_users`
+- `owner_groups`
+
+Currently only sending via gmail is supported. It is recommended to [create a new gmail address](https://support.google.com/mail/answer/56256?hl=en) for this purpose only and generate an `App Password` to authenticate it by following [these directions](https://support.google.com/mail/answer/185833?hl=en).
+
+ You will then provide this email and its password to RAD Lab UI via the `Global Variables` setup.
+
+The email address will be store in Firestore, and email password will be securely stored in Google's [Secret Manager](https://cloud.google.com/secret-manager)
 
 ## Module Admin Variables
 
@@ -25,3 +41,4 @@ Lastly, some modules have specific requirements for variables that typical Users
 Once an Admin tries to publish a module, if the module requires any of these variables, the Admin will be prompted. These values will be saved in Firestore and inaccessible to Users.
 
 When a User deploys a module, Global and Module Admin Variables will be combined with the variables the User provided and passed to Terraform for execution (User variables supersede all other variables of the same name, and Module Admin variable supersede Global Admin variables of the same name).
+
@@ -18,6 +18,10 @@ output "admin_group_name" {
   value = var.admin_group_name
 }
 
+output "secret_manager_location" {
+  value = var.secret_manager_location
+}
+
 output "app_engine_url" {
   value = google_app_engine_application.radlab_ui.default_hostname
 }

@@ -20,6 +20,12 @@ variable "admin_group_name" {
   default     = "rad-lab-admins"
 }
 
+variable "secret_manager_location" {
+  description = "The location where the secret is stored in the Secret Manager."
+  type        = string
+  default     = "us-central1"
+}
+
 variable "app_engine_location" {
   description = "The location where the App Engine project will be created."
   type        = string

@@ -24,3 +24,4 @@ NEXT_PUBLIC_RAD_LAB_DOCS_SITE=https://googlecloudplatform.github.io/rad-lab/
 MODULE_DEPLOYMENT_BUCKET_NAME=
 
 GIT_TOKEN_SECRET_KEY_NAME=rad-lab-git-access-token
+SECRET_MANAGER_LOCATION=
@@ -24,4 +24,5 @@ NEXT_PUBLIC_RAD_LAB_DOCS_SITE=https://googlecloudplatform.github.io/rad-lab/
 MODULE_DEPLOYMENT_BUCKET_NAME=
 
 GIT_TOKEN_SECRET_KEY_NAME=rad-lab-git-access-token
+SECRET_MANAGER_LOCATION=
 
@@ -39,6 +39,7 @@ MODULE_DEPLOYMENT_BUCKET_NAME=$(echo "${TERRAFORM_OUTPUT}" | jq -r .values.outpu
 GITHUB_URL=$(echo "${TERRAFORM_OUTPUT}" | jq -r .values.outputs.git_repo_url.value)
 GITHUB_BRANCH=$(echo "${TERRAFORM_OUTPUT}" | jq -r .values.outputs.git_repo_branch.value)
 GIT_TOKEN_SECRET_KEY_NAME=$(echo "${TERRAFORM_OUTPUT}" | jq -r .values.outputs.git_personal_access_token_secret_id.value)
+SECRET_MANAGER_LOCATION=$(echo "${TERRAFORM_OUTPUT}" | jq -r .values.outputs.secret_manager_location.value)
 cd $WEBAPP_DIR
 
 FIREBASE_CONFIG_OUTPUT=$(firebase apps:sdkconfig web --project ${PROJECT_ID} --json)
@@ -90,5 +91,6 @@ NEXT_PUBLIC_RAD_LAB_USER_GROUP=${USER_GROUP_NAME}
 MODULE_DEPLOYMENT_BUCKET_NAME=${MODULE_DEPLOYMENT_BUCKET_NAME}
 
 GIT_TOKEN_SECRET_KEY_NAME=${GIT_TOKEN_SECRET_KEY_NAME}
+SECRET_MANAGER_LOCATION=${SECRET_MANAGER_LOCATION}
 EOT
 done
@@ -18,7 +18,7 @@
   "dependencies": {
     "@google-cloud/iam-credentials": "^2.0.0",
     "@google-cloud/pubsub": "^3.0.1",
-    "@google-cloud/secret-manager": "^4.1.3",
+    "@google-cloud/secret-manager": "^4.2.2",
     "@google-cloud/storage": "^6.2.3",
     "@headlessui/react": "^1.4.3",
     "@heroicons/react": "^1.0.5",
@@ -28,13 +28,15 @@
     "firebase": "^9.6.5",
     "firebase-admin": "^11.0.1",
     "formik": "^2.2.9",
+    "handlebars": "^4.7.8",
     "hcl2-parser": "^1.0.3",
     "lodash": "^4.17.21",
     "lodash.debounce": "^4.0.8",
     "next": "^12.0.8",
     "next-i18next": "^10.2.0",
     "next-seo": "^4.29.0",
     "next-swagger-doc": "^0.3.4",
+    "nodemailer": "^6.9.5",
     "nookies": "^2.5.2",
     "ramda": "^0.28.0",
     "react": "^17.0.2",
@@ -57,6 +59,7 @@
     "@types/lodash.debounce": "^4.0.6",
     "@types/lunr": "^2.3.4",
     "@types/node": "^17.0.45",
+    "@types/nodemailer": "^6.4.10",
     "@types/ramda": "^0.28.11",
     "@types/react": "^17.0.38",
     "@types/uuid": "^8.3.4",

@@ -0,0 +1,23 @@
+<html>
+  <head>
+    <style></style>
+  </head>
+  <body>
+    <h3>Hello!</h3>
+    <p>
+      RAD Lab Module with deployment ID -
+      <a href="{{{deployment_link}}}" style="border: 0" target="_blank">
+        {{deploymentId}}</a
+      >
+      has been successfully deleted!
+    </p>
+
+    <br />
+    <p>Thank you<br /></p>
+    <img
+      style="width: 8rem; height: 2rem"
+      src="https://github.com/GPS-Demos/rad-lab/blob/main/radlab-ui/webapp/public/assets/images/logo.png?raw=true"
+    />
+    <p>P.S:- This is an auto generated email. Please do not reply!</p>
+  </body>
+</html>
@@ -0,0 +1,60 @@
+<html>
+  <head>
+    <style>
+      table {
+        font-family: arial, sans-serif;
+        border-collapse: collapse;
+        width: 40%;
+      }
+
+      td,
+      th {
+        border: 1px solid #dddddd;
+        text-align: left;
+        padding: 8px;
+      }
+    </style>
+  </head>
+  <body>
+    <h3>Hello!</h3>
+    <p>{{mailBodyTitle}}</p>
+    <p>Please use below details to access the same.</p>
+
+    <table id="myTable">
+      <tr>
+        <th>Name</th>
+        <th>value</th>
+      </tr>
+      <tr>
+        <td>Project Id</td>
+        <td>
+          <a href="{{{gcp_project_link}}}" style="border: 0" target="_blank"
+            >{{projectId}}</a
+          >
+        </td>
+      </tr>
+      <tr>
+        <td>Deployment Id</td>
+        <td>
+          <a href="{{{deployment_link}}}" style="border: 0" target="_blank"
+            >{{deploymentId}}</a
+          >
+        </td>
+      </tr>
+      {{#outputs}}
+      <tr>
+        <td>{{name}}</td>
+        <td>{{value}}</td>
+      </tr>
+      {{/outputs}}
+    </table>
+
+    <br />
+    <p>Thank you<br /></p>
+    <img
+      style="width: 8rem; height: 2rem"
+      src="https://github.com/GPS-Demos/rad-lab/blob/main/radlab-ui/webapp/public/assets/images/logo.png?raw=true"
+    />
+    <p>P.S:- This is an auto generated email. Please do not reply!</p>
+  </body>
+</html>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,3 +4,4 @@ sidebar_position: 4
		# Troubleshooting

		Please feel free to reach out and to create a [GitHub issue](https://github.com/GoogleCloudPlatform/rad-lab/issues) in case of any issues or concerns.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,3 +24,4 @@ NEXT_PUBLIC_RAD_LAB_DOCS_SITE=https://googlecloudplatform.github.io/rad-lab/
		MODULE_DEPLOYMENT_BUCKET_NAME=

		GIT_TOKEN_SECRET_KEY_NAME=rad-lab-git-access-token
		SECRET_MANAGER_LOCATION=
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,4 +24,5 @@ NEXT_PUBLIC_RAD_LAB_DOCS_SITE=https://googlecloudplatform.github.io/rad-lab/
		MODULE_DEPLOYMENT_BUCKET_NAME=

		GIT_TOKEN_SECRET_KEY_NAME=rad-lab-git-access-token
		SECRET_MANAGER_LOCATION=