@hiiretail/gcp-infra-cli 0.103.1 → 1.0.0

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

@@ -1,43 +0,0 @@
-# Observability and SRE
-
-<!--
-Explain what metrics you will monitor and how you will monitor them. Read through the SRE Chapter documentation
-and adopt the guidelines and naming convetions that exist, https://github.com/extenda/chap-sre-docs/blob/master/README.md
-
-List
-
-  * that the clan will use GCP Operations to monitor their service and GCP-resources
-  * that the clan will keep this documentation up-to-date through the lifecycle of the service
-  * that the clan will create and maintain a Runbook
--->
-
-## Service A
-
-<!--
-List the SLIs and SLOs per service, more information about SLIs and SLOs can be found here, https://github.com/extenda/chap-sre-docs/blob/master/docs/service-levels.md
-All services must list and explain how they will monitor and have SLOs set for:
-
-  * Availability
-  * Latency
-  * Throughput
-  * Error rate
-
-If the team need to monitor any additional SLOs, it must be mentioned how they plan to monitor that.
-
-If not using fully-managed services by Google, SLIs and SLOs needs to be set for those as well. When using fully-managed services, only SLIs needs to be monitored
-Example:
-
-  * A clan is using Cloud SQL
-  * Then they need to set SLIs and SLOs based on when they need to increase CPU and Memory for example
-
--->
-
-### SLIs
-
-### SLOs
-
-## Service B
-
-### SLIs
-
-### SLOs

package/generators/docs/srb/templates/sample.dsl

@@ -1,36 +0,0 @@
-workspace {
-  model {
-    user = person "User" "A user"
-
-    search = softwareSystem "Product Search" "Search capabilities offered over GraphQL" "Existing System"
-
-    priceRunner = softwareSystem "PriceRunner" "Compare prices from multiple suppliers" "External"
-
-    system = softwareSystem "<%-system%>" "A system to track prices on products." {
-      web = container "Web App" "A web app to track prices" "React"
-      app = container "Mobile App" "An Android app to track prices" "React Native"
-      db = container "Database" "User profile data" "CouchDB" "Database"
-      bff = container "App Backend" "Backend for the app" "Node JS"
-      topic = container "ptr.public.event.price-changed" "Topic for price changed events" "Cloud Pub/Sub" "Topic"
-    }
-
-    user -> app "Uses"
-    user -> web "Uses"
-    app -> bff "Uses" "HTTP, gRPC"
-    web -> bff "Uses" "HTTP, gRPC"
-    bff -> db "Read/Write" "TCP"
-    bff -> search "Search" "HTTP, GraphQL"
-    bff -> priceRunner "Search" "HTTP"
-    bff -> topic "Publishes events" "Pub/Sub"
-  }
-
-  views {
-    systemContext system {
-      include *
-    }
-
-    container system {
-      include *
-    }
-  }
-}

package/generators/init/clan-infra/gcp-projects.js

@@ -1,36 +0,0 @@
-const gcpProjects = {};
-
-const getGcpProjects = ({ spawnCommandSync }, name) => {
-  let projects = gcpProjects[name];
-
-  if (!projects) {
-    const result = spawnCommandSync('gcloud', [
-      'projects',
-      'list',
-      `--filter=NAME~${name}`,
-      '--format=value(PROJECT_ID)',
-    ], { encoding: 'utf8', stdio: 'pipe' });
-
-    if (result.status !== 0) {
-      throw new Error("gcloud error. Please run 'gcloud auth application-defaults login' and try again.");
-    }
-    projects = result.stdout.split(/\s+/).filter((line) => line.trim().length > 0).sort();
-    gcpProjects[name] = projects;
-  }
-
-  return projects;
-};
-
-const validateGcpProjects = ({ spawnCommandSync }, name) => {
-  try {
-    const projects = getGcpProjects({ spawnCommandSync }, name);
-    return projects.length > 0 ? true : 'Invalid input. No matching GCP project(s) found.';
-  } catch (err) {
-    return err.message;
-  }
-};
-
-module.exports = {
-  getGcpProjects,
-  validateGcpProjects,
-};

package/generators/init/clan-infra/generator.json

@@ -1,4 +0,0 @@
-{
-  "name": "Clan infrastructure repository",
-  "description": "Initialize a new clan infrastructure repository."
-}

package/generators/init/clan-infra/index.js

@@ -1,170 +0,0 @@
-const path = require('path');
-const chalk = require('chalk');
-const BaseGenerator = require('../../../src/BaseGenerator');
-const { chain, required } = require('../../../src/validators');
-const { getGcpProjects, validateGcpProjects } = require('./gcp-projects');
-const getTribeAndClanName = require('./tribe-clan-repo');
-const validate = require('./validate');
-
-module.exports = class extends BaseGenerator {
-  prompting() {
-    const { tribe: defaultTribe, clan: defaultClan } = getTribeAndClanName();
-    const validateGcpInput = (input) => validateGcpProjects(this, input);
-    const prompts = [
-      {
-        type: 'input',
-        name: 'tribe',
-        default: defaultTribe,
-        message: 'Tribe name',
-        validate: (input) => chain(input, required, validateGcpInput),
-      },
-      {
-        type: 'input',
-        name: 'clan',
-        default: defaultClan,
-        message: 'Clan name',
-        validate: (input) => chain(input, required, validateGcpInput),
-      },
-      {
-        type: 'input',
-        name: 'group',
-        message: 'Name of GitHub team that can apply changes',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'costCenter',
-        message: 'Provide the cost center your tribe belongs to',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'product',
-        message: 'Provide the product your resources belongs to. Can be modified for a specific resource later on',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'component',
-        message: 'Provide the component your resources belongs to. Can be modified for a specific resource later on',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'tenantAlias',
-        message: 'Provide the tenant alias for the resources or use \'multi-tenant\'. Can be modified for a specific resource later on.',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'jiraProjectKey',
-        message: 'Provide the "jira project key" for your clan, which is the prefix of your task names (e.g. srt, hii, hcc)',
-        validate: required && validate.jiraProjectKey,
-      },
-      {
-        type: 'input',
-        name: 'repoName',
-        default: `${defaultTribe}-${defaultClan}-common`,
-        message: 'Provide the name of your common repository',
-        validate: required,
-      },
-      {
-        type: 'input',
-        name: 'foldersToSync',
-        message: 'Provide the name of docs subfolders that you want to sync to the Developer Portal (comma-seperated). Leave empty to add it later.',
-      },
-      {
-        type: 'list',
-        name: 'syncReleaseNotes',
-        message: 'Do you want to sync release notes to the Developer Portal?',
-        default: 'false',
-        choices: ['true', 'false'],
-      },
-      {
-        type: 'input',
-        name: 'serviceName',
-        message: 'Provide the name of your service',
-        validate: required,
-      },
-    ];
-
-    return this.prompt(prompts).then((props) => {
-      this.answers = props;
-    });
-  }
-
-  writing() {
-    const {
-      clan,
-      tribe,
-      group,
-      serviceName,
-    } = this.answers;
-    const groups = group.startsWith('@') ? group : `@extenda/${group}`;
-    const [tribeProd, tribeStaging] = getGcpProjects(this, tribe);
-    const [clanProd, clanStaging] = getGcpProjects(this, clan);
-
-    this.fs.copy(
-      this.templatePath('infra', '.terragrunt-version'),
-      this.destinationPath('infra', '.terragrunt-version'),
-    );
-    this.fs.copy(
-      this.templatePath('infra', '.terraform-version'),
-      this.destinationPath('infra', '.terraform-version'),
-    );
-    this.copyDir(
-      'infra',
-      this.destinationPath('infra'),
-      this.answers,
-    );
-
-    const createEnv = (env, tribeProject, clanProject) => {
-      this.copyDir(
-        'env',
-        this.destinationPath(path.join('infra', env)),
-        {
-          ...this.answers,
-          env,
-          clanProject,
-          tribeProject,
-        },
-      );
-    };
-
-    createEnv('prod', tribeProd, clanProd);
-    createEnv('staging', tribeStaging, clanStaging);
-
-    // Init notification channels for clan
-    this.copyDir('notification-channels',
-      path.join('infra', 'prod', 'monitoring', 'notification-channels'),
-      this.answers);
-
-    this.copyDir('github',
-      this.destinationPath(path.join('.github')),
-      {
-        ...this.answers,
-        groups,
-      });
-    this.copyDir(
-      'release-notes',
-      this.destinationPath(`docs/${serviceName}/release-notes`),
-      this.answers,
-    );
-    this.copyDir(
-      'release-notes-schema',
-      this.destinationPath('docs/'),
-      this.answers,
-    );
-    this.fs.copy(
-      this.templatePath('.yamllint'),
-      this.destinationPath('.yamllint'),
-    );
-  }
-
-  end() {
-    this.log(`
-${chalk.green(`Your repository has been initialized. To finalize your configuration, please continue
-with manual creating folders and files that you want to sync to the Developer Portal.`)}
-`);
-  }
-};

package/generators/init/clan-infra/templates/.yamllint

@@ -1,17 +0,0 @@
-extends: relaxed
-rules:
-  colons:
-    max-spaces-before: 0
-    max-spaces-after: -1
-  indentation:
-    spaces: 2
-    indent-sequences: true
-    check-multi-line-strings: false
-  line-length:
-    max: 120
-    allow-non-breakable-words: true
-    level: error
-  new-line-at-end-of-file: enable
-  new-lines:
-    type: unix
-  trailing-spaces: {}

package/generators/init/clan-infra/templates/env/project.hcl

@@ -1,15 +0,0 @@
-# Set project-wide variables here. This is automatically pulled in at the root terragrunt.hcl configuration to
-# set the remote state configuration and to feed variables forward to the child modules.
-locals {
-  project_name = "<%-clan%>-<%-env%>"
-  project_id   = "<%-clanProject%>"
-  project_env  = "<%-env%>"
-
-  project               = local.project_id
-  network               = "tribe-network"
-  tribe_project_id      = "<%-tribeProject%>"
-
-  default_user_labels = {
-    environment = local.project_env,
-  }
-}

package/generators/init/clan-infra/templates/env/secrets/secrets.yaml

@@ -1,4 +0,0 @@
-# Modify the following map by adding secrets for your GCP project
-# secrets:
-#   secret-name: "secret-value"
-secrets: {}

package/generators/init/clan-infra/templates/env/secrets/terragrunt.hcl

@@ -1,31 +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-secret-manager//?ref=v0.1.2"
-}
-
-locals {
-  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
-    product      = local.common_vars.locals.product
-    tenant-alias = local.common_vars.locals.tenant_alias
-    terraform    = ""
-  })
-}
-
-# Include all settings from the root terragrunt.hcl file
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}
-
-# These are the variables we have to pass in to use the module specified in the terragrunt configuration above
-inputs = merge(
-  {
-    secrets = merge(yamldecode(file("${get_terragrunt_dir()}/secrets.yaml")).secrets,
-    { "clan_slack_channel" = local.common_vars.locals.clan_slack_channels[0].name })
-    project_id = local.project_vars.locals.project_id
-    labels     = local.labels
-  }
-)

package/generators/init/clan-infra/templates/github/CODEOWNERS

@@ -1 +0,0 @@
-infra/**        <%-groups%>

package/generators/init/clan-infra/templates/github/workflows/infra-verify.yml

@@ -1,16 +0,0 @@
-name: Infra verify
-on:
-  push:
-    branches:
-      - master
-    paths: infra/**
-
-jobs:
-  dispatch:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: extenda/actions/repository-dispatch@v0
-        with:
-          service-account-key: ${{ secrets.SECRET_AUTH }}
-          repository: extenda/tf-infra-gcp
-          event-type: clan-infra-verify

package/generators/init/clan-infra/templates/github/workflows/infra.yml

@@ -1,17 +0,0 @@
-name: Infra
-on:
-  pull_request:
-    paths: infra/**
-  issue_comment:
-    types:
-      - created
-
-jobs:
-  dispatch:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: extenda/actions/repository-dispatch@v0
-        with:
-          service-account-key: ${{ secrets.SECRET_AUTH }}
-          repository: extenda/tf-infra-gcp
-          event-type: clan-infra

package/generators/init/clan-infra/templates/github/workflows/release-notes.yml

@@ -1,33 +0,0 @@
-name: Release Notes
-on:
-  pull_request:
-    paths:
-    - 'docs/**/release-notes/*.yaml'
-    - 'docs/release-notes.schema.json'
-    - '.github/workflows/release-notes.yaml'
-
-jobs:
-  yamllint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - uses: actions/setup-python@v1
-
-      - name: Pip install
-        run: sudo pip install yamllint
-
-      - name: YAML lint
-        run: |
-          for f in docs/**/release-notes/*.yaml; do
-            yamllint docs/release-notes.schema.json -d "$f"
-          done
-
-      - name: Install pajv
-        run: sudo npm install -g pajv
-
-      - name: Validate YAML schema
-        run: |
-          for f in docs/**/release-notes/*.yaml; do
-            pajv -s docs/release-notes.schema.json -d "$f"
-          done

package/generators/init/clan-infra/templates/github/workflows/sync-docs.yml

@@ -1,29 +0,0 @@
-name: Update docs in Hii Retail Developer Portal
-
-concurrency: sync-docs
-
-on:
-  push:
-    branches:
-    - master
-    paths:
-    - 'docs/**'
-    - '.github/workflows/sync-docs.yml'
-
-jobs:
-  run:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: extenda/actions/gcp-secret-manager@v0
-        with:
-          service-account-key: ${{ secrets.SECRET_AUTH }}
-          secrets: |
-            ORG_TOKEN: github-token
-
-      - uses: extenda/actions/repository-dispatch@v0
-        with:
-          service-account-key: ${{ secrets.SECRET_AUTH }}
-          repository: extenda/hiiretail-developer-docs
-          event-type: docs-updated
-          client-payload: '{"repository": "<%-repoName%>", "folders-to-sync": "<%-foldersToSync%>", "sync-release-notes": <%-syncReleaseNotes%>}'
-          github-token: ${{ env.ORG_TOKEN }}

package/generators/init/clan-infra/templates/infra/.terraform-version

@@ -1 +0,0 @@
-1.4.6

package/generators/init/clan-infra/templates/infra/.terragrunt-version

@@ -1 +0,0 @@
-0.45.0

package/generators/init/clan-infra/templates/infra/README.md

@@ -1,5 +0,0 @@
-# Infrastructure
-
-This directory contains the infrastructure in form on Terragrunt definitions.
-The infrastructure is declared for two environments, `prod` and `staging` that
-can change indepently of each other.

package/generators/init/clan-infra/templates/infra/common.hcl

@@ -1,24 +0,0 @@
-# Set clan-wide variables here. These are automatically pulled in at the root terragrunt.hcl configuration to
-# set the remote state configuration and to feed variables forward to the child modules.
-locals {
-  tribe_name       = "<%-tribe%>"
-  clan_name        = "<%-clan%>"
-  region           = "europe-west1"
-  cost_center      = "<%-costCenter%>"
-  jira_project_key = "<%-jiraProjectKey%>"
-  component        = "<%-component%>"
-  product          = "<%-product%>"
-  tenant_alias     = "<%-tenantAlias%>"
-
-  project_id_slack_token  = "tf-admin-90301274"
-  slack_token_secret_name = "monitoring-slack-token"
-
-  clan_group_email    = "tribe-<%-tribe%>-<%-clan%>@extendaretail.com"
-  clan_slack_channels = [{ name = "#<%-tribe%>-<%-clan%>-monitor" }]
-
-  default_user_labels = {
-    clan             = local.clan_name
-    cc               = local.cost_center
-    jira_project_key = local.jira_project_key
-  }
-}

package/generators/init/clan-infra/templates/infra/terragrunt_root.hcl

@@ -1,44 +0,0 @@
-# ---------------------------------------------------------------------------------------------------------------------
-# TERRAGRUNT CONFIGURATION
-# Terragrunt is a thin wrapper for Terraform that provides extra tools for working with multiple Terraform modules,
-# remote state, and locking: https://github.com/gruntwork-io/terragrunt
-# ---------------------------------------------------------------------------------------------------------------------
-
-locals {
-  # Automatically load clan variables
-  common_vars = read_terragrunt_config(find_in_parent_folders("common.hcl"))
-
-  # Automatically load project-level variables
-  project_vars = read_terragrunt_config(find_in_parent_folders("project.hcl"))
-
-  # Extract the variables we need for the creating the remote state
-  tribe_name   = local.common_vars.locals.tribe_name
-  clan_name    = local.common_vars.locals.clan_name
-  project_name = local.project_vars.locals.project_name
-  project_env  = local.project_vars.locals.project_env
-}
-
-# Configure Terragrunt to automatically store tfstate files in a GCS bucket
-remote_state {
-  backend = "gcs"
-  config = {
-    bucket = "tf-state-${local.tribe_name}-${local.clan_name}-${local.project_env}"
-    prefix = "${path_relative_to_include()}/terraform.tfstate"
-  }
-  generate = {
-    path      = "backend.tf"
-    if_exists = "overwrite_terragrunt"
-  }
-}
-# ---------------------------------------------------------------------------------------------------------------------
-# GLOBAL PARAMETERS
-# These variables apply to all configurations in this subfolder. These are automatically merged into the child
-# `terragrunt.hcl` config via the include block.
-# ---------------------------------------------------------------------------------------------------------------------
-
-# Configure root level variables that all resources can inherit. This is especially helpful with multi-account configs
-# where terraform_remote_state data sources are placed directly into the modules.
-inputs = merge(
-  local.common_vars.locals,
-  local.project_vars.locals
-)

package/generators/init/clan-infra/templates/notification-channels/notification-channels.yaml

@@ -1,7 +0,0 @@
-slack:
-- channel_name: "#<%-tribe%>-<%-clan%>-monitor"
-  fallback_channel: true
-
-email:
-- email_address: tribe-<%-tribe%>-<%-clan%>@extendaretail.com
-  fallback_channel: true

package/generators/init/clan-infra/templates/notification-channels/terragrunt.hcl

@@ -1,29 +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-notification-channels//?ref=v1.0.1"
-}
-
-# Include all settings from the root terragrunt.hcl file
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}
-
-locals {
-  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
-    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 = {
-  project                       = local.project_vars.locals.tribe_project_id,
-  notification_channels         = yamldecode(file("${get_terragrunt_dir()}/notification-channels.yaml"))
-  slack_token_secret_project_id = local.common_vars.locals.project_id_slack_token,
-  slack_token_secret_name       = local.common_vars.locals.slack_token_secret_name,
-  default_user_labels           = local.labels,
-}

package/generators/init/clan-infra/templates/release-notes/example-service.yaml

@@ -1,23 +0,0 @@
-service_name: Example service
-service_repository: github.com/extenda/service1
-service_description: |
-  Add service description in markdown format
-releases:
-  - date: 2020-08-29
-    version: 1.1.1
-    items:
-      - type: Feature
-        exposure: public
-        description: |
-          New feature was added to the service
-      - type: Changed
-        exposure: internal
-        description: |
-          Published changes to the service from (service2)[http://example.com]
-  - date: 2020-10-14
-    version: 1.1.2
-    items:
-      - type: Feature
-        exposure: public
-        description: |
-          Serivce now supports ...