README.md

harbor-wave

STATUS: Alpha. All commands and all switches implemented. Tested a little bit to work under nominal conditions. Extensive testing has not been done.

NOTE: REPORT ALL BUGS. ISSUE TRACKER IS ENABLED AND AWAITING YOUR REPORT

Harbor Wave is an automation utility for the Digital Ocean(https://digitalocean.com), cloud service. You can now write basic applications that run both native and cloud.

It is for deploying temporary and ephemerial droplets based on custom templates, that have been previously been uploaded and compiled.

Communication and interaction between droplets is up to the application in the template, but can be facilitated via the private networking between droplets that exists by default

Based on a digital Ocean API python lib: https://github.com/koalalorenzo/python-digitalocean

This is designed as part of an application stack with Disk-Image-Scripts, which is to generate custom template images: https://github.com/GIJack/disk-image-scripts

Some example templates: https://github.com/GIJack/cloud-image-templates

Steps

One

Get a Digital Ocean Account.

https://cloud.digitalocean.com/registrations/new

Two

Setup digital Ocean Account. You need:

• SSH Key
• API Key
• DNS(optional)

Three

Upload Custom Template Image to DO. This can be done in the WebUI

https://docs.digitalocean.com/products/images/custom-images/

This project is designed with Disk-Image-Scripts in mind:

https://github.com/GIJack/disk-image-scripts

You can use disk-image scripts to create custom templates based on arch, and in the near future, debian based distros(such as Ubuntu-server), and hopefully Redhat

TODO: add this to the script, in python(needs S3/buckets NOT in the DO lib)

Four

Config harbor wave

harbor-wave touch

and then edit ~/.config/harbor-wave

OR

harbor-wave set api-key <your_do_api_key>
harbor-wave set base-name <base_name_for_vm>
harbor-wave set template <template_id>
harbor-wave set ssh-key-n <N> #index of SSH key

SSH key index, is a count-from-0 index, you can see available keys with

harbor-wave list ssh-keys

Five

Use Harbor wave

Spin up VMs with spawn. N is a number, you can spawn as many as digital ocean will let you. These will all be the same VM.

harbor-wave spawn <N>

N is optional. Its a count of machines to spin up.

To spin down the environment use the destroy command. this will destroy all machines with vm-basename. you can specify ALL, to destroy all machines with the harborwave tag

harbor-wave destroy <"ALL">

List machines associated with harborwave(based on tag)

harbor-wave list machines

List available config values, as pulled from DO servers:

harbor-wave list regions
harbor-wave list sizes
harbor-wave list templates
harbor-wave list ssh-keys

You may add terse at the end of a list command for a CSV list instead of tabbed tables

Show you Digital Ocean account balance. NOTE, you cannot add funds with this tool

harbor-wave list money-left

For more info see either

man 1 harbor-wave
harbor-wave help

User-data

Machines spun up with harbor wave have a JSON array in DO's user data for cloud-init. https://docs.digitalocean.com/products/droplets/how-to/provide-user-data/

there are five keys:

• sequence Interger, sequence number of the machine spawned
• base-name base name of the hostname
• domain Domain name if --domain is used.
• payload arbitrary string from config or command line, that allows input data to be given to the machines at spawn time
• payload-file if payload is from a file using FILE:, the name of this file.