@hiiretail/gcp-infra-cli 0.80.1 → 0.81.0

package/generators/docs/runbook/templates/docs/runbook.md

@@ -2,47 +2,88 @@
 
 ## General
 
-<!-- Describe in short what the purpose of the solution is. -->
+<!-- Describe, in short, what the system does and the interactions with external and/or third party systems.
+
+Example:
+
+Transaction Repository is a centralized product which receives transactions from many parts of Hii Retail. The intention is to store transactions long term and to expose a search API to be able to search for transactions.
+-->
 
 ## Architecture
 
-<!-- Include C4 diagrams or links to the Software Guidebook. -->
+<!-- Include the C4 diagrams and a link to the Software Guidebook. -->
 
 ## Business Continuity and Disaster Recovery Plan
 
-<!-- Link to the Business Continuity and Disaster Recovery Plan documentation. -->
+<!-- Add a link to the Business Continuity and Disaster Recovery Plan. -->
 
 ## Services
 
-<!-- A short description of what the purpose of each service is. Links to the log files of all the services that are included in the solution. -->
+<!-- List all internal services that are a part of the system with a short explanation of their purpose and a link to the logs of the service.
+-->
 
 ## Dashboard
 
-<!-- Links to one or multiple dashboards. -->
+<!-- Add link(s) to the dashboard(s) that are setup. Write a short explanation what the dashboard displays and the purpose of it.
+-->
 
 ## Service Level Objectives
 
-<!-- What are the SLOs? -->
+<!-- Add a link or include the SLOs for each service that are defined. -->
 
 ## Alerts
 
-<!-- What are the alerts that has been setup, where is alert sent to and what are the steps to mitigate the issue? -->
+<!-- List the alerts according to the format:
+
+Alert name
+  * Description
+  * Notification channels
+  * Remediation steps
+
+Example:
+
+[P1] che.checkout-engine-isrg-nl-checkout-api - Service is offline
+
+Description: Triggers when the uptime check fails
+
+Notification channels:
+  * Slack, #monitoring-channel
+  * SMS
+  * Jira
+
+Remediation steps:
+  1. Check if the memory usage (Link to where to check that) is higher than usual (Is there a threshold?)
+  2. Check if the number of requests (Link to where to check that) are higher than usual
+  3. Follow the Contact & Escalation Matrix
+-->
 
 ## Health Checks
 
-<!-- Links to the configured uptime checks that has been setup in GCP. -->
+<!-- Add links to the configured health checks in GCP -->
+
+## Accessibility (GCP)
+
+<!-- What permissions are required to access the GCP resources that are used by the system?
+
+Example:
+  * Cloud SQL - roles/cloudsql.editor (txengine-prod-1c85)
+  * Secret Manager - roles/secretmanager.admin (cardpayment-prod-d5b4)
+
+Add examples on how to use the Just-In-Time Access system (https://jit-access.retailsvc.com/)
+-->
 
 ## How do I..?
 
-<!-- Good to know things. Such as `How do I check the price for a specific item?` -->
+<!-- Good to know things, such as "How do I connect to the database?", "How do I find a specific item?"  -->
 
 ## Known Issues
 
-<!-- Are there any known issues? If yes, what is the workaround to solve them? -->
+<!-- Are there any known issues that requires manual intervention? Is there a workaround for the issue? There should be a short description of the issue and a link to the Jira where more details can be found.
+-->
 
 ## Contact & Escalation Matrix
 
-<!-- If the team is unable to resolve the issue, who is the first in line to contact?
+<!-- If the team is unable to resolve or need to escalate an incident, who is the first to contact?
 
 | #  | Name | Role | E-Mail | Phone number |
 | --- | --- | --- | --- | --- |

package/generators/resources/monitoring/templates/alerts/alerts.yaml

@@ -85,6 +85,23 @@ cloud_sql:
               group_by_fields: ["resource.label.database_id"]
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
+  memory_over_90:
+    display_name: "[P2] <%-clan%> - CloudSQL | Memory utilization above 90%"
+    conditions:
+      - display_name: Cloud SQL Database - Memory utilization above 90% for 5 min
+        condition_threshold:
+          filter: |
+            resource.type = "cloudsql_database"
+            metric.type = "cloudsql.googleapis.com/database/memory/utilization"
+            resource.labels.project_id="<%-projectId%>"
+          threshold_value: 0.9
+          duration: 300s
+          aggregations:
+            - alignment_period: 60s
+              per_series_aligner: ALIGN_MAX
+              group_by_fields: ["resource.label.database_id"]
+    documentation:
+      content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
   query_over_1s:
     display_name: "[P4] <%-clan%> - CloudSQL | Query resolve time"
     conditions:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hiiretail/gcp-infra-cli",
-  "version": "0.80.1",
+  "version": "0.81.0",
   "description": "Infrastructure as code generator for GCP.",
   "main": "src/cli.js",
   "bin": {