@hiiretail/gcp-infra-cli 0.103.1 → 1.0.0

package/generators/common-resources/spanner/templates/spanner/terragrunt.hcl

@@ -1,33 +0,0 @@
-# Terragrunt will copy the Terraform configurations specified by the source parameter, along with any files in the
-# working directory, into a temporary folder, and execute your Terraform commands in that folder.
-terraform {
-  source = "git::https://github.com/extenda/tf-module-gcp-spanner//?ref=v1.0.0"
-}
-
-# Include all settings from the root terragrunt.hcl file
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}
-
-locals {
-  spec_vars           = read_terragrunt_config("${get_terragrunt_dir()}/spec.hcl")
-  project_vars        = read_terragrunt_config(find_in_parent_folders("project.hcl"))
-  common_vars         = read_terragrunt_config(find_in_parent_folders("common.hcl"))
-  labels = merge(local.common_vars.locals.default_user_labels, local.project_vars.locals.default_user_labels, {
-    component    = local.common_vars.locals.component
-    created      = "terraform"
-    product      = local.common_vars.locals.product
-    tenant-alias = local.common_vars.locals.tenant_alias
-  })
-}
-
-# These are the variables we have to pass in to use the module specified in the terragrunt configuration above
-inputs = merge(<% if (resourceType == 'instance') { %><% } else { %>
-  yamldecode(
-  file("${get_terragrunt_dir()}/databases.yaml")),<% } %>
-  local.spec_vars.locals,
-  local.project_vars.locals,
-  {
-    instance_labels = local.labels
-  }
-)

package/generators/common-resources/spanner/validate.js

@@ -1,38 +0,0 @@
-const validName = (input) => {
-  if (input.replace(/\s/g, '').length >= 6 && input.length <= 30) {
-    return true;
-  }
-  return 'Name must be between 6 and 30 characters in length';
-};
-
-const validRetentionPeriod = (input) => {
-  const validFormats = /^(84000s|1h|2d|7d)$/;
-
-  if (input === '') {
-    return true;
-  }
-  if (validFormats.test(input)) {
-    return true;
-  }
-
-  return 'Invalid retention period format. Possible values are 84000s, 1h, 2d, or leave empty for default value 1h';
-};
-
-const validBackupSchedule = (input) => {
-  const validFormats = /^(((\d+,)+\d+|(\d+(\/|-)\d+)|\d+|\*) ?){5}$/;
-
-  if (input === '') {
-    return true;
-  }
-  if (validFormats.test(input)) {
-    return true;
-  }
-
-  return 'Invalid backup schedule format. Possible values are cron expressions like "0 2 * * *"';
-};
-
-module.exports = {
-  validName,
-  validRetentionPeriod,
-  validBackupSchedule,
-};

package/generators/docs/command.json

@@ -1,7 +0,0 @@
-{
-  "description": "Documentation templates.",
-  "query": "What documentation template do you want to create?",
-  "require": [
-    "git-repo"
-  ]
-}

package/generators/docs/rca/generator.json

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

package/generators/docs/rca/index.js

@@ -1,50 +0,0 @@
-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: 'description',
-        message: 'A very short description of the problem',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'date',
-        message: 'Date of the incident',
-        validate: required,
-      },
-    ];
-
-    return this.prompt(prompts).then((props) => {
-      this.answers = props;
-    });
-  }
-
-  writing() {
-    const { date } = this.answers;
-    const filenameInternal = 'rca_internal';
-    const filenameExternal = 'rca_external';
-
-    this.fs.copyTpl(
-      this.templatePath('docs', 'rca_internal.md'),
-      this.destinationPath('docs', 'rca', date, `${filenameInternal}.md`),
-      this.answers,
-    );
-    this.fs.copyTpl(
-      this.templatePath('docs', 'rca_external.md'),
-      this.destinationPath('docs', 'rca', date, `${filenameExternal}.md`),
-      this.answers,
-    );
-  }
-
-  end() {
-    this.log(`
-${chalk.green('Your RCA template have now been created.')}
-Next, push this change in a feature branch and open a pull request.
-`);
-  }
-};

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

@@ -1,43 +0,0 @@
-# RCA External - <%-description%> - <%-date%>
-
-## Summary
-
-<!--
-Briefly summarize what happened, who was impacted (e.g., end-users, stores), and the business consequences (e.g., data loss, incorrect pricing, downtime).
-  * Incident Description: Brief overview of what happened (2-3 sentences)
-  * Root Cause: One-sentence explanation of the fundamental issue
-  * Resolution: Brief description of how the issue was resolved
-  * Resolution Time: When the issue was fully resolved
--->
-
-## Technical Details
-
-<!--
-Provide a clear explanation of the technical root cause. Include:
-  * What change or event triggered the incident
-  * How the system behaved unexpectedly
-  * Details about any configuration changes, bugs, or missing logic
-
-Any dependencies or services involved.
--->
-
-## Impact
-
-<!--
-Describe the direct and indirect consequences of the incident.
-  * Customer Impact: How customers/end-users were affected
-  * Business Impact: Financial or operational consequences
-  * Duration: Total time the issue persisted
-  * Scope: Which systems/users were affected
--->
-
-## Lessons Learned
-
-<!--
-Highlight what could have prevented the incident:
-
-  * Gaps in testing
-  * Gaps in monitoring
-  * Gaps in requirements
-  * etc.
--->

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

@@ -1,88 +0,0 @@
-# RCA Internal - <%-description%> - <%-date%>
-
-## Overview
-
-**Incident start**: <!-- The date and time when the incident started, for example: 2022-06-14 14.36 CET -->
-
-**Incident end**: <!-- The date and time when the incident was resolved, for example: 2022-06-14 14.53 CET -->
-
-**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. 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 in the format of:
-
-  - [EXTINTERAL-1234](https://extendaretail.atlassian.net/browse/EXTINTERAL-1234)
-
--->
-
-**Services involved**: <!-- List the Hii Retail-service(s) that were involved in the incident, for example checkout-poslog. If multiple services/systems are involved, just mention the systems such as: Checkout Engine, Store Data etc. -->
-
-## Summary
-
-<!--
-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.
--->
-
-## Sequence of Events
-
-<!--
-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:
-
-  - 2024-03-27 14.36 CET - Alert X was triggered
-  - 2024-03-27 14.36 CET - Team started working on the incident
-  - 2024-03-27 14.49 CET - A fix was pushed and deployed
-  - 2024-03-27 14.53 CET - Incident was resolved
--->
-
-## Five Whys
-
-<!--
-Five whys is a technique used to explore the cause and effect underlying a particular problem. The primary goal of the technique is to determine the root cause of a problem by repeating the question "Why?". Each answer forms the basis of the next question.
-
-Note: It is not a requirement to add exactly 5 whys. If the root cause is found at the third why, it is not necessary to continue. The main point is to find the root cause within 5 steps.
-
-Example:
-
-**Problem**: The vehicle won't start
-
-  1. __Why?__ - The battery is dead (First why)
-  2. __Why?__ - The alternator is not functioning (Second why)
-  3. __Why?__ - The alternator belt is broken (Third why)
-  4. __Why?__ - The alternator belt was well beyond its useful service life and not replaced. (Fourth why)
-  5. __Why?__ - The vehicle was not maintained according to the recommended service schedule. (Fifth why, the root cause)
--->
-
-**Problem**:
-
-  1. __Why?__
-  2. __Why?__
-  3. __Why?__
-  4. __Why?__
-  5. __Why?__
-
-## Action items
-
-<!--
-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 | Jira issue |
-|-------------|-------|------|--------|
-| Create alert for high CPU Usage | Bob the Builder | HII-1234 |
-|             |       |      |
--->
-
-| Description | Owner | Jira issue |
-|-------------|-------|------------|
-|             |       |            |

package/generators/docs/runbook/generator.json

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

package/generators/docs/runbook/index.js

@@ -1,42 +0,0 @@
-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

@@ -1,106 +0,0 @@
-# Runbook for <%-system%>
-
-## 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:
-
-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 the C4 diagrams and a link to the Software Guidebook. -->
-
-## Business Continuity and Disaster Recovery Plan
-
-<!-- Add a link to the Business Continuity and Disaster Recovery Plan. -->
-
-## Services
-
-<!-- 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
-
-<!-- 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
-
-<!-- Add a link or include the SLOs for each service that are defined. -->
-
-## Alerts
-
-<!-- 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
-
-<!-- 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 connect to the database?", "How do I find a specific item?"  -->
-
-## Known Issues
-
-<!-- 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
-
-### 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 -->
-
-### Escalation
-
-For escalation of production issues, see the [Who is on-call](https://extenda.hiiretail.com/sre-admin/whoisoncall) on who to contact.

package/generators/docs/srb/generator.json

@@ -1,4 +0,0 @@
-{
-  "name": "SRB documentation",
-  "description": "Create an SRB template with C4 tooling."
-}

package/generators/docs/srb/index.js

@@ -1,62 +0,0 @@
-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, ''),
-      },
-    );
-
-    this.fs.copyTpl(
-      this.templatePath('sample.dsl'),
-      this.destinationPath('docs', filename, `${filename}.dsl`),
-      this.answers,
-    );
-  }
-
-  install() {
-    const { system } = this.answers;
-    const filename = this.kebabCase(system.toLowerCase());
-    const baseArgs = [
-      'run',
-      '--pull=always',
-      '--rm',
-      '-it',
-      '-v', `${this.destinationPath('docs', filename)}:/docs`,
-    ];
-    this.spawnCommandSync('docker', [...baseArgs, 'extenda/adr-tools', 'init', 'adr'], { encoding: 'utf8' });
-    this.spawnCommandSync('docker', [...baseArgs, 'extenda/structurizr-to-png'], { encoding: 'utf8' });
-  }
-
-  end() {
-    this.log(`
-${chalk.green('Your system documentation stubs have now been created.')}
-Next, push this change in a feature branch and open a pull request.
-`);
-  }
-};

package/generators/docs/srb/templates/docs/README.md

@@ -1,42 +0,0 @@
-# <%-system%>
-
-This is the architectural documentation for <%-system%>. It describes the architecture of <%-system%>.
-and is the source of truth for the system architecture.
-
-See the [Solution Review Board (SRB)](https://confluence.extendaretail.com/display/DEV/Solution+review+board) for more information on what documentation to provide for all software systems. This documentation must be updated as the system evolves to always describe the system in its current state.
-
-## :book: Contents
-
-  * :cloud: [Architecture](./architecture.md)
-  * :dollar: [Cost estimates](./cost-estimates.md)
-  * :chart_with_upwards_trend: [Observability and SRE](./sre.md)
-
-## :pencil2: How to update generated content
-
-Parts of the documentation is generated using the following tooling.
-
-### C4 diagrams
-
-All C4 diagrams must be created with [Structurizr DSL](https://github.com/structurizr/dsl#readme). Use the provided
-`dsl2png.sh` script to create PNG images from the DSL. Use the `--watch` flag while making changes.
-This will give a live preview of the diagram(s) in your browser at http://localhost:3000.
-
-```bash
-./dsl2png.sh --watch
-```
-> :bulb: On Windows 10? Use `dsl2png.cmd` instead.
-
-### Architecture decision records (ADRs)
-
-Use [ADRs](https://adr.github.io) to track architectural decisions. All significant decisions should be tracked to
-help future developers understand the reasons a technology is used. It will also help developers to replace technology
-when they understand why it was used from the start.
-
-Use the provided `adr.sh` script to create ADR entries and to update the ADR log in this document. The script combines
-[adr-tools](https://github.com/npryce/adr-tools) and [adr-log](https://github.com/adr/adr-log).
-See [adr-tools docs](https://github.com/npryce/adr-tools#readme) for available commands.
-
-```bash
-./adr.sh help
-```
-> :bulb: On Windows 10? Use `adr.cmd` instead.

package/generators/docs/srb/templates/docs/adr.cmd

@@ -1,3 +0,0 @@
-@echo off
-docker pull --quiet extenda/adr-tools
-docker run --rm -it -v "%CD%":/docs extenda/adr-tools %*

package/generators/docs/srb/templates/docs/adr.sh

@@ -1,4 +0,0 @@
-#!/bin/sh
-set -e
-docker pull --quiet extenda/adr-tools
-exec docker run --rm -it -v "$(pwd)":/docs extenda/adr-tools "$@"

package/generators/docs/srb/templates/docs/architecture.md

@@ -1,68 +0,0 @@
-# Architecture
-
-## System context
-
-![System context](images/structurizr-<%-c4System%>-SystemContext.png)
-
-## Containers
-
-![Containers](images/structurizr-<%-c4System%>-Container.png)
-
-## Architecture decision records
-
-<!-- adrlog -->
-<!-- adrlogstop -->
-
-## APIs
-
-<!--
-List the APIs.
-  * On a live service in prod, this ideally points to the developer portal API.
-  * During the design phase, this can point to
-
-    1. a formal spec (OpenAPI, JSON Schema, Avro, gRPC etc) draft in a repo,
-    2. a google sheet,
-    3. or an image.
-
-    The important thing is that the system APIs should be available to explore
-    to make it easier to understand the solution design.
--->
-
-The following APIs are part of <%-system%>:
-
-  * ...
-
-## IDEALS
-
-Hii Retail services adheres to [the IDEALS principles](https://www.infoq.com/articles/microservices-design-ideals/)
-in microservice architecture. This section covers how the design choices in <%-system%> fulfills the IDEALS.
-
-### Interface segregation
-
-### Deployability
-
-### Event-driven
-
-### Availability over consistency
-
-### Loose-coupling
-
-### Single responsibility
-
-## General considerations
-
-General Hii Retail design considerations as applied to <%-system%>.
-
-### Multi-tenancy
-
-### Auditing
-
-### Security
-
-### Legal compliance
-
-### Data mesh
-
-### Global reach
-
-### Internationalization

package/generators/docs/srb/templates/docs/cost-estimates.md

@@ -1,39 +0,0 @@
-# Cost estimates
-
-## Google cloud operations costs
-
-### Assumptions
-
-<!--
-Explain what assumption you've made as part of your price estimates.
-For example, number of messages per second, size of stored data,
-number of connected clients etc.
--->
-
-### Calculations
-
-<!--
-Share a link to the Google Price Calculator with your calculations.
-
-  * Include all components used in your C4 diagrams
-  * Present calculations with enough details to understand cost drivers.
-  * Presented a tiered table and show the cost for different volumes
-  * Include the cost for data in the data mesh
-
-Google Price Calculator hints
-
-  * Use "GKE Node Pool" to calculate cost of Cloud Run for Anthos
-  * Always calculate with high availability for Cloud SQL
-  * Only include network egress if your system is egress-heavy. It should
-    for example be included in external events, but not for scan & go
--->
-
-## High-level cost drivers
-
-<!--
-How would you sell this service to customers? What is the billable metrics of
-this service? There's two types of metrics we want to capture
-
-  * Seat based - for example number of clients or users
-  * Usage based - for example number of price updates per month
--->

package/generators/docs/srb/templates/docs/dsl2png.cmd

@@ -1,3 +0,0 @@
-@echo off
-docker pull --quiet extenda/structurizr-to-png
-docker run --rm -it -v "%CD%":/docs -p 3000:3000 extenda/structurizr-to-png %*

package/generators/docs/srb/templates/docs/dsl2png.sh

@@ -1,4 +0,0 @@
-#!/bin/sh
-set -e
-docker pull --quiet extenda/structurizr-to-png
-exec docker run --rm -it -v "$(pwd)":/docs -p 3000:3000 extenda/structurizr-to-png "$@"