smartmachine 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67c3eb74e67e5c8dac9368f7e4d166a4852d5f7066ec049918649586938e0965
-  data.tar.gz: 45d22a409f14db62858e0781da682c42df50260debc5b3536e7e7097dedcec47
+  metadata.gz: b3ee76cffa4f2e68ce10d0cf6e2ab0734520ab901fd4cd37dc53b6e15a1690a9
+  data.tar.gz: 9c48ce88369327fb8914ece890b48349bb27b389b1f71e384bb7611869ac3a9b
 SHA512:
-  metadata.gz: 42800c476312a609b3df9ed46b1615db12abe2c9ccdee693e7b11d09912ca7d9b333c141b0e22c3cdf111202d93042967f07fb21188dde4d03e22da8d9ecd262
-  data.tar.gz: 15c13da59c777ee62fbe2364d7a0f5bff6a12aca0d527bb18fd4618bef236ed899b89733b52d1157ea31f4216924d5c8a90bbff9849095c5bb3141a0127a1c37
+  metadata.gz: c629d1bcf0900c3278fb21e9c794cee97f6f8842a9eadc411d13c4c606ffaa2b9e2ba4f2cc303dc79622e9bbf252e4cecaad72a39033f15747d22e7f972aee8b
+  data.tar.gz: 9bd5b57762ee72afad778b0883b6a96b430fa334784912e0e91502b9ea61b29befc687fc7bc4ee0bc39b2f7568c484d0fcf353764543f3afb34529b2c7ffc925

data/README.rdoc

@@ -0,0 +1,87 @@
+= SmartMachine
+
+Git push should deploy.
+
+SmartMachine is a full-stack deployment framework for rails optimized for admin programmer happiness and peaceful administration. It encourages natural simplicity by favoring convention over configuration.
+
+Deploy your Rails apps to your own server with - git push production master
+
+
+== How it Works
+
+After you run the below commands, you get.
+1. Setup of basic best practices of setting up and securing a VPS server.
+2. Setup and installation of Docker.
+3. Setup and installation of docker based Mysql, Solr, Nginx, App Prereceiver.
+4. Deployment of your Rails apps to your own server with - git push production master
+
+
+== Setup a New Machine - Ubuntu 18.04 LTS
+
+1. Getting Started with Linode:
+
+    https://www.linode.com/docs/getting-started/
+
+2. How to Secure Your Server:
+
+    https://www.linode.com/docs/security/securing-your-server/
+
+
+== Install SmartMachine
+
+1. Install Ruby:
+
+    $ sudo apt-get install ruby-full
+
+2. Add gem executables to PATH (remember to check ruby version in the path):
+
+    $ echo 'export PATH="$PATH:$HOME/.gem/ruby/2.5.0/bin"' >> ~/.bashrc && source ~/.bashrc
+
+3. Install smartmachine for current user:
+
+    $ gem install smartmachine --user-install
+
+4. Initialize smartmachine:
+
+    $ smartmachine init
+
+
+== TODO - Setup Machine
+1. Getting Started and Securing your Server:
+
+    $ smartmachine machine install
+
+
+== Install Docker
+
+1. Run docker install command:
+
+    $ smartmachine docker install
+
+2. Add UFW rules for Docker as specified at the end of installation.
+
+
+== Starting Grids as per Choice
+
+1. Start mysql grid:
+
+    $ smartmachine grids mysql up
+
+2. Start solr grid:
+
+    $ smartmachine grids solr up
+
+3. Start nginx grid:
+
+    $ smartmachine grids nginx up
+
+4. Start prereceiver grid:
+
+    $ smartmachine grids prereceiver up
+
+
+== TODO - Creating New App
+
+1. Creating a new bare app on the server:
+
+    $ smartmachine apps create <USERNAME> <APPNAME>

data/bin/buildpacker

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'smart_machine'
+
+if ARGV[0] == 'pack'
+	buildpacker = SmartMachine::Buildpacker.new
+	buildpacker.pack
+end

data/bin/prereceiver

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'smart_machine'
+
+if ARGV[0] == 'prereceive'
+	raise "Please provide appname, username, oldrev, newrev and refname" unless ARGV[1] && ARGV[2] && ARGV[3] && ARGV[4] && ARGV[5]
+	SmartMachine::Grids::Prereceiver.prereceive(ARGV[1], ARGV[2], ARGV[3], ARGV[4], ARGV[5])
+end

data/bin/smartmachine

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+require "smart_machine"
+
+command = ARGV.shift
+
+machine = SmartMachine::Machine.new
+
+case command
+when "new"
+	machine.create ARGV
+	return
+
+when "--init-local"
+	machine.init_local ARGV
+	return
+
+when "--version"
+	puts "SmartMachine #{SmartMachine.version}"
+	return
+
+when "--help"
+	puts "Help: Specify a valid smartmachine command to execute. Are you in the correct directory to run this command?"
+	return
+
+when "runner"
+	exec "smartrunner #{ARGV.join(' ')}"
+	return
+
+end
+
+if machine.in_local_machine_dir?
+	case command
+	when "credentials:edit"
+		credentials = SmartMachine::Credentials.new
+		credentials.edit
+
+	when "environment:edit"
+		system("#{ENV['EDITOR']} config/environment.rb")
+
+	when "users:edit"
+		system("#{ENV['EDITOR']} config/users.yml")
+
+	when "ssh"
+		machine.ssh
+
+	when "install"
+		machine.installer ARGV.unshift("install")
+
+	when "update"
+		machine.installer ARGV.unshift("update")
+
+	when "uninstall"
+		machine.installer ARGV.unshift("uninstall")
+
+	when "apps"
+		machine.apps ARGV
+
+	when "grids"
+		machine.grids ARGV
+		return
+
+	when "ps"
+		machine.ps ARGV
+		return
+
+	when "logs"
+		machine.logs ARGV
+		return
+
+	when "sync"
+		sync = SmartMachine::Sync.new
+		sync.run
+
+	else
+		exec "smartmachine --help"
+
+	end
+else
+	exec "smartmachine --help"
+end

data/bin/smartrunner

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require "smart_machine"
+
+command = ARGV.shift
+
+machine = SmartMachine::Machine.new
+
+case command
+when "grids"
+	grids = SmartMachine::Grids.new
+	grids.run ARGV
+
+when "apps"
+	grids = SmartMachine::Apps.new
+	grids.run ARGV
+
+when "buildpacker"
+	action = ARGV.shift
+	buildpacker = SmartMachine::Buildpacker.new
+	buildpacker.public_send(action, *ARGV)
+
+when "prereceiver"
+	action = ARGV.shift
+	prereceiver = SmartMachine::Grids::Prereceiver.new
+	prereceiver.public_send(action, *ARGV)
+
+end

data/lib/smart_machine.rb

@@ -0,0 +1,24 @@
+require "ostruct"
+require "yaml"
+
+# The main SmartMachine driver
+module SmartMachine
+	def self.config
+		@@config ||= OpenStruct.new
+	end
+
+	def self.credentials
+		@@credentials ||= OpenStruct.new(SmartMachine::Credentials.new.config)
+	end
+end
+
+require 'smart_machine/version'
+
+SmartMachine.config.root_path = File.expand_path('../..', __FILE__)
+SmartMachine.config.user_home_path = File.expand_path('~')
+if File.exist?("#{SmartMachine.config.user_home_path}/.smartmachine/config/environment.rb")
+	require "#{SmartMachine.config.user_home_path}/.smartmachine/config/environment"
+end
+
+require 'smart_machine/base'
+require 'smart_machine/boot'

data/lib/smart_machine/apps.rb

@@ -0,0 +1,14 @@
+# The main SmartMachine Apps
+module SmartMachine
+	class Apps < SmartMachine::Base
+		def run(*args)
+			args.flatten!
+
+			action = args.shift
+
+			raise "invalid action on the app" unless ['create', 'destroy', 'start', 'stop'].include? action
+
+			Object.const_get("SmartMachine::Apps::App").public_send(action, *args)
+		end
+	end
+end

data/lib/smart_machine/apps/app.rb

@@ -0,0 +1,182 @@
+# The main SmartMachine App driver
+module SmartMachine
+	class Apps
+		class App < SmartMachine::Base
+			def initialize
+			end
+
+			# Creating App!
+			#
+			# Example:
+			#   >> SmartMachine::Apps::Rails.create
+			#   => Creation Complete
+			#
+			# Arguments:
+			#   appname => (String)
+			# 	username => (String)
+			def self.create(*args)
+				args.flatten!
+				appname = args.empty? ? '' : args.shift
+				username = args.empty? ? '' : args.shift
+
+				raise "Please provide appname and username" if appname.empty? || username.empty?
+
+				if SmartMachine::Docker.running?
+					repository_path = "#{SmartMachine.config.user_home_path}/.smartmachine/apps/repositories/#{appname}.git"
+					container_path = "#{SmartMachine.config.user_home_path}/.smartmachine/apps/containers/#{appname}"
+					print "-----> Creating Application ... "
+
+					# Checking if app with given name already exists
+					if Dir.exist?(repository_path)
+						puts "failed. App with name '#{appname}' already exists."
+						exit
+					end
+
+					# Creating Directories
+					FileUtils.mkdir_p(repository_path)
+					FileUtils.mkdir_p(container_path)
+
+					# Initializing bare repo and pre-receive
+					Dir.chdir(repository_path) do
+						%x[git init --bare]
+						%x[chmod +x #{SmartMachine.config.user_home_path}/.smartmachine/grids/prereceiver/pre-receive]
+						%x[ln -s #{SmartMachine.config.user_home_path}/.smartmachine/grids/prereceiver/pre-receive #{repository_path}/hooks/pre-receive]
+						puts "done"
+					end
+
+					# Creating Environment File
+					if File.exist?("#{SmartMachine.config.user_home_path}/.smartmachine/config/environment.rb")
+						require "#{SmartMachine.config.user_home_path}/.smartmachine/config/environment"
+					end
+					unless File.exist? "#{container_path}/env"
+						print "-----> Creating App Environment ... "
+						page = <<~HEREDOC
+							## System
+							USERNAME=#{username}
+							KEEP_RELEASES=3
+
+							## Docker
+							VIRTUAL_HOST=#{appname}.#{SmartMachine.config.apps_domain}
+							LETSENCRYPT_HOST=#{appname}.#{SmartMachine.config.apps_domain}
+							LETSENCRYPT_EMAIL=#{SmartMachine.config.sysadmin_email}
+							LETSENCRYPT_TEST=false
+						HEREDOC
+						puts "done" if system("echo '#{page}' > #{container_path}/env")
+					end
+				end
+			end
+
+			def self.destroy(*args)
+				args.flatten!
+				appname = args.empty? ? '' : args.shift
+
+				raise "Please provide appname" if appname.empty?
+
+				if SmartMachine::Docker.running?
+					# Stopping & Removing old container
+					self.stop(appname)
+
+					# Destroying Directories
+					print "-----> Deleting App #{appname} ... "
+					repository_path = "#{SmartMachine.config.user_home_path}/.smartmachine/apps/repositories/#{appname}.git"
+					container_path = "#{SmartMachine.config.user_home_path}/.smartmachine/apps/containers/#{appname}"
+					FileUtils.rm_r(repository_path)
+					FileUtils.rm_r(container_path)
+					puts "done"
+				end
+			end
+			
+			def self.start(*args)
+				args.flatten!
+				appname = args.empty? ? '' : args.shift
+				app_version = args.empty? ? 0 : args.shift.to_i
+
+				raise "Please provide appname" if appname.empty?
+
+				logger.formatter = proc do |severity, datetime, progname, message|
+					severity_text = { "DEBUG" => "\u{1f527} #{severity}:", "INFO" => " \u{276f}", "WARN" => "\u{2757} #{severity}:",
+						"ERROR" => "\u{274c} #{severity}:", "FATAL" => "\u{2b55} #{severity}:", "UNKNOWN" => "\u{2753} #{severity}:"
+					}
+					"\t\t\t\t#{severity_text[severity]} #{message}\n"
+				end
+
+				if SmartMachine::Docker.running?
+					container_path = "#{SmartMachine.config.user_home_path}/.smartmachine/apps/containers/#{appname}"
+
+					Dir.chdir("#{container_path}/releases") do
+						# Getting App Version
+						if app_version == 0
+							app_versions = Dir.glob('*').select { |f| File.directory? f }.sort
+							app_version = app_versions.last
+						end
+						container_path_with_version = "#{container_path}/releases/#{app_version}"
+
+						logger.info "Launching Application ..."
+
+						app = SmartMachine::Apps::Rails.new
+						app.start(appname, container_path, container_path_with_version)
+					end
+				end
+
+				logger.formatter = nil
+			end
+
+			def self.stop(*args)
+				args.flatten!
+				appname = args.empty? ? '' : args.shift
+
+				raise "Please provide appname" if appname.empty?
+
+				container_name = appname
+
+				if SmartMachine::Docker.running?
+					container_id = `docker ps -a -q --filter='name=^#{container_name}$'`.chomp
+					unless container_id.empty?
+						logger.debug "Stopping & Removing container #{container_name} ..."
+						if system("docker stop #{container_name} && docker rm #{container_name}", out: File::NULL)
+							logger.debug "Stopped & Removed container #{container_name} ..."
+						end
+					else
+						logger.debug "Container '#{container_name}' does not exist to stop."
+					end
+				end
+			end
+
+			def self.clean_up(container_path)
+				env_vars = SmartMachine::Apps::App.get_env_vars(container_path)
+				return unless env_vars
+
+				logger.info "Cleaning up ..."
+
+				# Clean up very old versions
+				Dir.chdir("#{container_path}/releases") do
+					app_versions = Dir.glob('*').select { |f| File.directory? f }.sort
+					destroy_count = app_versions.count - env_vars['KEEP_RELEASES'].to_i
+					if destroy_count > 0
+						logger.debug "Deleting older application releases ..."
+						destroy_count.times do
+							FileUtils.rm_r(File.join(Dir.pwd, app_versions.shift))
+						end
+					end
+				end
+			end
+
+			def self.get_env_vars(container_path)
+				unless File.exist? "#{container_path}/env"
+					logger.fatal "Environment could not be loaded ... Failed."
+					return false
+				end
+
+				env_vars = {}
+				File.open("#{container_path}/env").each_line do |line|
+					line.chomp!
+					next if line.empty? || line.start_with?('#')
+				    key, value = line.split "="
+				    env_vars[key] = value
+				end
+
+				env_vars
+			end
+		end
+	end
+end