ruby_yacht 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f40e50df8f66f681ab0584dbb9b748898a18ce2f
-  data.tar.gz: 569e3512b1ac0e7a81306abb084841f324adbbb4
+  metadata.gz: e7b48a435714287ebf157e4cbacd1db8012a323a
+  data.tar.gz: 433d477edaaa3f78ec21235a8f0b16f56e1b8fe7
 SHA512:
-  metadata.gz: a26f6daca1154ae559ec50f1bd5b319bfae4f380c7ed1e5059e4aa0d02b9b71ededcc7cfc005c0e6190d94514fbd996f2fd5c60ec4bd07b0a0952028db73dac2
-  data.tar.gz: 6a283bcd4fa01ebb09a09498411c2714a609f2afea28e3de78d864f702a0c49a504f679b63af29a415bc6d7e2e0670e1f8717db048ce3b9e299cbc5e7457fcc3
+  metadata.gz: 5ebdfbb69595cede3d1a91633317c10b7e507b8a9e2a86215be040a7c385a187a0fd1d56e7fcbef8f988695a94ef9ae52556b9c7b321e45406217b13b6dfa44b
+  data.tar.gz: 5b2121af08a0a47f85f969ef1d6e4de3f4ae37be3484be94d847d9d6f1f102ecb9b1bd348c134b46ebe5a6acb7aaaecd026df64569074dbf5aeb46dcbfc06728

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_yacht (0.6.1)
+    ruby_yacht (0.7.0.pre1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -146,11 +146,13 @@ it will build the following images:
 ### run_containers
 
 This command runs all of the containers for the images described above. Each
-container will have the same name as its image. Each container will be on a
-docker network called `apollo`, and will have network aliases corresponding to
-the container names. For instance, the `apollo-web` container will be able to
-access the `apollo-mars` container under the hostname `apollo-mars`. The apps
-will also be able to talk to each other using these network aliases.
+container will have the same name as its image. Each container for the `apollo`
+project will be on a docker network called `apollo`, and will have network
+aliases corresponding to the container names. For instance, the `apollo-web`
+container will be able to access the `apollo-mars` container under the hostname
+`apollo-mars`. The apps will also be able to talk to each other using these
+network aliases. Containers for different projects will be in different
+networks, and will not be able to communicate.
 
 It will not run a container for the `app-dependencies` images. Those images are
 intended to use as a baseline for the app and database images, to reduce their

data/doc/TODO.md

@@ -1,6 +1,2 @@
 See the [GitHub Issue Tracker](https://github.com/brownleej/ruby-yacht/issues)
-for open tickets.
-
-# General
-
-* Test on Windows
+for open tickets.

data/doc/configuration.md

@@ -47,6 +47,15 @@ You can provide the following fields.
     <td><code>repository 'github.com'</code></td>
     <td>None; this is required.</td>
   </tr>
+  <tr>
+    <td>repository_protocol</td>
+    <td>
+      <p>The protocol that we use to check out the repositories.</p>
+      <p>This can be `ssh`, `http`, or `https`.</p>
+    </td>
+    <td><code>repository_protocol 'https'</code></td>
+    <td>ssh</td>
+  </tr>
   <tr>
     <td>check_out_locally</td>
     <td>
@@ -362,6 +371,48 @@ You should only call the `dns_server` once for a given project.
   </tr>
 </table>
 
+# Local Configuration
+
+You may want to have some of your configuration stored in a local file, outside
+of source control, to handle host-specific settings. For instance, you may have
+different users using different remote databases, or you may want to set the
+Rails environment differently in production than in testing. You can do this
+through two steps. First, you can call `add_local_config` to load the
+configuration from the YAML file:
+
+        RubyYacht.configure do
+          add_local_config File.join(File.dirname(__FILE__), 'config.yml')
+        end
+
+This has to be done in a separate configuration block, because the loaded config
+will not be available until the configuration block is over.
+
+Inside your main configuration block, you can then call `copy_local_config` to
+set the fields in the DSL based on the local config:
+
+        project :apollo do
+          system_prefix :apollo
+
+          copy_local_config :rails_environment, :rails_secret_key_base
+        end
+
+You may also want to have some of your configuration fields grouped together to
+keep the config file neater. For instance, you can have a database section of
+the config YML file that is structured like this:
+
+        :database:
+          :apollo:
+            :host: db1.apollo.com
+            :username: apollo
+            :password: ;kljfadsl
+            :name: apollo_production
+
+And then inside your project config, you could call:
+
+        database :apollo do
+          copy_local_config :host, :username, :password, :name, from: 'database.apollo'
+        end
+
 # Default Plugins
 
 By default, RubyYacht comes with three plugins, defined under the

data/doc/plugins.md

@@ -177,6 +177,10 @@ These are the event types that you can hook into:
     <td>add_app_config</td>
     <td>We are adding the configuration for a single app to a web server.</td>
   </tr>
+  <tr>
+    <td>cleanup</td>
+    <td>This is run at the end of the build process for each image.</td>
+  </tr>
 </table>
 
 ### Fields

data/lib/ruby_yacht/dsl/configuration.rb

@@ -1,3 +1,4 @@
+require 'yaml'
 require_relative 'project'
 require_relative 'hook'
 require_relative 'server_type'
@@ -18,6 +19,7 @@ module RubyYacht
       @hooks = []
       @server_types = []
       @avoid_docker_machine = false
+      @local_config = {}
     end
     
     # The projects that are part of this system.
@@ -38,6 +40,9 @@ module RubyYacht
     # ignored.
     attr_accessor :disable_docker_machine
 
+    # The configuration that has been loaded from a local YAML file.
+    attr_accessor :local_config
+
     # This method pulls up the hooks that we have defined.
     #
     # ### Parameters
@@ -102,6 +107,7 @@ module RubyYacht
       def initialize
         self.load_custom_attributes
         @hook_options = {}
+        @local_config = {}
       end
       
       ##
@@ -137,6 +143,9 @@ module RubyYacht
       # The default options for the hooks we're defining in the current block.
       attr_accessor :hook_options
 
+      # The configuration that has been loaded from a local YAML file.
+      attr_accessor :local_config
+
       # This method sets default attributes for a group of hooks.
       #
       # Any hooks that you create in the associated block will have the included
@@ -154,6 +163,20 @@ module RubyYacht
         self.hook_options = old_options
       end
 
+      # This method loads config from a local YAML file.
+      #
+      # The contents of the file will be stored in the global configuration's
+      # `local_config` field. From there, it can be loaded into another DSL
+      # object by calling `copy_local_config`.
+      #
+      # ### Parameters
+      #
+      # * **path: String**    The full path to the config file.
+      def add_local_config(path)
+        new_config = YAML.load_file(path)
+        @local_config = @local_config.merge(new_config)
+      end
+
       # This method adds a before hook.
       #
       # ### Parameters
@@ -193,7 +216,7 @@ module RubyYacht
         add_hook :during, event_type, &block
       end
       
-      creates_object Configuration, %w(projects hooks server_types)
+      creates_object Configuration, %w(projects hooks server_types local_config)
 
       private
 
@@ -222,6 +245,8 @@ module RubyYacht
       self.configuration.send("#{field}=", self.configuration.send(field) + new_configuration.send(field))
     end
 
+    self.configuration.local_config = self.configuration.local_config.merge(new_configuration.local_config)
+
     new_configuration.server_types.each do |type|
       if self.configuration.server_types.any? { |existing| existing.name == type.name }
         raise "Server type already registered: #{type.name}"

data/lib/ruby_yacht/dsl/dsl.rb

@@ -95,7 +95,7 @@ module RubyYacht
         # * **name: Symbol**    The name of the method. The name of the
         #                       attribute will be this name, followed by an s.
         def add_list(name)
-          add_generic_attribute name, "#{name}s", [], false do |value|
+          add_generic_attribute name, "#{name}s".to_sym, [], false do |value|
             variable_name = "@#{name}s"
             list = instance_variable_get(variable_name)
             list << value
@@ -160,7 +160,7 @@ module RubyYacht
         # * **type: Class**     The class type that provides the DSL when they
         #                       call this method.
         def add_object_list(name, type)
-          add_generic_attribute name, "#{name}s", [], false do |*args, &config_block|
+          add_generic_attribute name, "#{name}s".to_sym, [], false do |*args, &config_block|
             variable_name = "@#{name}s"
             list = instance_variable_get(variable_name)
             object_config = type.new(*args)
@@ -218,7 +218,7 @@ module RubyYacht
             if server_type.respond_to?(self.class.custom_attribute_method)
               attributes = server_type.send(self.class.custom_attribute_method)
               attributes.each do |attribute|
-                attribute = attribute.merge(name: "#{server_type.name}_#{attribute[:name]}")
+                attribute = attribute.merge(name: "#{server_type.name}_#{attribute[:name]}".to_sym)
                 load_custom_attribute(attribute)
               end
             end
@@ -290,6 +290,38 @@ module RubyYacht
         end
         self
       end
+
+      # This method copies fields from the local config to this DSL.
+      #
+      # The local config must have been loaded in a previous configuration block
+      # using the `add_local_config` method.
+      #
+      # The keys in the local config file should all be symbols, as should the
+      # `fields`. If they are not, this method may not be able to find the
+      # config entries.
+      #
+      # Any fields that are not present in the local config will be set to nil.
+      #
+      # ### Parameters
+      #
+      # * **fields: [Symbol]**    The fields to load.
+      # * **from: String**        A dot-separated key path to the location in
+      #                           the config file that contains the dictionary
+      #                           that we are pulling the fields from.
+      def copy_local_config(*fields, from:nil)
+        dictionary = RubyYacht.configuration.local_config
+        if from
+          from.split('.').each do |key|
+            dictionary = dictionary[key.to_sym]
+          end
+        end
+        fields.each do |field|
+          unless self.singleton_class.all_attributes.include?(field)
+            raise "Undefined field in #{self.class.name}: #{field}"
+          end
+          instance_variable_set("@#{field}", dictionary[field])
+        end
+      end
       
       # This method checks that all of the required attributes have been set on
       # the object.

data/lib/ruby_yacht/dsl/hook.rb

@@ -248,11 +248,15 @@ module RubyYacht
 
       # The command that should be run in a Dockerfile for this behavior.
       def dockerfile_command
+        value = self.value
+        return nil unless value
         "ENV #{@name} #{value}"
       end
 
       # The command that should be run in a shell script for this behavior.
       def shell_command
+        value = self.value
+        return nil unless value
         "export #{@name}=\"#{value}\""
       end
     end

data/lib/ruby_yacht/dsl/project.rb

@@ -21,6 +21,11 @@ module RubyYacht
     # The hostname for the repository that contains the code for the apps.
     attr_accessor :repository
     
+    # The protocol that we use to check out the repository.
+    #
+    # This can be `ssh`, `http`, or `https`.
+    attr_accessor :repository_protocol
+    
     # Whether we should check out the code on the host machine, rather than
     # keeping it entirely inside the container.
     attr_accessor :check_out_locally
@@ -80,6 +85,12 @@ module RubyYacht
       # You can call `repository 'github.com'` to set the project's `repository`
       # to `github.com`
       add_attribute :repository
+      
+      ##
+      # :method: repository_protocol
+      # You can call `repository_protocol :https` to tell the scripts to check
+      # out the repositories over HTTPS rather than SSH.
+      add_attribute :repository_protocol, :ssh
 
       #
       # :method: primary_app

data/lib/ruby_yacht/images/app/Dockerfile.erb

@@ -10,7 +10,6 @@ ENV DATABASE_TYPE <%= database.server_type %>
 ENV DATABASE_PORT <%= database.port %>
 <% end %>
 ENV APP_PORT <%= @app.port %>
-ENV REPOSITORY_HOST <%= @project.repository %>
 ENV SYSTEM_PREFIX <%= @project.system_prefix %>
 <% if @app.repository_name %>
 ENV REPOSITORY_NAME <%= @app.repository_name %>
@@ -37,6 +36,8 @@ WORKDIR /var/code
 <%= include_event(@app, :build_new_app) %>
 <% end %>
 
+<%= include_event @app, :cleanup %>
+
 EXPOSE <%= @app.port %>
 
 CMD /var/docker/startup.bash

data/lib/ruby_yacht/images/app/checkout.bash

@@ -2,5 +2,5 @@
 
 if [ ! -d /var/code/.git ]
 then
-  git clone git@$REPOSITORY_HOST:$REPOSITORY_NAME /var/code
+  git clone $REPOSITORY_HOST/$REPOSITORY_NAME /var/code
 fi

data/lib/ruby_yacht/images/app-dependencies/Dockerfile.erb

@@ -6,6 +6,12 @@
 
 FROM <%= @server_type.baseline_image %>
 
+<% repository_host = @project.repository %>
+<% if @project.repository_protocol == :ssh %>
+<% repository_host = 'git@' + repository_host %>
+<% end %>
+
+ENV REPOSITORY_HOST <%= @project.repository_protocol %>://<%= repository_host %>
 <%= include_event @project.apps, :initialize_app_environment %>
 
 RUN mkdir -p /root/.ssh
@@ -21,7 +27,7 @@ RUN apt-get update && apt-get upgrade -y
 <% next unless app.server_type == @server_type.name %>
 <% next unless app.repository_name %>
 
-RUN git clone git@<%= @project.repository %>:<%= app.repository_name %> /var/code/<%= app.name %>
+RUN git clone $REPOSITORY_HOST/<%= app.repository_name %> /var/code/<%= app.name %>
 WORKDIR /var/code/<%= app.name %>
 <%= include_event app, :install_libraries %>
 <% end %>

data/lib/ruby_yacht/images/database/Dockerfile.erb

@@ -18,7 +18,7 @@ RUN chmod u+x /var/docker/*
 <% @database.apps.each do |app| %>
 
 <% next unless app.repository_name %>
-RUN /var/docker/checkout.bash <%= @project.repository %> <%= app.name %> <%= app.repository_name %>
+RUN /var/docker/checkout.bash <%= app.name %> <%= app.repository_name %>
 WORKDIR /var/code/<%= app.name %>
 <%= include_event @database, :load_database_seeds %>
 <% end %>
@@ -26,6 +26,8 @@ WORKDIR /var/code/<%= app.name %>
 RUN rm -r /var/code
 WORKDIR /
 
+<%= include_event @database, :cleanup %>
+
 ENV DATABASE_USERNAME ''
 ENV DATABASE_PASSWORD ''
 ENV DATABASE_NAME ''

data/lib/ruby_yacht/images/database/checkout.bash

@@ -1,10 +1,9 @@
 #! /bin/bash
 
-REPOSITORY_HOST=$1
-APP_NAME=$2
-REPOSITORY_NAME=$3
+APP_NAME=$1
+REPOSITORY_NAME=$2
 
 if [ ! -d /var/code/$APP_NAME/.git ]
 then
-  git clone git@$REPOSITORY_HOST:$REPOSITORY_NAME /var/code/$APP_NAME
+  git clone $REPOSITORY_HOST/$REPOSITORY_NAME /var/code/$APP_NAME
 fi

data/lib/ruby_yacht/images/web/Dockerfile.erb

@@ -28,6 +28,8 @@ ENV APP_PRIMARY <%= app.name == primary_app %>
 <%= include_event @server, :add_app_config %>
 <% end %>
 
+<%= include_event @server, :cleanup %>
+
 RUN rm -r /var/docker
 
 ENV PROJECT ""

data/lib/ruby_yacht/plugins/nginx.rb

@@ -19,6 +19,11 @@ module RubyYacht::Plugins
 
           during(:add_project_landing) { run_script :ruby, 'add_project.rb' }
           during(:add_app_config) { run_script :ruby, 'add_app.rb' }
+
+          during(:cleanup) do
+            command 'apt-get remove -y ruby'
+            command 'apt-get autoremove -y'
+          end
         end
       end
     end

data/lib/ruby_yacht/plugins/rails/scripts/load_seeds.rb

@@ -12,7 +12,7 @@ config_path = "./config/database.yml"
 username = ENV['DATABASE_USERNAME']
 password = ENV['DATABASE_PASSWORD']
 database = ENV['DATABASE_NAME']
-rails_env = ENV['RAILS_ENV']
+rails_env = ENV['RAILS_ENV'] || 'development'
 
 database_config = {
   rails_env => {
@@ -30,6 +30,15 @@ File.open(config_path, "w") do |file|
   file.write(database_config.to_yaml)
 end
 
+File.open('./config/secrets.yml', 'w') do |file|
+  secret_key_config = {
+    rails_env => {
+      'secret_key_base' => ENV['SECRET_KEY_BASE']
+    }
+  }
+  file.write(secret_key_config.to_yaml)
+end
+
 system "bundle install"
 tables = `mysql -uroot -e "SHOW TABLES" #{database}`
 if tables == ''

data/lib/ruby_yacht/plugins/rails/scripts/prepare_rails_for_launch.rb

@@ -7,6 +7,6 @@ system "rake db:migrate"
 system "rails r Rails.cache.clear"
 system "rm -f tmp/pids/*"
 
-if ENV['RAILS_ENV'] != 'development'
+if ENV['RAILS_ENV']
   system "rake assets:precompile"
 end