DivvyCloud Test Drive Deployment¶
This document explains how to deploy DivvyCloud quickly and simply for evaluation purposes using Docker Compose. If you install DivvyCloud locally, it should take less than 15 minutes to get up and running.
To simplify installation you can run this script which will install docker & docker-compose if they are not installed, pull down the DivvyCloud docker image and run our standard compose file.
curl -s http://get.divvycloud.com | bash # Will automatically run in the foreground. Exit with ``Ctrl-C``.
If you would like to install Docker community edition and docker-compose on your own, follow the instructions below. Otherwise, continue with Logging into DivvyCloud.
Install Docker and Docker-Compose¶
Next, add the following docker-compose.yml file to your present working directory:
curl -sO http://get.divvycloud.com/compose/prod.env curl -s http://get.divvycloud.com/compose/docker-compose.db-local.yml -o docker-compose.yml
Start DivvyCloud with Docker Compose¶
Now you are ready to start DivvyCloud. To run in the foreground and see logging information in your terminal, use:
or to run in the background, use:
docker-compose up -d
Logging into DivvyCloud¶
After DivvyCloud has completed its launch, you can connect via browser using port 8001, e.g., http://localhost:8001.
The first page you see is an administrator account creation page. On the page, you enter your name and email address and create a userid and password. Your userid can be any alphanumeric. Your password must be at least 12 characters in length.
Next, you login with the administrator account credentials you just created.
When you first log in, you are on the ‘Dashboard’. There is a ‘Setup Checklist’ that guides you on useful first steps, specifically:
- Connecting a cloud account
- Adding an Insight
- Creating a Bot
- Connecting your email
- Adding an integration, e.g., Slack
After you have completed some or all of the checklist, we recommend that you examine your cloud infrastructure from the Resources section and start to explore.
You can try any of the 200+ filters available to inspect your infrastructure for specific items of interest. You can layer filters to further refine your focus.
Or, perhaps easier, look at the Insights section to see popular filters and filter combinations that are organized by category, e.g., security, cost optimization, etc.
You can try different Insights, customize them as you see fit, save them for reuse, and use them to create ‘one-click’ Bot templates that enable automated action to enforce policy, whether security or cost management.
Stop DivvyCloud with Docker Compose¶
When your evaluation is over (and we hope you enjoyed it) and you’re ready to stop, use:
Running docker-compose on instance boot¶
Simply use crontab, however instead of using a time interval use
When logged into the user who will start docker-compose, type the command
and then enter
@reboot /<path-to>/docker-compose -f /<path-to>/divvycloud/docker-compose.yml up -d
Recommended Linux Distributions¶
DivvyCloud supports two primary Linux distributions. They are:
- Ubuntu 16.04+
- CentOS 6+ (see note at bottom)
DivvyCloud requires an instance with at least:
- 4 cores
- 8 GB of memory
- 20 GB root volume
If using AWS, we recommend using a m4.xlarge instance, which has 4 cores and 16 GB, and attaching a volume with 30 GB.
If you provision an instance and would like to use Docker as a non-root user, you will need to add your user, e.g., jane_doe, to the “docker” group with something like:
sudo usermod -aG docker jane_doe
Of note, adding a user to the “docker” group will grant that user the ability to run containers, which can be used to obtain root privileges on the docker host. See https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface for more information.
Note about CentOS with SE Linux – SE Linux prevents Docker from writing MySQL data to the host system. The workaround is to run this command from the ‘divvycloud’ directory:
chcon -Rt svirt_sandbox_file_t data
Using a Proxy Server¶
If you wish to use a proxy server for your Test Drive, you will need to add your proxy information to your system’s environment variables before your installation and to your DivvyCloud environment variables after your installation.
On Ubuntu 16.04, for example, you will need to append the following to your
http_proxy=http://<insert proxy ip here>:<insert proxy port here> https_proxy=http://<insert proxy ip here>:<insert proxy port here> no_proxy=localhost,127.0.0.0,127.0.1.1,127.0.1.1,mysql,redis
After you have updated your system’s environment variables, we recommend that you log out and log back into the system to ensure they take effect. Then perform the install as instructed before returning here.
After allowing sufficient time for DivvyCloud to install, you will need to use
Ctrl+C to stop DivvyCloud so you can update its environment variables,
which are located in
/divvycloud/prod.env. As before, update the file by
# Additions for Proxy http_proxy=http://<insert proxy ip here>:<insert proxy port here> https_proxy=http://<insert proxy ip here>:<insert proxy port here> no_proxy=localhost,127.0.0.0,127.0.1.1,127.0.1.1,mysql,redis
Then restart DivvyCloud with its new settings.