Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davidalger/testocean

Test Ocean provides a quick and easy way to create and destroy ad-hoc testing servers via Terraform
https://github.com/davidalger/testocean

digitalocean terraform testing-tools

Last synced: about 10 hours ago
JSON representation

Test Ocean provides a quick and easy way to create and destroy ad-hoc testing servers via Terraform

Awesome Lists containing this project

README 

        
## Test Ocean



Simple Terraform environment used to quickly spin up droplets on Digital Ocean for ad-hoc testing of things such as scripts, recipes, playbooks, etc against a fresh Enterprise Linux installation.



### Requirements



* Digital Ocean account

* Terraform v0.12 or later



### Setup



1. Create a Digital Ocean account if you don't already have one



2. After logging into your Digital Ocean account, navigate to API and create a new Personal Access Token (copy this as you will need the key in step #6)



3. Go to Account -> Settings -> Security and click Add SSH Key to configure your public key for authorization on newly created droplets (make note of the Fingerprint displayed after you save the newly added SSH key as you will need this fingerprint in step #6)



4. Clone this repository to a local directory of your choice



5. Copy `terraform.tfvars.sample` to `terraform.tfvars`



6. Configure your API key (from step #2) and SSH key fingerprint (from step #3) in `terraform.tfvars`



7. Run `terraform init` from the repository root



8. Your test ocean is ready for surfing! See the Usage section below for how to start your droplets.



### Usage



Each of the commands below should be run locally from the repository root. Also note that when running `terraform apply` without any parameters nothing is spun up by default:



```bash

$ terraform apply



Apply complete! Resources: 0 added, 0 changed, 0 destroyed.



Outputs:



droplet_ipv4_addresses = {}

```



You can alter this behavior by setting a different default `droplet_count` value in the `terraform.tfvars` file but note that this will change the procedure for terminating droplets to using the `terraform destroy` command vs what is documented below.



When droplets are created, the `whoami` command is used to initialize an admin shell user corresponding to your local shell user. This is also used as part of the droplet naming pattern for easy identification. The default 'centos' or 'ubuntu' users will not be created as a result. When connecting via SSH, this means it should be sufficient to simply type `ssh ` on the command line to authenticate as the created user. Note that it may take a minute or two for the cloud-init system to prepare the shell user for use.



#### Spawning Droplets



To spin up your test ocean, run the `terraform apply` command specifying how many droplets you would like spun up like so:



    terraform apply -var droplet_count=5



Reference the `droplet_ipv4_addresses` output on the CLI for the names and corresponding IP addresses of spawned droplets.



#### Terminating Droplets



To terminate all droplets in your test ocean, simply run `terraform apply` with no `droplet_count` specified. This effectively executes with a `droplet_count` of "0" resulting in the previously spawned droplets being destroyed.



    terraform apply



### Configuration



* `droplet_size` defaults to `512mb` in provided *.tfvars file.

* `droplet_image` defaults to `centos-7-x64` in provided *.tfvars file.

* `droplet_region` defaults to `sfo2` in provided *.tfvars file.



To find alternate valid values for these variables, one may use the following [doctl](https://github.com/digitalocean/doctl/) CLI client (reference the doctl README for doctl setup procedure) commands:



* `doctl compute size list`

* `doctl compute image list --public`

* `doctl compute region list`