@hiiretail/gcp-infra-cli 0.69.1 → 0.70.0

package/generators/docs/runbook/generator.json

@@ -0,0 +1,4 @@
+{
+  "name": "Runbook documentation",
+  "description": "Create a Runbook template"
+}

package/generators/docs/runbook/index.js

@@ -0,0 +1,42 @@
+const path = require('path');
+const chalk = require('chalk');
+const BaseGenerator = require('../../../src/BaseGenerator');
+const { required } = require('../../../src/validators');
+
+module.exports = class extends BaseGenerator {
+  prompting() {
+    const prompts = [
+      {
+        type: 'input',
+        name: 'system',
+        message: 'Name of the software system',
+        validate: required,
+      },
+    ];
+
+    return this.prompt(prompts).then((props) => {
+      this.answers = props;
+    });
+  }
+
+  writing() {
+    const { system } = this.answers;
+    const filename = this.kebabCase(system.toLowerCase());
+
+    this.copyDir(
+      'docs',
+      this.destinationPath(path.join('docs', filename)),
+      {
+        ...this.answers,
+        c4System: system.replace(/\s/g, ''),
+      },
+    );
+  }
+
+  end() {
+    this.log(`
+${chalk.green('Your Runbook documentation template have now been created.')}
+Next, push this change in a feature branch and open a pull request.
+`);
+  }
+};

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

@@ -0,0 +1,50 @@
+# Runbook for <%-system%>
+
+## General
+
+Describe in short what the purpose of the solution is.
+
+## Architecture
+
+Include C4 diagrams or links to the Software Guidebook.
+
+## Business Continuity and Disaster Recovery Plan
+
+Link to the Business Continuity and Disaster Recovery Plan documentation.
+
+## 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.
+
+## Dashboard
+
+Links to one or multiple dashboards.
+
+## Service Level Objectives
+
+What are the SLOs?
+
+## Alerts
+
+What are the alerts that has been setup, where is alert sent to and what are the steps to mitigate the issue?
+
+## Health Checks
+
+Links to the configured uptime checks that has been setup in GCP.
+
+## How do I..?
+
+Good to know things. Such as `How do I check the price for a specific item?`
+
+## Known Issues
+
+Are there any known issues? If yes, what is the workaround to solve them?
+
+## Contact & Escalation Matrix
+
+If the team is unable to resolve the issue, who is the first in line to contact?
+
+| #  | Name | Role | E-Mail | Phone number |
+| --- | --- | --- | --- | --- |
+| 1 | Mr X | My Role | mr.x@x.com | 1234567 |
+| 2 | Mr Y | My Role | mr.y@y.com | 7654321 |

package/package.json

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