docker_compose_deploy 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d9dcaa86394d8c24329b214fb239286ff77c0ac
-  data.tar.gz: d7643624e310fbd8305031e50187448a5688fd0b
+  metadata.gz: a774694b30eb0776bd8680e03ddb32587568420a
+  data.tar.gz: 2c59b4d8628a72430f1f87eb547fc3d30ba111e6
 SHA512:
-  metadata.gz: 914b2cb664887b55b8331a0b8d472c7b671b19662d9cafe008b0b00fe9fa93a3f45d78d79a544f105d774d6189ccfe12d1f435a3a43cab875d2597aca484c998
-  data.tar.gz: bb5c8425e50700e879e9b77d5176f744f3b822b79ddea3ab760280017e12be711a15db98e4cf3471f9b7fc08fb1e9d4704f98c326f9e0f2bb4b4916b010437aa
+  metadata.gz: dda2d468c2d77d01e5c8e9c8ebdff23327e58709cc84bcbafcc9b44d7b6f9577c549f46c529c903a08d6d5bb08c6e5048fcb1061f37624b2c896ac642e5d3af3
+  data.tar.gz: 36f940feea352bba112f9b2421f38d2f593731bd7bacde7f199d6aab6e2ded846e0a99ff4d4e4f1b28d9335afa1c4f032270ba27604b225fdbbc3375f4c0740e

data/README.md

@@ -6,12 +6,27 @@ This gem is a collection of scripts that I use to deploy my personal websites us
 - Provision a server with Docker and Docker Compose
 - Test your deployment on a vagrant machine
 - Deploy your docker-compose project
-- Backup the data that your applications Generate
+- Backup the data that your applications generate
 
 While these scripts are great for your personal projects, they will not help you with zero-downtime deploys, rotating your logs, or any of that other fancy stuff.
 
 This doesn't provide much over using docker-machine, but it will simplify working with volumes and allow you to test your deployment in a realistic environment.
 
+### Commands
+
+Each command takes an optional `-e [environment]`. If the environment is not set, it will default to `test`. This environment corresponds to the entry in `config.yml`. There you can configure the connection string for sshing to the host. By default the `test` environment is set up to connect to the vagrant host configured in the Vagrantfile.
+
+`dcd new [project_name]`: Scaffold a new project.
+
+`dcd provision`: Install Docker & DockerCompose on the host machine.
+
+`dcd deploy`: Push your `docker-compose.yml` to the host machine, create directories for volume-mapping (explained below), pull the required docker images, and run `docker-compose up`.
+
+`dcd backup`: Tar, bzip, and download the `./sites/data` for safekeeping.
+
+`dcd push [image_names]`: __If all of your images are on hub.docker.com, then you don't need this command.__ Normally you might push your docker images to http://hub.docker.com. However, you might have some images that you'd prefer to keep private. This command will take a local image, tar it, push it to the remote host. Using `dcd push` you do not need to push your private image to docker hub. This is significantly slower than using the registry because you need to push the entire image each time. Note that if you use this command, you will need to set `ignore_pull_failures: true` in your `config.yml`.
+
+
 ### The big picture
 
 For my homepage, I serve up multiple applications from the same machine. For this reason, I have nginx to inspect incoming requests and route them to the correct application. As I add new applications, I need to change this setup. So I need to push a new nginx config file as part of my deployment process.
@@ -87,12 +102,14 @@ Each site that is deployed with `dcd` will be provided three directories to moun
 
 - `./sites/[app_name]/config`: This directory is pushed from your localhost to the remote. Each time you run `dcd deploy` the config directory for each application will be __removed and replaced__ by the directory found on your localhost (if any).  Notice that there is a file on your localhost at `./sites/proxy/config/nginx.conf`. This file will be copied to your host at deployment time.
 
-- `./sites/[app_name]/data`: This directory is the permanent storage for your application. When running `dcd backup`, each application's `data` directory will be zipped up and downloaded for safekeeping.
+- `./sites/[app_name]/data`: This directory is the permanent storage for your application. This directory will be created by `dcd` but it will not be changed or removed by `dcd. When running `dcd backup`, each application's `data` directory will be zipped up and downloaded for safekeeping.
 
 - `./sites/[app_name]/log`: This directory is for storing logs. It is never removed, but it is also not included in backups. To see what's inside, you'll have to ssh to your server.
 
 Although none of the sites in the skeleton make use of their data directories, the volume maps are included to indicate what mounts are available. Understanding how nginx is configured is beyond the scope of this project, but the configuration found at `./sites/proxy/config/nginx.conf` should be a good template to follow.
 
+Once you've deployed the initial skeleton to the vagrant host, ssh to it (`vagrant ssh`) and look around the `~/sites` folder to see all the folders its created.
+
 ---
 
 __config.yml__
@@ -146,6 +163,9 @@ vagrant ssh-config >> ssh_config_overrides
 
 This will update the ssh connection info to work with your vagrant machine.
 
+### Deploying to DigitalOcean
+
+I use a cheap vps on http://wwww.digitalocean.com to host my site. Create a droplet and copy its ip address.  Update `config.yml` with `root@[ip-address]` as the `production` connection string. Then run `dcd provision && dcd deploy`. Now configure your dns and you should be done!
 
 ### Issues/Questions
 

data/lib/docker_compose_deploy/cli.rb

@@ -41,7 +41,7 @@ module DockerComposeDeploy
       Actions::Server.new(Util::Shell.new).provision
     end
 
-    desc "new", "create a new docker-compose server skeleton"
+    desc "new PROJECT_NAME", "create a new docker-compose server skeleton"
     def new(name)
       Actions::Skeleton.new(name, Util::Shell.new).create
     end

data/lib/docker_compose_deploy/version.rb

@@ -1,3 +1,3 @@
 module DockerComposeDeploy
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker_compose_deploy
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Pete Kinnecom