[![Gem Version](https://badge.fury.io/rb/wombat-cli.svg)](http://badge.fury.io/rb/wombat-cli)
[![Build Status](https://travis-ci.org/chef-cft/wombat.svg?branch=master)](https://travis-ci.org/chef-cft/wombat)
[![Stories in Ready](https://badge.waffle.io/chef-cft/wombat.png?label=ready&title=Ready)](https://waffle.io/chef-cft/wombat)

# Wombat
Wombat (`wombat-cli`) is a gem that builds and creates demo environments using cloud-specific deployment
tools like CloudFormation. The demo environments are comprised of instances built
from the included packer templates:

* Chef Server
* Chef Automate
* Chef Compliance
* _N_ Automate Build Node(s)
* _N_ Infrastructure Nodes
* _N_ Windows Workstation

## Pre-requisites

We'll need a few things before we can get started with Wombat.

##### Install and Configure ChefDK

Follow the instructions at https://docs.chef.io/install_dk.html to install and configure ChefDK (0.19.6+) as your default version of Ruby.

*Note:* If not using ChefDK, Ruby 2.3+ is required.

##### Install Packer

Downloads are here: https://www.packer.io/downloads.html. The binary must be in $PATH for `wombat build`

##### Download your Automate license key
Automate requires a valid license to activate successfully. **If you do
not have a license key, you can request one from your CHEF account
representative.**

You will need to have the `delivery.license` file present inside  the `files/`
directory of your wombat project.

## Usage

### From Rubygems

If you are a developer or you prefer to install from Rubygems, we've got you covered.

Add Wombat to your repository's `Gemfile`:

```ruby
gem 'wombat-cli'
```

*Note:* if using Bundler, make sure to `bundle install` and prefix commands as appropriate, ex `bundle exec wombat`


Or run it as a standalone:

```shell
$ gem install wombat-cli
```

##### Get Started with Wombat

```
$ wombat init
```

This will generate a wombat skeleton project and example configuration file `wombat.yml`

*NOTE:* workstation-passwd must meet the minimum Microsoft [Complexity Requirements](https://technet.microsoft.com/en-us/library/hh994562(v=ws.11).aspx)

*NOTE:* The `googlecompute` and `azure` builders exist but not all images will build nor is there deployment support for either at this time.

##### Build images with Packer

```
# build one or more templates
$ wombat build [-o BUILDER] TEMPLATE [TEMPLATE2]

# build all templates (sequentially)
$ wombat build [-o BUILDER]

# build all images (parallel)
$ wombat build [-o BUILDER] --parallel
```

*NOTE:* If the builder is not provided it defaults to `amazon-ebs`

##### Deploy CloudFormation template

###### via AWS CloudFormation Web UI

Upload the created template from the `cloudformation` directory.

###### via CLI

```
# Deploy CloudFormation template
$ wombat deploy --update-lock --update-template
==> Updating wombat.lock
==> Generate CloudFormation JSON: STACK.json
==> Creating CloudFormation stack
Created: arn:aws:cloudformation:us-east-1:862552916454:stack/STACK/2160c580-713e-11e6-b392-50a686e4bb82
```

```
# Deploy an already generated template (pre-existing template)
# where STACK is the name of the template (w/o file extention) in the `stack_dir`
wombat deploy STACK
```

##### Login to Windows Workstation

```
# Get Windows Workstation(s) IP(s)
# where STACK is the name of the running CloudFormation stack
$ wombat outputs STACK
WindowsWorkstation (i-xxxxxxxx) => XX.XXX.XX.XXX
```

## TODO

* Complete support for Azure
* Complete support for Google Cloud Engine

From the AWS CloudFormation UI, select the Outputs tab for the desired stack.
Use an RDP compatible client to login to the workstation with the embedded credentials.

LICENSE AND AUTHORS
===================
* [Andre Elizondo](https://github.com/andrewelizondo)
* [Seth Thomas](https://github.com/cheeseplus)

```text
Copyright:: 2016 Chef Software, Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```