subspace 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a866534c27d65465d53cc06c495c719197ad402
-  data.tar.gz: f88c9c97b3a26e0876ad83fa99973e586eea8441
+  metadata.gz: 57b55c6f99d2144073f2601463e9945b60842550
+  data.tar.gz: 93c40a9e919c5c8a49745310ad042de16f54bf1f
 SHA512:
-  metadata.gz: 20c7da85e53b22d8e92e02c685b0e03d60ec59cab75370198303083c67d28257e5d51c2a4de47e89961b5d1ac9ba692e0ecf39ad792484de8d30c538f68fa02d
-  data.tar.gz: 6252943b439a6c5f43e9296b1e4035972707f20f54c53ee35818fbf07b9b28053d0495e86cc8b2907e5761b09c86ca16d3f59f0dff86658a9e616b866385b6c6
+  metadata.gz: b67b94db7a8c7d5e70352f927bd944099f0abfe2a71bd51b6670af6b693976253d902f5054a56feea5ff8e200b17234ef5300f5a3500584c5d5add70d1a9a72c
+  data.tar.gz: 5a98c46e5f8547dd596fb55260ea9ab17156847854375585f7c0fd1834a16643213199d2b529a33ee1f7682c30c6732a3b16bbebfdd86e4e1ad835db18086e90

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.retry

data/README.md

@@ -21,18 +21,10 @@ Add this line to your application's Gemfile:
 gem 'subspace'
 ```
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
     $ gem install subspace
 
-Then run
-
-    subspace init
-
 ## Usage
 
 * `subspace init`
@@ -97,11 +89,15 @@ This role should almost always be there.  It ties a bunch of stuff together, run
 
 Note: we grant the deploy user limited sudo access to run `service xyz restart` and also add it to the `adm` group so it can view logs in `/var/log`.
 
+# Roles
+
+This is a description of all the roles that are included by installing subspace, along with their configuration.
+
 ## apache
 
 ## collectd
 
-
+## common
 
 ## delayed_job
 

data/ansible/playbooks/local_template.yml

@@ -0,0 +1,13 @@
+---
+  - hosts: localhost
+
+    tasks:
+      - name: Load environment vars
+        include_vars:
+          file: "{{vars_file}}"
+      - name: create some file
+        template:
+          src: "{{project_path}}/{{src}}"
+          dest: "{{project_path}}/{{dest}}"
+        delegate_to: localhost
+

data/ansible/roles/common/templates/motd

@@ -5,8 +5,10 @@ This server brought to you by:
  ___) | |_| | |_) |__) | |_) | (_| | (_|  __/
 |____/ \__,_|_.__/____/| .__/ \__,_|\___\___|
                        |_|
-
 ~~~ https://github.com/tenforwardconsulting/subspace ~~~
 
 If you need to make configuration changes to the server, please modify the
 config/provision directory in the app or risk the changes dissapearing.
+
+Last subspace run: {{ansible_date_time.iso8601}}
+

data/ansible/roles/letsencrypt/tasks/main.yml

@@ -25,7 +25,7 @@
     file:
       path: "{{certbot_dir}}"
       state: directory
-      mode: 0750
+      mode: 0755
 
   - name: Get certbot
     become: true
@@ -37,8 +37,6 @@
   - name: Run default
     become: true
     command: "{{certbot_dir}}/certbot-auto certonly --email {{letsencrypt_email}} --domains {{([server_name] + server_aliases) | join(',')}} --apache --agree-tos --expand --non-interactive"
-    args:
-      creates: /etc/letsencrypt/live/{{server_name}}/cert.pem
 
   - name: Enable mod_rewrite
     become: true

data/ansible/roles/rails/tasks/main.yml

@@ -28,9 +28,23 @@
     become: true
     become_user: "{{deploy_user}}"
 
-  - name: Create application.yml
+  - name: Create application.yml (legacy)
+    when: appyml is defined
     template:
       src: application.yml
       dest: /u/apps/{{project_name}}/shared/config/application.yml
     become: true
     become_user: "{{deploy_user}}"
+
+  - debug:
+      msg: "Warning: Using legacy appyml for variable configuration.  Consider switching to application.yml.template"
+      verbosity: 0
+    when: appyml is defined
+
+  - name: Create application.yml
+    when: appyml is not defined
+    template:
+      src: application.yml.template
+      dest: /u/apps/{{project_name}}/shared/config/application.yml
+      owner: "{{deploy_user}}"
+

data/lib/subspace/cli.rb

@@ -23,10 +23,11 @@ class Subspace::Cli
     program :description, 'Ansible-backed server provisioning tool for rails'
 
     command :init do |c|
-      c.syntax = 'subspace init [options]'
-      c.summary = ''
-      c.description = ''
-      c.example 'description', 'command example'
+      c.syntax = 'subspace init [vars]'
+      c.summary = 'Run without options to initialize subspace.'
+      c.description = 'Some initialization routines can be run indiviaully, useful for upgrading'
+      c.example 'init a new project', 'subspace init'
+      c.example 'create the new style application.yml vars template', 'subspace init vars'
       c.when_called Subspace::Commands::Init
     end
 
@@ -73,8 +74,11 @@ class Subspace::Cli
     command :vars do |c, args|
       c.syntax = 'subspace vars [environment]'
       c.summary = 'View or edit the encrypted variables for an environment'
-      c.description = ''
+      c.description = """By default, this will simply show the variables for a specific environemnt.
+                         You can also edit variables, and we expect the functionality here to grow in the future.
+                         Running `subspace vars development --create` is usually a great way to bootstrap a new development environment."""
       c.option '--edit', "Edit the variables instead of view"
+      c.option '--create', "Create config/application.yml with the variables from the specified environment"
       c.when_called Subspace::Commands::Vars
     end
 

data/lib/subspace/commands/ansible.rb

@@ -13,7 +13,7 @@ module Subspace
       private
 
       def update_ansible_cfg
-        template "ansible.cfg"
+        template! "ansible.cfg"
       end
     end
   end

data/lib/subspace/commands/base.rb

@@ -8,6 +8,10 @@ module Subspace
         load "config/provision.rb"
       end
 
+      def playbook_dir
+        File.join(gem_path, 'ansible', 'playbooks')
+      end
+
       def template_dir
         File.join(gem_path, 'template', 'provision')
       end
@@ -16,11 +20,21 @@ module Subspace
         File.expand_path '../../../..', __FILE__
       end
 
+      def project_path
+        Dir.pwd # TODO make sure this is correct if they for whatever reason aren't running subspace from the project root??
+      end
+
       def dest_dir
         "config/provision"
       end
 
       def template(src, dest = nil, render_binding = nil)
+        return unless confirm_overwrite File.join(dest_dir, dest || src)
+        template! src, dest, render_binding
+        say "Wrote #{dest}"
+      end
+
+      def template!(src, dest = nil, render_binding = nil)
         dest ||= src
         template = ERB.new File.read(File.join(template_dir, "#{src}.erb")), nil, '-'
         File.write File.join(dest_dir, dest), template.result(render_binding || binding)
@@ -28,7 +42,15 @@ module Subspace
 
       def copy(src, dest = nil)
         dest ||= src
+        return unless confirm_overwrite File.join(dest_dir, dest)
         FileUtils.cp File.join(template_dir, src), File.join(dest_dir, dest)
+        say "Wrote #{dest}"
+      end
+
+      def confirm_overwrite(file_path)
+        return true unless File.exists? file_path
+        answer = ask "#{file_path} already exists. Reply 'y' to overwrite: [no] "
+        return answer.downcase.start_with? "y"
       end
 
     end

data/lib/subspace/commands/init.rb

@@ -3,10 +3,19 @@ require 'erb'
 require 'securerandom'
 class Subspace::Commands::Init < Subspace::Commands::Base
   def initialize(args, options)
-    run
+    if args.first == "vars"
+      init_vars
+    else
+      run
+    end
   end
 
   def run
+    if File.exists? dest_dir
+      answer = ask "Subspace appears to be initialized.  Reply 'yes' to continue anyway: [no] "
+      abort unless answer.chomp == "yes"
+    end
+
     FileUtils.mkdir_p File.join dest_dir, "group_vars"
     FileUtils.mkdir_p File.join dest_dir, "host_vars"
     FileUtils.mkdir_p File.join dest_dir, "vars"
@@ -27,6 +36,7 @@ class Subspace::Commands::Init < Subspace::Commands::Base
       create_vars_file_for_env env
       template "playbook.yml", "#{env}.yml"
     end
+    create_vars_file_for_env "development"
 
     puts """
     1. Create a server.
@@ -48,6 +58,11 @@ class Subspace::Commands::Init < Subspace::Commands::Base
 
   end
 
+  def init_vars
+    FileUtils.mkdir_p File.join dest_dir, "templates"
+    copy "templates/application.yml.template"
+  end
+
   private
 
   def project_name

data/lib/subspace/commands/vars.rb

@@ -1,11 +1,48 @@
 class Subspace::Commands::Vars < Subspace::Commands::Base
   def initialize(args, options)
     @environment = args.first
-    @action = options.edit ? "edit" : "view"
+    @action = if options.edit
+      "edit"
+    elsif options.create
+      "create"
+    else
+      "view"
+    end
+
     run
   end
 
   def run
-    ansible_command "ansible-vault", @action, "vars/#{@environment}.yml"
+    case @action
+    when "create"
+      create_local
+    when "view", "edit"
+      ansible_command "ansible-vault", @action, "vars/#{@environment}.yml"
+    else
+      abort "Invalid vars command"
+    end
+  end
+
+  def create_local
+    if File.exists? File.join(project_path, "config/application.yml")
+      answer = ask "config/application.yml already exists. Reply 'yes' to overwrite: [no] "
+      abort unless answer == "yes"
+    end
+    src = application_yml_template
+    dest = "config/application.yml"
+    vars_file = File.join(project_path, "config/provision/vars/#{@environment}.yml")
+    extra_vars = "project_path=#{project_path} vars_file=#{vars_file} src=#{src} dest=#{dest}"
+    ansible_command "ansible-playbook", File.join(playbook_dir, "local_template.yml"), "--extra-vars", extra_vars
+    say "File created at config/application.yml with #{@environment} secrets"
+    say "-------------------------------------------------------------------\n"
+
+    system "cat", "config/application.yml"
   end
+
+  private
+
+  def application_yml_template
+    "config/provision/templates/application.yml.template"
+  end
+
 end

data/lib/subspace/version.rb

@@ -1,3 +1,3 @@
 module Subspace
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/subspace.gemspec

@@ -31,5 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_runtime_dependency "commander", "~>4.0"
+  spec.add_runtime_dependency "commander", "~>4.2"
+  spec.add_runtime_dependency "figaro", "~>1.0"
 end

data/template/provision/templates/application.yml.template

@@ -0,0 +1,27 @@
+# This file defines the environment variables available to the application at runtime
+# We use the figaro gem to load environment variables from application.yml.
+
+# These environment variables are available to all environments, and can be secret or not:
+
+# These are secret and can be changed per environment easily by using subspace vars <env> --edit
+SECRET_KEY_BASE: {{secret_key_base}}
+AWS_SECRET_KEY: {{aws_secret_key}}
+
+# These are not secret, and have the same value for all environments
+ENABLE_SOME_FEATURE: false
+MAX_USER_INVITES: 20
+DEFAULT_EMAIL_ADDRESS: test@example.com
+
+
+# These variable are not secret, but have different, static values for all environments
+development:
+  INSECURE_VARIABLE: "this isn't secret"
+  AWS_BUCKET: my-app-development
+
+dev:
+  INSECURE_VARIABLE: "but it changes"
+  AWS_BUCKET: my-app-dev
+
+production:
+  INSECURE_VARIABLE: "on different servers"
+  AWS_BUCKET: my-app-production

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subspace
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Brian Samson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: figaro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: WIP -- don't use this :)
 email:
 - brian@tenforwardconsulting.com
@@ -85,6 +99,7 @@ files:
 - README.md
 - Rakefile
 - TODO
+- ansible/playbooks/local_template.yml
 - ansible/roles/apache/defaults/main.yml
 - ansible/roles/apache/handlers/main.yml
 - ansible/roles/apache/tasks/main.yml
@@ -223,6 +238,7 @@ files:
 - template/provision/host_vars/template.erb
 - template/provision/hosts.erb
 - template/provision/playbook.yml.erb
+- template/provision/templates/application.yml.template
 - template/provision/vars/template.erb
 homepage: https://github.com/tenforwardconsulting/subspace
 licenses: