Skip to content
This repository has been archived by the owner on May 14, 2019. It is now read-only.

Latest commit

 

History

History
132 lines (101 loc) · 4.45 KB

STACKS.md

File metadata and controls

132 lines (101 loc) · 4.45 KB
Raw

Stacks

Underpinning Vagrant is something referred to as Vagrant Stacks. This pattern is another attempt by the pattern used in vagrant-stroller. In a nutshell, a user should be able to compose entire infrastructure stacks quickly and easily with Vagrant, all using potentially different options.

To accomplish this, Vagrant has been extended to read from a stack file. A stack file is simply a YAML file defining what a given infrastructure stack looks like. You can add as many stacks as you would like, and switch between them with minimal problems.

An example Vagrant Stack looks like:

---
# Defaults can be defined and reused with YAML anchors
defaults: &defaults
  domain: stackstorm.net
  memory: 2048
  cpus: 1
  box: puppetlabs/ubuntu-14.04-64-puppet
# Define as many hosts as you would like. Deep merged in!
st2server:
  <<: *defaults  # Take advantage of YAML anchors and inherit
  hostname: st2server
  # Any number of facts available to the server can be set here
  puppet:
    facts: # Apply facts to the guest OS
      role: st2server
  mounts:
    # Mounts can be in a temp directory
    - /opt/stackstorm
    # Or with an absolute path
    - "/opt/st2web:/tmp/st2web"
  # Any number of private networks can be defined
  private_networks:
    - 10.20.30.2

To switch between a stack, simply change the Environment variable stack to something else. This can be done at runtime...

stack=cicd vagrant status

... exported for a session ...

# All subsequent actions for the shell session will be this stack
export stack=cicd
vagrant status

... or set it up to stay configured indefinetely. This is done via the dotenv gem. Simply edit the file .env in the top-level of this project, and add the line stack=cicd and you're done!

See more examples in the stacks directory at the top-level of this project.

Supported Vagrant Objects

  • Hostname [hostname]
  • Domain [domain]
  • Memory [memory]
  • Private Networks [private_networks]
  • Box name [box]
  • Box URL [box_url]
  • Puppet Facts [puppet/facts]
  • Mounts [mounts]

Digital Ocean Provisioning

In addition to having constructs to manage a virtualbox or vmware_desktop image, Vagrant Stacks also supports using DO as a provisioner. To do this, you must set the following environment variables:

  • DO_SSH_KEY_PATH - Path to SSH key used to log into servers
  • DO_TOKEN - Digital Ocean Token used to provision servers

Then, in a Vagrant Stack, you can specify the following values:

...
  do:
    image: '14.04 x64'
    region: nyc3
    size: 1gb

Refer to https://www.digitalocean.com/community/tutorials/how-to-use-digitalocean-as-your-provider-in-vagrant-on-an-ubuntu-12-10-vps for more information on available options

Provisioners

Support for many provisioners out-of-the box with the ability to install st2, and perform basic tasks (install packages, configure users, setup CM downloads, etc) is a goal of this project. To that end, you can change also at runtime the provisioner used to provision a server. Set the environment variable provisioner at runtime, or in the .env file as outlined in the overview.

puppet-agent

A script is copied to /usr/bin/puprun, which will be used to do branch updates based on upstream git, and act as the masterless executor.

Puppet can run a series of environments, covered by git branching. To deploy a specific branch, simply set the environment variable environment and off you go!

Example:

environment=myawesomechange puprun

The node will stay on the myawesomechange branch until:

  • The branch is deleted from upstream, where it will automatically revert back to production, or...
  • You specify another branch to run as illustrated above

Puppet Environments

Vagrant also able to be super flexible. By default, a branch known as current_working_directory is created and used as the environment for Puppet to run in. This prevents you from having to git commit and push upstream to make and test local changes.

Vagrant has the ability to mock out different nodes, as well as different environments. Simply use the hostname and environment variables as appropriate.

Vagrant also has the ability to dynamically switch out Vagrant Baseboxes. Use the box environment variable to change it up. (More details can be found inside the Vagrantfile)

Example:

hostname=ops001 box=fedora vagrant up

The node will remain named ops001.stackstorm.net and running on Fedora until it is destroyed