salted_rails_server 0.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 993832613e203582e81d1e5390f3d090fdee21ee
-  data.tar.gz: dec9214f44b92a28d8e929bdc1ed6f7d1bf17d04
+  metadata.gz: c2bab325d477149bedd2bed2b71a290b4a5b6753
+  data.tar.gz: 3690989f0e972979fca60717bdfee1dd8875ae28
 SHA512:
-  metadata.gz: 84c1898a62afa2f144ea8e0931c1a9990b1fb916b8e7a89ffee8cca4376aef92ed9ea7682bee1476a08b82994587c201f52dc55e629e2c9e8ba9d75fdb260562
-  data.tar.gz: fb7a5e24ded3d9aaab036fc8082ce64356afd81b7fdc8c994729b99502597f0b085f3bf3228d3cb9d5a1b28a4466896278d9098bebbe949058e469d63db5b9f2
+  metadata.gz: 942cf95085373bf1e7d09e1ab5b4683d832da5a151b3e935d0f90216d8f004c68d0aad85d3cf7cfeaf1492ab9cc6f8ad55bd84d8718d6b03885c5e6ddc1437a2
+  data.tar.gz: b19855780ddb0b86f6303da0b9831c00a3448c84462b94cb0fc81c1872b4bc26e1492f493aafabb545b0c58a9a21ed7334d4a5ca06d2576d274b08c4ab41ac38

data/.gitignore

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

data/README.md

@@ -1,26 +1,36 @@
-# salted_rails_server
+# Salted _ Rails _ Server
 
-A ruby on rails generator used to provision a new server with the following:
+## Description
 
-* User for running rails
-* RVM
-* NGINX
-* Rails
-* Elasticsearch
-* NodeJS
-* MySQL
+A ruby on rails generator for provisioning a new server using salt-ssh
+
+Supports the following:
+
+* [Backup](https://github.com/backup/backup)
+* [ElasticSearch](https://info.elastic.co/branded-ggl-elastic-exact-v3.html?camp=Branded-GGL-Exact&src=adwords&mdm=cpc&trm=elasticsearch&gclid=EAIaIQobChMIhuuXsc6E2AIVEoGzCh1JFgyzEAAYAiAAEgKRZ_D_BwE)
+* [ImageMagick](https://www.imagemagick.org/script/index.php)
+* [LogRotate](http://www.thegeekstuff.com/2010/07/logrotate-examples/)
+* [Monit](https://mmonit.com/monit)
+* [MySQL](https://www.mysql.com/)
+* [NGINX](https://www.nginx.com/)
+* [Node](https://nodejs.org/)
+* [Redis](https://redis.io/)
+* [RubyOnRails](http://rubyonrails.org/)
+* [RVM](https://rvm.io/)
+* User - User setup
+
+All installations are the latest packages for the managed system unless there is a version section in the pillars/default.sls.
 
 ## Tested on
 
-* Ubuntu 14.04
-* Ubuntu 15.10
+* Ubuntu Trust
+* Ubuntu Xenial
 
-No reason this should not work on any other saltstack supported OS. If you have tried this on any other OS and it did not work, let me know.
+No reason this should not work on any other salt stack supported OS. If you have tried this on any other OS and it did not work, please let me know.
 
 ## salt-ssh installation
 
-This code requires that you have Saltstack's salt-ssh already installed the system you are deploying from and a compatible version of python on the system you are deploying to.
-
+This code requires that you have Saltstack's salt-ssh already installed on the system you are deploying from and a compatible version of python on the system you are deploying to. If you are a mac user attempting to use this and you have issues, try using [salt-ssh-vm](https://github.com/vmcilwain/salt-ssh-vm)
 
 Consult the following documentation for your OS:
 https://docs.saltstack.com/en/latest/topics/installation/index.html
@@ -43,81 +53,209 @@ And then generate code:
 rails g salted_rails_server
 ```
 
-The following files will be generated:
+The following files will be generated in the root directory:
 
-* master
-* roster
-* Saltfile
-* salted_rails_server/pillars*
-* salted_rails_server/states/*
+```
+./master
+./roster # DO NOT CHECK IN THIS FILE!!!
+./Saltfile
+./salt_ssh
+├── pillars
+│   ├── default.sls
+│   └── top.sls
+└── states
+    ├── backup
+    │   └── files
+    │       └── home
+    │           └── deploy
+    │               ├── bin
+    │               │   └── backup.rb
+    │               └── config
+    │                   └── schedule.rb
+    ├── backup.sls
+    ├── elasticsearch.sls
+    ├── imagemagick.sls
+    ├── logrotate
+    │   └── files
+    │       └── etc
+    │           └── logrotate.d
+    │               └── rails
+    ├── logrotate.sls
+    ├── monit
+    │   ├── etc
+    │   │   └── monit
+    │   │       └── monitrc
+    │   └── redis.sls
+    ├── monit.sls
+    ├── mysql.sls
+    ├── nginx.sls
+    ├── node.sls
+    ├── redis.sls
+    ├── rails.sls
+    ├── rvm.sls
+    ├── setup.sls
+    └── user.sls
+```
 
 ## Configuration
 
-Add your custom options to the following files:
+Add custom options to the following files:
 
 * roster - remote host(s) information
-* pillars/default/init.sls - usernames, password, versions of items to be installed
+* pillars/default.sls - RAILS_ENV, Remote Username with ssh-key, MYSQL root and rails user user password and versions of ruby and elasticsearch to be installed.
+
+## Setting up Remote system
 
+Add your public ssh key to the authorized_keys on remote server that you plan to manage. I normally add this to root but it needs to be added to a user with sudo privileges.
 
-## Running the code
+## Testing salt-ssh connection
 
-Installing all states:
+From within the appliation root directory type:
 
 ```
-sudo salt-ssh -i '*' state.apply setup
+sudo salt-ssh -i '*' test.ping
+```
+
+The following should be returned:
+```
+managed:
+    True
 ```
 
-Installing an individual state:
+If that is not returned, salt-ssh should give you an accurate reason to why it was not able to connect. Another tool to use is the verbose option on the ssh command.
 
 ```
-sudo salt-ssh -i '*' state.apply state_file
+ssh -vv user@remote-host
 ```
 
-### States to chose from
+## The States (Remote Management)
+
+### Available States
 
+* backup
 * elasticsearch
+* imagemagick
+* logrotate
+* monit
 * mysql
 * nginx
 * node
+* redis
 * rails
 * rvm
-* user
+* setup
+* user - User setup
 
-## Details on what the code does
+### The Setup State
 
-### User state
+```
+sudo salt-ssh -i '*' state.apply setup
+```
 
-Creates a user that is defined in pillars/default/init.sls. If a user is not found it will default to user called deploy. This sate also addes the user to /etc/sudoers for executing code without the need for a password.
+This runs the minimum set of states in a specific order. Be sure to look at salt_ssh/states/setup.sls to comment or uncomment any additional items you do or don't want installed during the setup process.
 
-### RSA state
-Update pillars/default/init.sls to add your ssh key to log in as the user created in the user state
+This takes a while and there aren't any status updates as things progress. Be patient!
 
-### RVM state
+### Individual States
+
+```
+sudo salt-ssh -i '*' state.apply state_file
+```
+
+## State Details
+
+### Backup State
+
+Installs the [backup](https://github.com/backup/backup) and [whenever](https://github.com/javan/whenever) gems for backing up your rails application.
+
+The backup configuration is stored in `/home/username/bin`
+
+Whenever configuration is stored in `/home/username/config`
+
+Backups are stored in `/var/backups/rails`
+
+It has configurations for using AWS S3 and SES. Those configurations can be added to the roster file. You can see an example of this in the roster file.
 
-Installed under the user that is created from the user state
-Sets the default to the specified version in pillars/default/init.sls
+### ElasticSearch State (Debian/Ubuntu Only)
 
+Installs the specified version of elasticsearch found in salt_ssh/pillars/default.sls. The fallback is version 2.3.4. This also installs the openjdk_7_jre dependency.
+
+### ImageMagick State
+
+Installs the lates version of ImageMagick via the package manager for the OS.
+
+### LogRotate State
+
+Ensures logrotate is installed on the remote system (it most likely is) via the package manager for the OS. Adds a rails config in /etc/logrotate.d.
+
+### Monit State
+
+Ensures monit is installed via the package manager for the OS
+and running. Makes a backup of the original /etc/monit/monitrc then replaces it with config that monitors any monit configs stored within the rails application.
+
+The monit config file is setup to use AWS SES which you can add the credentials to the roster file.
+
+### MySQL state
+
+Ensures MySQL is installed via the package manager for the OS and running. Currently, you will need to create the user account due to the following open issues:
+
+[29265](https://github.com/saltstack/salt/issues/29265)
+
+[44200](https://github.com/saltstack/salt/issues/44200)
+
+Once resolved, the option to create MySQL users will be re-enabled.
+
+The code is commented out in salt_ssh/states/user.sls if you decide you want to try and use it before the issues are resolved.
+
+### NGINX State
+
+Installs NGINX via the package manager for the OS and ensures it is running.
+
+### Node State
+
+Ensures nodejs is installed via the package manager for the OS and creates a node symlink if it doesn't exist.
+
+### Redis State
+
+Ensures redis is installed via the package manager for the OS and is running.
 ### Rails state
 
-Installs the following gems in RVM
+Installs the following gems under RVM:
 
 * Bundler
 * Rails
 * Unicorn
 
-Finds or creates /var/www and sets the owner of that directory to the specified user in the user state
+creates /var/www if it doesn't exist and sets the owner of that directory to the specified user in the user state.
 
-### MySQL state
+### RVM state
 
-Creates a rails_user account with the appropriate permissions to run rails nothing more. Sets its password to what is specified in pillar/default/init.sls
-Sets the root password to what is specified in pillar/default/init.sls
+Installs RVM under the specified user in the user state. Sets the default to the specified version in salt_ssh/pillars/default.sls.
 
+### User state
+
+Creates a user that is defined in salt_ssh/pillars/default.sls. If a user is not found it will default to user named deploy. This state also adds the user to /etc/sudoers for executing code without the need for a password.
+
+#### RSA key
+
+Update salt_ssh/pillars/default/init.sls to add your ssh key to log in as the user created in the user state. This is required since the user created does not have a default password assigned. This is done for strong security!.
 
 ## Caution
 
 Take a look at the code before you use it to make sure that it works the way you expect or want. After the code is generated you can modify it to fit your needs before executing.
 
-# Contributing
+
+## Uninstalling
+
+To uninstall salted_rails_server simply delete the following files:
+
+* /master
+* /roster
+* /Saltfile
+* /salt.log
+* /salt_ssh #directory
+
+## Contributing
 
 I am looking for constructive criticisim on making this better and easier for everyone who could use it.
 

data/Vagrantfile

@@ -0,0 +1,71 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure(2) do |config|
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://atlas.hashicorp.com/search.
+  config.vm.box = "ubuntu/trusty64"
+
+  # Disable automatic box update checking. If you disable this, then
+  # boxes will only be checked for updates when the user runs
+  # `vagrant box outdated`. This is not recommended.
+  # config.vm.box_check_update = false
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # config.vm.network "forwarded_port", guest: 80, host: 8080
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+   config.vm.network "private_network", ip: "192.168.33.15"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  # config.vm.synced_folder "../data", "/vagrant_data"
+
+  # Provider-specific configuration so you can fine-tune various
+  # backing providers for Vagrant. These expose provider-specific options.
+  # Example for VirtualBox:
+  #
+  # config.vm.provider "virtualbox" do |vb|
+  #   # Display the VirtualBox GUI when booting the machine
+  #   vb.gui = true
+  #
+  #   # Customize the amount of memory on the VM:
+  #   vb.memory = "1024"
+  # end
+  #
+  # View the documentation for the provider you are using for more
+  # information on available options.
+
+  # Define a Vagrant Push strategy for pushing to Atlas. Other push strategies
+  # such as FTP and Heroku are also available. See the documentation at
+  # https://docs.vagrantup.com/v2/push/atlas.html for more information.
+  # config.push.define "atlas" do |push|
+  #   push.app = "YOUR_ATLAS_USERNAME/YOUR_APPLICATION_NAME"
+  # end
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  # config.vm.provision "shell", inline: <<-SHELL
+  #   sudo apt-get update
+  #   sudo apt-get install -y apache2
+  # SHELL
+end

data/lib/generators/salted_rails_server/salted_rails_server_generator.rb

@@ -1,56 +1,53 @@
 class SaltedRailsServerGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
-  desc 'create salted_rails_server directories'
+  desc 'create directories'
   def create_file_structure
-    run 'mkdir -p salted_rails_server/pillars'
-    run 'mkdir -p salted_rails_server/pillars/default'
-    run 'mkdir -p salted_rails_server/states'
+    run 'mkdir -p salt_ssh/pillars'
+    run 'mkdir -p salt_ssh/states/backup/files/home/deploy/bin'
+    run 'mkdir -p salt_ssh/states/backup/files/home/deploy/config'
+    run 'mkdir -p salt_ssh/states/logrotate/files/etc/logrotate.d'
+    run 'mkdir -p salt_ssh/states/monit/etc/monit'
   end
 
-  desc 'generatre salted_rails_server default pillar template'
+  desc 'generatre default pillar'
   def copy_pillar_files
-    copy_file 'pillars/default/init.sls', 'salted_rails_server/pillars/default/init.sls'
-    copy_file 'pillars/top.sls', 'salted_rails_server/pillars/top.sls'
+    copy_file 'pillars/default.sls', 'salt_ssh/pillars/default.sls'
+    copy_file 'pillars/top.sls', 'salt_ssh/pillars/top.sls'
   end
-  
-  desc 'generate salted_rails_server state files'
+
+  desc 'generate state files'
   def copy_state_files
-    copy_file 'states/elasticsearch.sls', 'salted_rails_server/states/elasticsearch.sls'
-    copy_file 'states/mysql.sls', 'salted_rails_server/states/mysql.sls'
-    copy_file 'states/nginx.sls', 'salted_rails_server/states/nginx.sls'
-    copy_file 'states/node.sls', 'salted_rails_server/states/node.sls'
-    copy_file 'states/rails.sls', 'salted_rails_server/states/rails.sls'
-    copy_file 'states/rvm.sls', 'salted_rails_server/states/rvm.sls'
-    copy_file 'states/setup.sls', 'salted_rails_server/states/setup.sls'
-    copy_file 'states/user.sls', 'salted_rails_server/states/user.sls'
+    Dir["#{__dir__}/templates/states/**/*"].each do |file|
+      copy_file file, "salt_ssh/#{file.gsub(__dir__+'/templates/', '')}" unless File.directory? file
+    end
   end
-  
-  desc 'generate salted_rails_server salt-ssh roster file'
+
+  desc 'generate roster file'
   def copy_roster
     copy_file 'roster', 'roster'
   end
-  
-  desc 'generate salted_rails_server salt-ssh master file'
+
+  desc 'generate master file'
   def generate_master
     create_file 'master', <<-CODE
 file_roots:
   base:
-    - #{Rails.root}/salted_rails_server/states
+    - #{Rails.root}/salt_ssh/states
 
 pillar_roots:
   base:
-  - #{Rails.root}/salted_rails_server/pillars
+  - #{Rails.root}/salt_ssh/pillars
     CODE
   end
-  
-  desc 'generate salted_rails_server salt-ssh Saltfile file'
+
+  desc 'generate Saltfile file'
   def generate_saltfile
     create_file "Saltfile", <<-CODE
 salt-ssh:
   config_dir: #{Rails.root}
   roster_file: #{Rails.root}/roster
-  log_file: #{Rails.root}/saltlog.txt
+  log_file: #{Rails.root}/salt.log
     CODE
   end
 end