smartmachine 0.6.0 → 0.7.0

data/lib/smart_machine/docker.rb

@@ -0,0 +1,144 @@
+# The main SmartMachine Docker driver
+module SmartMachine
+	class Docker < SmartMachine::Base
+		def initialize
+		end
+
+		# Installing Docker!
+		#
+		# Example:
+		#   => Installation Complete
+		#
+		# Arguments:
+		#   none
+		def install
+			puts "-----> Installing Docker"
+
+			ssh = SmartMachine::SSH.new
+
+			print "-----> Installing Docker Engine ... "
+			commands = [
+				"sudo apt-get -y update",
+				"sudo apt-get -y install apt-transport-https ca-certificates curl software-properties-common",
+				"curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -",
+				"sudo apt-key fingerprint 0EBFCD88",
+				"sudo add-apt-repository \"deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable\"",
+				"sudo apt-get -y update",
+				"sudo apt-get -y install docker-ce",
+				"sudo usermod -aG docker $USER",
+				"docker run --rm hello-world",
+				"docker rmi hello-world"
+			]
+			ssh.run commands
+			puts "done"
+
+			print "-----> Installing Docker Compose ... "
+			commands = [
+				"sudo curl -L --fail https://github.com/docker/compose/releases/download/1.24.0/run.sh -o /usr/local/bin/docker-compose",
+				"sudo chmod +x /usr/local/bin/docker-compose",
+				"docker-compose --version",
+				"sudo curl -L https://raw.githubusercontent.com/docker/compose/1.24.0/contrib/completion/bash/docker-compose -o /etc/bash_completion.d/docker-compose"
+			]
+			ssh.run commands
+			puts "done"
+
+			self.add_ufw_rules
+
+			puts "-----> Docker Installation Complete"
+		end
+
+		# Uninstalling Docker!
+		#
+		# Example:
+		#   => Uninstallation Complete
+		#
+		# Arguments:
+		#   none
+		def uninstall
+			puts "-----> Uninstalling Docker"
+
+			ssh = SmartMachine::SSH.new
+
+			print "-----> Uninstalling Docker Compose ... "
+			commands = ["sudo rm /usr/local/bin/docker-compose"]
+			ssh.run commands
+			puts "done"
+
+			print "-----> Uninstalling Docker Engine ... "
+			commands = ["sudo apt-get purge docker-ce", "sudo rm -rf /var/lib/docker"]
+			ssh.run commands
+			puts "done"
+
+			self.remove_ufw_rules
+
+			puts "-----> You must delete any edited configuration files manually."
+
+			puts "-----> Docker Uninstallation Complete"
+		end
+
+		def update
+		end
+
+		def add_ufw_rules
+			puts '-----> Add the following rules to the end of the file /etc/ufw/after.rules and reload ufw using - sudo ufw reload'
+			puts '# BEGIN UFW AND DOCKER
+			*filter
+			:ufw-user-forward - [0:0]
+			:DOCKER-USER - [0:0]
+			-A DOCKER-USER -m conntrack --ctstate RELATED,ESTABLISHED -j ACCEPT
+			-A DOCKER-USER -m conntrack --ctstate INVALID -j DROP
+			-A DOCKER-USER -i eth0 -j ufw-user-forward
+			-A DOCKER-USER -i eth0 -j DROP
+			COMMIT
+			# END UFW AND DOCKER'
+
+			# puts "-----> Adding UFW rules for Docker"
+			# interface_name = system("ip route show | sed -e 's/^default via [0-9.]* dev \(\w\+\).*/\1/'")
+			# puts interface_name
+
+			# system("sed '/^# BEGIN UFW AND DOCKER/,/^# END UFW AND DOCKER/d' '/etc/ufw/after.rules'")
+			# system("sudo tee -a '/etc/ufw/after.rules' > /dev/null <<EOT
+			# # BEGIN UFW AND DOCKER
+			# *filter
+			# :ufw-user-forward - [0:0]
+			# :DOCKER-USER - [0:0]
+			# -A DOCKER-USER -m conntrack --ctstate RELATED,ESTABLISHED -j ACCEPT
+			# -A DOCKER-USER -m conntrack --ctstate INVALID -j DROP
+			# -A DOCKER-USER -i eth0 -j ufw-user-forward
+			# -A DOCKER-USER -i eth0 -j DROP
+			# COMMIT
+			# # END UFW AND DOCKER
+			# EOT")
+			# system("sudo ufw reload")
+		end
+
+		def remove_ufw_rules
+			puts '-----> Remove the following rules at the end of the file /etc/ufw/after.rules and reload ufw using - sudo ufw reload'
+			puts '# BEGIN UFW AND DOCKER
+			*filter
+			:ufw-user-forward - [0:0]
+			:DOCKER-USER - [0:0]
+			-A DOCKER-USER -m conntrack --ctstate RELATED,ESTABLISHED -j ACCEPT
+			-A DOCKER-USER -m conntrack --ctstate INVALID -j DROP
+			-A DOCKER-USER -i eth0 -j ufw-user-forward
+			-A DOCKER-USER -i eth0 -j DROP
+			COMMIT
+			# END UFW AND DOCKER'
+
+			# puts "-----> Removing UFW rules for Docker"
+			# system("sed '/^# BEGIN UFW AND DOCKER/,/^# END UFW AND DOCKER/d' '/etc/ufw/after.rules'")
+			# system("sudo ufw reload")
+		end
+
+		# Below methods are non ssh methods and should be executed on the server only.
+
+		def self.running?
+			if system("docker info", [:out, :err] => File::NULL)
+				true
+			else
+				puts "Error: Docker daemon is not running. Have you installed docker? Please ensure docker daemon is running and try again."
+				false
+			end
+		end
+	end
+end

data/lib/smart_machine/engine.rb

@@ -0,0 +1,82 @@
+# The main SmartMachine Engine driver
+module SmartMachine
+	class Engine < SmartMachine::Base
+		def initialize
+		end
+
+		def install
+			puts "-----> Installing SmartMachine Engine"
+
+			SmartMachine::User.create_htpasswd_files
+
+			ssh = SmartMachine::SSH.new
+			machine = SmartMachine::Machine.new
+			sync = SmartMachine::Sync.new
+
+			system("mkdir -p ./tmp/engine")
+			system("cp #{SmartMachine.config.root_path}/lib/smart_machine/engine/Dockerfile ./tmp/engine/Dockerfile")
+
+			gem_file_path = File.expand_path("../../cache/smartmachine-#{SmartMachine.version}.gem", SmartMachine.config.root_path)
+			system("cp #{gem_file_path} ./tmp/engine/smartmachine-#{SmartMachine.version}.gem")
+
+			sync.run only: :push
+
+			print "-----> Creating image for SmartMachine ... "
+			ssh.run "docker image build --quiet --tag #{engine_image_name} \
+					--build-arg SMARTMACHINE_MASTER_KEY=#{SmartMachine::Credentials.new.read_key} \
+					--build-arg SMARTMACHINE_VERSION=#{SmartMachine.version} \
+					--build-arg USER_NAME=`id -un` \
+					--build-arg USER_UID=`id -u` \
+					--build-arg DOCKER_GID=`getent group docker | cut -d: -f3` \
+					~/.smartmachine/tmp/engine"
+			puts "done"
+
+			print "-----> Adding SmartMachine to PATH ... "
+			ssh.run "mkdir -p ~/.smartmachine/bin && touch ~/.smartmachine/bin/smartmachine.sh"
+			ssh.run "echo '#{smartmachine_binary_template}' > ~/.smartmachine/bin/smartmachine.sh"
+			ssh.run "chmod +x ~/.smartmachine/bin/smartmachine.sh && sudo ln -sf ~/.smartmachine/bin/smartmachine.sh /usr/local/bin/smartmachine"
+			puts "done"
+
+			system("rm ./tmp/engine/Dockerfile")
+			system("rm ./tmp/engine/smartmachine-#{SmartMachine.version}.gem")
+
+			sync.run
+
+			puts "-----> SmartMachine Engine Installation Complete"
+		end
+
+		def uninstall
+			puts "-----> Uninstalling SmartMachine Engine"
+
+			ssh = SmartMachine::SSH.new
+
+			ssh.run "sudo rm /usr/local/bin/smartmachine"
+			ssh.run "docker rmi $(docker images -q smartmachine)"
+
+			puts "-----> SmartMachine Engine Uninstallation Complete"
+		end
+
+		def update
+			self.uninstall
+			self.install
+		end
+
+		def smartmachine_binary_template
+			<<~BASH
+				#!/bin/bash
+
+				docker run -it --rm \
+					-v "/home/$(whoami)/.smartmachine:/home/$(whoami)/.smartmachine" \
+					-v "/var/run/docker.sock:/var/run/docker.sock" \
+					-w "/home/$(whoami)/.smartmachine" \
+					-u `id -u` \
+					--entrypoint "smartmachine" \
+					#{engine_image_name} "$@"
+			BASH
+		end
+
+		def engine_image_name
+			"smartmachine:#{SmartMachine.version}"
+		end
+	end
+end

data/lib/smart_machine/engine/Dockerfile

@@ -0,0 +1,27 @@
+FROM ruby:2.7.0-alpine3.11
+LABEL maintainer="Timeboard <hello@timeboard.me>"
+
+# User
+# --- Fix to change gid of 999 to 99 so that addgroup is free to create a group with 999 as gid
+ARG USER_NAME
+ARG USER_UID
+ARG DOCKER_GID
+RUN sed -i "s/999/99/" /etc/group && \
+	adduser --disabled-password --gecos "" --uid "$USER_UID" "$USER_NAME" && \
+	addgroup --gid "$DOCKER_GID" "docker" && adduser "$USER_NAME" "docker"
+
+# Essentials
+RUN apk add --update build-base && \
+	apk add --update docker && \
+	apk add --update git && \
+    rm -rf /var/cache/apk/*
+
+# smartmachine gem
+ARG SMARTMACHINE_VERSION
+COPY ./smartmachine-$SMARTMACHINE_VERSION.gem ./smartmachine-$SMARTMACHINE_VERSION.gem
+RUN gem install --no-document smartmachine-$SMARTMACHINE_VERSION.gem && \
+	rm ./smartmachine-$SMARTMACHINE_VERSION.gem
+
+# smartmachine master key
+ARG SMARTMACHINE_MASTER_KEY
+ENV SMARTMACHINE_MASTER_KEY=$SMARTMACHINE_MASTER_KEY

data/lib/smart_machine/engine/buildpacks/rails/Dockerfile

@@ -0,0 +1,21 @@
+ARG SMARTMACHINE_VERSION
+
+FROM smartmachine:$SMARTMACHINE_VERSION
+LABEL maintainer="Timeboard <hello@timeboard.me>"
+
+# Ruby on Rails Essentials
+RUN apk add --update build-base && \
+	apk add --update tzdata && \
+	apk add --update nodejs && \
+	apk add --update yarn && \
+	apk add --update mariadb-dev && \
+	apk add --update imagemagick && \
+	apk add --update ffmpeg && \
+	apk add --update mupdf && \
+	apk add --update mupdf-tools && \
+    rm -rf /var/cache/apk/*
+
+# Gems
+RUN gem install bundler -v 2.1.4
+
+CMD ["buildpacker", "pack"]

data/lib/smart_machine/gem_version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SmartMachine
+  # Returns the version of the currently loaded SmartMachine as a <tt>Gem::Version</tt>.
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 7
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/smart_machine/grids.rb

@@ -0,0 +1,15 @@
+# The main SmartMachine Grids
+module SmartMachine
+	class Grids < SmartMachine::Base
+		def run(*args)
+			args.flatten!
+
+			grid_name = args.shift
+			action = args.shift
+
+			raise "invalid action on the grid" unless ['up', 'down'].include? action
+
+			Object.const_get("SmartMachine::Grids::#{grid_name.capitalize}").new.public_send(action, *args)
+		end
+	end
+end

data/lib/smart_machine/grids/elasticsearch.rb

@@ -0,0 +1,97 @@
+# The main SmartMachine Grids Elasticsearch driver
+module SmartMachine
+	class Grids
+		class Elasticsearch < SmartMachine::Base
+			def initialize
+			end
+
+			def install
+				puts "-----> Installing Elasticsearch"
+
+				print "-----> Creating settings for elasticsearch ... "
+				ssh = SmartMachine::SSH.new
+				ssh.run "echo 'vm.max_map_count=262144' | sudo tee /etc/sysctl.d/60-smartmachine-elasticsearch.conf && sudo sysctl --system"
+				puts "done"
+
+				puts "-----> Elasticsearch Installation Complete"
+			end
+
+			def uninstall
+				puts "-----> Uninstalling Elasticsearch"
+
+				print "-----> Removing settings for elasticsearch ... "
+				ssh = SmartMachine::SSH.new
+				# NOTE: sysctl does not reset this setting until restart of system even after sudo sysctl --system is run.
+				ssh.run "test -f /etc/sysctl.d/60-smartmachine-elasticsearch.conf && sudo rm /etc/sysctl.d/60-smartmachine-elasticsearch.conf && sudo sysctl --system"
+				puts "done"
+
+				puts "-----> Elasticsearch Uninstallation Complete"
+			end
+
+			def update
+				self.uninstall
+				self.install
+			end
+
+			def up(*args)
+				args.flatten!
+				exposed = args.empty? ? '' : args.shift
+
+				if SmartMachine::Docker.running?
+					# Creating networks
+					unless system("docker network inspect elasticsearch-network", [:out, :err] => File::NULL)
+						print "-----> Creating network elasticsearch-network ... "
+						if system("docker network create elasticsearch-network", out: File::NULL)
+							puts "done"
+						end
+					end
+
+					# Creating & Starting containers
+					print "-----> Creating container elasticsearch ... "
+					if system("docker create \
+						--name='elasticsearch' \
+						--env discovery.type=single-node \
+						--env cluster.name=elasticsearch-cluster \
+						--env 'ES_JAVA_OPTS=-Xms512m -Xmx512m -Des.enforce.bootstrap.checks=true' \
+						--env bootstrap.memory_lock=true \
+						--ulimit memlock=-1:-1 \
+						--ulimit nofile=65535:65535 \
+						--user `id -u`:`id -g` \
+						#{"--publish='#{SmartMachine.credentials.elasticsearch[:port]}:#{SmartMachine.credentials.elasticsearch[:port]}'" if exposed == '--exposed'} \
+						--volume='#{SmartMachine.config.user_home_path}/.smartmachine/grids/elasticsearch/data:/usr/share/elasticsearch/data' \
+						--volume='#{SmartMachine.config.user_home_path}/.smartmachine/grids/elasticsearch/logs:/usr/share/elasticsearch/logs' \
+						--restart='always' \
+						--network='elasticsearch-network' \
+						elasticsearch:7.4.1", out: File::NULL)
+
+						puts "done"
+						print "-----> Starting container elasticsearch ... "
+						if system("docker start elasticsearch", out: File::NULL)
+							puts "done"
+						end
+					end
+				end
+			end
+	
+			def down
+				if SmartMachine::Docker.running?
+					# Stopping & Removing containers - in reverse order
+					print "-----> Stopping container elasticsearch ... "
+					if system("docker stop 'elasticsearch'", out: File::NULL)
+						puts "done"
+						print "-----> Removing container elasticsearch ... "
+						if system("docker rm 'elasticsearch'", out: File::NULL)
+							puts "done"
+						end
+					end
+
+					# Removing networks
+					print "-----> Removing network elasticsearch-network ... "
+					if system("docker network rm elasticsearch-network", out: File::NULL)
+						puts "done"
+					end
+				end
+			end			
+		end
+	end
+end

data/lib/smart_machine/grids/minio.rb

@@ -0,0 +1,77 @@
+# The main SmartMachine Grids Minio driver
+module SmartMachine
+	class Grids
+		class Minio < SmartMachine::Base
+			def initialize
+			end
+
+			def up(*args)
+				args.flatten!
+				exposed = args.empty? ? '' : args.shift
+
+				if SmartMachine::Docker.running?
+					# Creating networks
+					unless system("docker network inspect minio-network", [:out, :err] => File::NULL)
+						print "-----> Creating network minio-network ... "
+						if system("docker network create minio-network", out: File::NULL)
+							puts "done"
+						end
+					end
+
+					# Creating & Starting containers
+					print "-----> Creating container minio ... "
+					if system("docker create \
+						--name='minio' \
+						--env VIRTUAL_HOST=#{SmartMachine.credentials.minio[:name]}.#{SmartMachine.config.apps_domain} \
+						--env LETSENCRYPT_HOST=#{SmartMachine.credentials.minio[:name]}.#{SmartMachine.config.apps_domain} \
+						--env LETSENCRYPT_EMAIL=#{SmartMachine.config.sysadmin_email} \
+						--env LETSENCRYPT_TEST=false \
+						--env MINIO_ACCESS_KEY=#{SmartMachine.credentials.minio[:access_key]} \
+						--env MINIO_SECRET_KEY=#{SmartMachine.credentials.minio[:secret_key]} \
+						--env MINIO_BROWSER=#{SmartMachine.credentials.minio[:browser]} \
+						--env MINIO_WORM=#{SmartMachine.credentials.minio[:worm]} \
+						--user `id -u`:`id -g` \
+						--volume='#{SmartMachine.config.user_home_path}/.smartmachine/grids/minio/data:/data' \
+						--restart='always' \
+						--network='minio-network' \
+						minio/minio:RELEASE.2020-02-27T00-23-05Z server /data", out: File::NULL)
+
+						# The alias is necessary to support internal network requests directed to minio container using public url
+						system("docker network connect --alias #{SmartMachine.credentials.minio[:name]}.#{SmartMachine.config.apps_domain} minio-network nginx")
+						system("docker network connect nginx-network minio")
+
+						puts "done"
+						print "-----> Starting container minio ... "
+						if system("docker start minio", out: File::NULL)
+							puts "done"
+						end
+					end
+				end
+			end
+
+			def down
+				if SmartMachine::Docker.running?
+					# Disconnecting networks
+					system("docker network disconnect nginx-network minio")
+					system("docker network disconnect minio-network nginx")
+
+					# Stopping & Removing containers - in reverse order
+					print "-----> Stopping container minio ... "
+					if system("docker stop 'minio'", out: File::NULL)
+						puts "done"
+						print "-----> Removing container minio ... "
+						if system("docker rm 'minio'", out: File::NULL)
+							puts "done"
+						end
+					end
+
+					# Removing networks
+					print "-----> Removing network minio-network ... "
+					if system("docker network rm minio-network", out: File::NULL)
+						puts "done"
+					end
+				end
+			end
+		end
+	end
+end