deploystack

README

DeployStack

This project is to centralize all of the tools and processes to get terminal interfaces for collecting information from users for use with DeployStack.

Authoring

TLDR;

Quick TLDR omitting testing, which you should totally do but for development and whatnot you can just do this.

1. Create a Folder to hold your stack.
2. Add your main.tf file
3. Create a .deploystack folder
4. Add a deploystack.yaml file

Running ./deploystack install should spin up the goapp and collect the config items the stack needs to run through the deployment

Running ./deploystack uninstall will destory the whole thing.

Details

Authors are required to make or edit 4 files.

• main.tf
• .deploystack/deploystack.yaml
• .deploystack/test

main.tf

This is a standard terraform file with one adjustment for the DeployStack setup. These files should have several import variables setup with the idea that the golang helper will get them from the user.

variable "project_id" {
  type = string
}

variable "project_number" {
  type = string
}

variable "region" {
  type = string
}

variable "zone" {
  type = string
}

DeployStack will also work with the more standard convention of having separate main.tf, variables.tf, output.tf, etc files.

deploystack.yaml

This config will be read by the golang helper to prompt the user to create a tfvars file that will drive the terraform script.

title: Basic Title
duration: 5
collect_project: true
collect_region: true
region_type: functions
region_default: us-central1
collect_zone: true
hard_settings:
  basename: appprefix
custom_settings:
- name: nodes
  description: Please enter the number of nodes
  options:
  - roles/reviewer|Project Reviewer
  - roles/owner|Project Owner
  - roles/vison.reader|Cloud Vision Reader
  default: roles/owner|Project Owner
projects:
  allow_duplicates: false
  items:
  - variable_name: project_id
    user_prompt: Choose a project to use for this application
    set_as_default: true
  - variable_name: project_id_2
    user_prompt: Choose a second project to use for this application
    set_as_default: false

JSON is also allowed

DeployStack Config Settings

These are now documented in deploystack/config.

messages/description.txt

DEPRECATED: This file allows you to add a formatted description to the configuration to print out to the user. Json files don't do well with newlines. Using Description in deploystack.yaml is now prefered

test

Test is a shell script that tests the individual pieces of the infrastructure and tests the desired state at the end of the install.

There are a few functions in the template test file that will help you run one of these.

• section_open - a display function that hellps communicate what is going on.
• section_close - paired with section_open
• evaltest - take a gcloud command and a desired outcome to make test assertions

# Setup variables here
source globals
get_project_id PROJECT
get_project_number PROJECT_NUMBER $PROJECT
REGION=us-central1
ZONE=us-central1-a
BASENAME=basiclb
SIZE=3

# Make sure that project is hard set
gcloud config set project ${PROJECT}

# spin up terraform with variables plugged in to build the infrastructure
terraform init
terraform apply -auto-approve -var project_id="${PROJECT}" -var project_number="${PROJECT_NUMBER}" -var region="${REGION}" -var zone="${ZONE}" -var basename="${BASENAME}" -var nodes="${SIZE}"

# You might hace to do some editing here to make these tests work
section_open "Test Managed Instance Group"
    evalTest 'gcloud compute instance-groups managed describe $BASENAME-mig --zone $ZONE --format="value(name)"'  $BASENAME-mig

    COUNT=$(gcloud compute instances list --format="value(name)" | grep $BASENAME-mig | wc -l | xargs)

    if [ $COUNT -ne $SIZE ]
    then
        printf "Halting - error: expected $SIZE instances of GCE got $COUNT  \n"
        exit 1
    else
         printf "number of GCE instances is ok \n"
    fi

section_close

# But in a lot of cases we can just use eval test with a gcloud command and a
# desrired result.
section_open "Test Instance Template"
    evalTest 'gcloud compute instance-templates describe $BASENAME-template --format="value(name)"'  $BASENAME-template
section_close

..

# Now run a destroy operation.
terraform destroy -auto-approve -var project_id="${BASENAME}" -var project_number="${PROJECT_NUMBER}" -var region="${REGION}" -var zone="${ZONE}" -var basename="${BASENAME}" -var nodes="${SIZE}"

# Test all of the parts are destroyed
section_open "Test Managed Instance Group doesn't exist"
    evalTest 'gcloud compute instance-groups managed describe $BASENAME-mig --zone $ZONE --format="value(name)"'  "EXPECTERROR"
section_close

printf "$DIVIDER"
printf "CONGRATS!!!!!!! \n"
printf "You got the end the of your test with everything working. \n"
printf "$DIVIDER"

Testing this Repo

In order to test the helper app in this repo, we need to do a fair amount of manipulation of projects and what not. To faciliate that the tests require a Service Account key json file. To faciliate this there is a script in tools/credsfile that will create a service account, give it the right access and service enablements, and export out a key file to use with testing.

This is not an offical Google product.

Documentation

Overview

Package deploystack provides a series of interfaces for getting Google Cloud settings and configurations for use with DeplyStack

Index

• func AttemptRepo(name, wd string) (string, github.Repo, error)
• func ContactCheck() gcloud.ContactData
• func ContactSave(i interface{})
• func DownloadRepo(repo github.Repo, path string) (string, error)
• func Init(path string) (*config.Stack, error)
• func Precheck() error
• func UniquePath(candidate string) string
• func WriteConfig(dir string, gh github.Repo) error
• type Meta
  • func NewMeta(path string) (Meta, error)
  • func (m Meta) ShortName() string
  • func (m Meta) ShortNameUnderscore() string
  • func (m Meta) Suggest() (config.Config, error)

Functions

func AttemptRepo

func AttemptRepo(name, wd string) (string, github.Repo, error)

AttemptRepo will try to download a repo - only from GoogleCloudPlatform. If it fails, it will append "deploystack-" to the front of the requested name and try again.

func ContactCheck

func ContactCheck() gcloud.ContactData

ContactCheck checks the local file system for a file containg domain registar contact info

func ContactSave

func ContactSave(i interface{})

ContactSave writes a file containg domain registar contact info to disk if it exists

func DownloadRepo

func DownloadRepo(repo github.Repo, path string) (string, error)

DownloadRepo takes a name of a GoogleCloudPlatform repo or a GoogleCloudPlatform/deploystack-[name] repo, and downloads it into a unique folder name, and outputs that name

func Init

func Init(path string) (*config.Stack, error)

Init initializes a Deploystack stack by looking on teh local file system

func Precheck

func Precheck() error

Precheck handles the logic around switching working directories for multiple stacks in one repo

func UniquePath

func UniquePath(candidate string) string

UniquePath returns either the input candidate path if it does not exist, or a path like the input candidate with increasing nubmers appended to it until the ouput name is a path that does not exist

func WriteConfig

func WriteConfig(dir string, gh github.Repo) error

WriteConfig will drop a .deploystack folder with deploystack.yaml file for repos that do not have one.

Types

type Meta

type Meta struct {
	DeployStack config.Config
	Terraform   terraform.Blocks `json:"terraform" yaml:"terraform"`
	Github      github.Repo      `json:"github" yaml:"github"`
	LocalPath   string           `json:"localpath" yaml:"localpath"`
}

Meta is a datastructure that combines the Deploystack, github and Terraform bits of metadata about a stack.

func NewMeta

func NewMeta(path string) (Meta, error)

NewMeta allows project to point at local directories for info as well as pulling down from github

func (Meta) ShortName

func (m Meta) ShortName() string

ShortName retrieves the shortname of whatever we are calling this stack

func (Meta) ShortNameUnderscore

func (m Meta) ShortNameUnderscore() string

ShortNameUnderscore retrieves the shortname of whatever we are calling this stack replacing hyphens with underscores

func (Meta) Suggest

func (m Meta) Suggest() (config.Config, error)

Suggest will provide it's best guess of what the deploystack config should be based on the contents of the repo, including an existing deploystack config