shiplane 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f140db779603d5107c232dd5dca0665c251b39df409c3590498c4485b6df9f1d
-  data.tar.gz: aac47c05deecae0cfbbfbbb1888c664d305ec62434165ee89a3fb68bc6a85881
+  metadata.gz: 4616a459918f6de9f341e68bc54203712792219c21740fbe8a4e728128cc100d
+  data.tar.gz: 0cd1d68cf6394cd15b607e962c01f4ab3e6ebc41939b7dae4c40a47e9684ec2b
 SHA512:
-  metadata.gz: 37359831f595b65b12f55756668023e46574626267fb16a71b459404772424f67605a4e614c570a304746d703b9f94b628d64fde64015ff6e3353a3f5469067d
-  data.tar.gz: eae6e737e636a325cad67d06da705cab114dbb7e4468fb7b107e3f03186c91c80748bdcf6831eac39b54b8c04e8033b0602376e698f1b255621ca5a919e3f41a
+  metadata.gz: ae4cb9821f5f21cc87cd38d353fadfb7f27088945ad10b7732839797594be6599b24d118d237a099eb54ae8ec0178f012d1e353982525ddc1507fc2d227c4ced
+  data.tar.gz: 42be525ad6242e270e9240c6f2c1399a98167810e2cc14fde69f1a8c0449afc17dbc609568317f157ce2b462f1da9054e3eb148db4026991119bce486c960b7c

data/README.md

@@ -45,9 +45,9 @@ ruby '2.6.2'
 
 3. Add the following lines to your Gemfile:
 ```
-gem 'shiplane' require: false
-gem 'shiplane_bootstrappers_chef', require: false
-gem 'shiplane_deployers_capistrano_docker', require: false
+gem 'shiplane'
+gem 'shiplane_bootstrappers_chef'
+gem 'shiplane_deployers_capistrano_docker'
 ```
 
 4. Run bundler to install everything:
@@ -70,4 +70,52 @@ rake shiplane:install[<application_name>]
 ```
 
 ### Using Shiplane
-#### TODO
+#### Steps involved in provisioning and deploying
+Currently, Shiplane assumes you have an empty VM/VPS/Metal Box with some form of linux on it (though testing has primarily been done on Ubuntu boxes). Shiplane assumes an otherwise EMPTY install. It is HIGHLY recommended that you NOT use Shiplane (or any other provisioning) on an install with software other than a basic OS installed.
+
+Each of the following steps are handled in Shiplane:
+- Bootstrapping
+- Provisioning
+- Building
+- Deploying
+
+#### Bootstrapping
+This step is closely related to provisioning and is currently tied in with provisioning itself, but the concept remains a separate entity and may be separated from provisioning sometime in the future.
+
+During bootstrapping, Shiplane ssh's into the deployment target you have designated for provisioning and installs the bare minimum necessary software to allow provisioning.
+
+Currently the following Bootstrappers are provided:
+- shiplane_bootstrappers_chef `# Installs Chef and uploads cookbooks for the provisioner`
+
+#### Provisioning
+During Provisioning Shiplane installs all the software necessary to run the selected deployment framework on the deployment target.
+
+Currently, the following Provisioners are provided:
+- shiplane_bootstrappers_chef `# Uses Chef Solo to install deployment frameworks`
+
+You can bootstrap AND provision at once by running the following:
+```sh
+bundle exec cap production shiplane:bootstrap
+```
+
+#### Building
+Shiplane provides rake tasks that may be used to build your Docker containers into Production-ready containers and upload the images to a registry for download on your target deployment machine. Currently, Shiplane supports Dockerhub out of the box.
+
+It is intended that this be integrated into your CI pipeline and some examples are provided (Currently, we provide an example for Circle CI).
+
+You can build a docker container based on the HEAD of your current branch like so:
+```sh
+bundle exec cap production shiplane
+```
+
+#### Deploying
+Shiplane provides tasks to help you deploy your code. These tasks depend on your deployment framework, but each task appropriately launches your docker containers on your selected framework.
+
+Currently, the following Deployers are provided:
+- shiplane_deployers_capistrano_docker `# Uses Capistrano and Raw Docker to run your containers`
+
+
+You can run a deployment like so:
+```sh
+bundle exec cap production deploy
+```

data/lib/shiplane/railtie.rb

@@ -1,5 +1,7 @@
-class Shiplane::Railtie < Rails::Railtie
-  rake_tasks do
-    load 'shiplane/tasks/install.rake'
+module Shiplane
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'shiplane/tasks/install.rake'
+    end
   end
 end

data/lib/shiplane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shiplane
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiplane
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - John Epperson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shiplane_bootstrappers_chef
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: shiplane_deployers_capistrano_docker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement