@hiiretail/gcp-infra-cli 0.83.0 → 0.83.2

package/generators/docs/rca/templates/docs/rca.md

@@ -6,27 +6,27 @@
 
 **Incident end**: <!-- The date and time when the incident was resolved, for example: 2022-06-14 14.53 CET -->
 
-**Problem statement**: <!-- Describe, in short, what the problem was -->
+**Problem statement**: <!-- Describe what the problem was. It is important to keep this short, one or two sentances are enough. Example: An Out of Memory error was thrown -->
 
 **Impacted customer(s)**: <!-- What customer(s) that were affected -->
 
-**Impact to customer**: <!-- Describe how the customer, and end customers, was affected by the incident -->
+**Impact to customer**: <!-- Describe how the customer, and end customers, was affected by the incident. Where they completely unable to use the system? Or was there some feature that wasn't working? -->
 
 **Ticket information**: <!-- Add link(s) to any Jira issues -->
 
-**Services involved**: <!-- List the services that were involved in the incident -->
+**Services involved**: <!-- List the Hii Retail-service(s) that were involved in the incident, for example checkout-poslog -->
 
 ## Sequence of Events
 
 <!--
-Describe the events that caused the incident, starting from first getting notified about the incident until the incident was resolved.
+Describe the events that caused the incident, starting from when the issues started up until the incident was resolved. If no alert was triggered, the first event would be when the issues first started.
 
 Example:
 
-2022-06-14 14.36 - Alert X was triggered
-2022-06-14 14.36 - Team started working on the incident
-2022-06-14 14.49 - A fix was pushed and deployed
-2022-06-14 14.53 - Incident was resolved
+  - 2022-06-14 14.36 - Alert X was triggered
+  - 2022-06-14 14.36 - Team started working on the incident
+  - 2022-06-14 14.49 - A fix was pushed and deployed
+  - 2022-06-14 14.53 - Incident was resolved
 -->
 
 ## Five Whys
@@ -54,22 +54,25 @@ Problem: The vehicle won't start
 ## Summary
 
 <!--
-Write a short summary of what the problem was, what the root cause was and what potentially action items that were taken.
+This section should be written last, when all of the other bullets in the RCA has been written. The summary should include:
+
+* What the problem statement was, what the root cause of it was and a short summary of the highest prioritized action points.
 -->
 
 ## Action items
 
 <!--
-A table that describes the different actions that was the outcome of the analysis, who is the owner of the task and the status of the task.
-The status should be updated until the action is completed.
+A table that describes the different actions that was the outcome of the analysis and who is the owner of the task. The table should be in order of priority.
+
+When creating Jira issues, add the label "RCA" to them.
 
 Example:
-| Description | Owner | Date | Status |
+| Description | Owner | Jira issue |
 |-------------|-------|------|--------|
-| Create alert for high CPU Usage | Bob the Builder | 2022-06-14 | Not started |
-|             |       |      |        |
+| Create alert for high CPU Usage | Bob the Builder | HII-1234 |
+|             |       |      |
 -->
 
-| Description | Owner | Date | Status |
-|-------------|-------|------|--------|
-|             |       |      |        |
+| Description | Owner | Jira issue |
+|-------------|-------|------------|
+|             |       |            |

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

@@ -2,6 +2,20 @@
 
 ## General
 
+### Terms and abbreviations
+
+<!--
+Write any terms and/or abbreviations that might occur in the text below. Remember that the reader of this Runbook might be new to Hii Retail and how this system interacts with others.
+
+Example:
+
+GCP - Google Cloud Platform. Extenda Retail's choice of Cloud Platform for Hii Retail.
+CE - Checkout Engine. A system where the thin POS clients connects to and perform their daily sales operations.
+
+-->
+
+### Purpose
+
 <!-- Describe, in short, what the system does and the interactions with external and/or third party systems.
 
 Example:
@@ -83,6 +97,12 @@ Add examples on how to use the Just-In-Time Access system (https://jit-access.re
 
 ## Contact & Escalation Matrix
 
+### Slack
+
+<!-- What is the public channel to contact the team responsible for the system? For example: For general questions, reach us on Slack in #our-channel -->
+
+### Contact & Escalation Matrix
+
 <!-- 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/package.json

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