smartmachine 0.8.0 → 1.0.0

data/lib/smart_machine/docker.rb

@@ -1,144 +1,145 @@
-# 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
+  class Docker < SmartMachine::Base
+    def initialize
+      @machine = SmartMachine::Machine.new
+    end
+
+    # Installing Docker!
+    #
+    # Example:
+    #   => Installation Complete
+    #
+    # Arguments:
+    #   none
+    def install
+      puts "-----> Installing Docker"
+      if platform_on_machine?(os: "linux", distro_name: "debian")
+        install_on_linuxos(distro_name: "debian", arch: "amd64")
+      # elsif platform_on_machine?(os: "mac")
+      #   install_on_macos
+      else
+        raise "Installation of docker is currently supported on Debian GNU/Linux."
+      end
+      puts "-----> Docker Installation Complete"
+    end
+
+    # Uninstalling Docker!
+    #
+    # Example:
+    #   => Uninstallation Complete
+    #
+    # Arguments:
+    #   none
+    def uninstall
+      puts "-----> Uninstalling Docker"
+      if platform_on_machine?(os: "linux", distro_name: "debian")
+        uninstall_on_linuxos(distro_name: "debian", arch: "amd64")
+      # elsif platform_on_machine?(os: "mac")
+      #   uninstall_on_macos
+      else
+        raise "Uninstallation of docker is currently supported on Debian GNU/Linux."
+      end
+      puts "-----> Docker Uninstallation Complete"
+    end
+
+    private
+
+    def install_on_linuxos(distro_name:, arch:)
+
+      commands = [
+        "sudo apt-get -y update",
+        "sudo apt-get -y install apt-transport-https ca-certificates curl gnupg-agent software-properties-common",
+        "curl -fsSL https://download.docker.com/linux/#{distro_name}/gpg | sudo apt-key add -",
+        "sudo apt-key fingerprint 0EBFCD88",
+        "sudo add-apt-repository \"deb [arch=#{arch}] https://download.docker.com/linux/#{distro_name} $(lsb_release -cs) stable\"",
+        "sudo apt-get -y update",
+        "sudo apt-get -y install docker-ce docker-ce-cli containerd.io",
+        "sudo usermod -aG docker $USER",
+        "docker run --rm hello-world",
+        "docker rmi hello-world"
+      ]
+      @machine.run_on_machine(commands: commands)
+
+      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 uninstall_on_linuxos(distro_name:, arch:)
+
+      commands = [
+        "sudo apt-get purge docker-ce docker-ce-cli containerd.io",
+        "sudo apt-get autoremove",
+        "sudo rm -rf /var/lib/docker",
+        "sudo rm -rf /var/lib/containerd"
+      ]
+      @machine.run_on_machine(commands: commands)
+
+      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
+
+    # def install_on_macos
+    #   commands = [
+    #     "/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"",
+    #     "brew install homebrew/cask/docker",
+    #     "brew install bash-completion",
+    #     "brew install docker-completion",
+    #     "open /Applications/Docker.app",
+    #     # The docker app asks for permission after opening gui. if that can be automated then the next two statements can be uncommented and automated. Until then can't execute automatically.
+    #     # "docker run --rm hello-world",
+    #     # "docker rmi hello-world"
+    #   ]
+    #   @machine.run_on_machine(commands: commands)
+    # end
+
+    # def uninstall_on_macos
+    #   commands = [
+    #     "brew uninstall docker-completion",
+    #     "brew uninstall bash-completion",
+    #     "brew uninstall --zap homebrew/cask/docker"
+    #   ]
+    #   @machine.run_on_machine(commands: commands)
+    # end
+  end
+end

data/lib/smart_machine/engine/Dockerfile

@@ -1,26 +1,28 @@
 FROM ruby:2.7.0-alpine3.11
-LABEL maintainer="Timeboard <hello@timeboard.me>"
+LABEL maintainer="plainsource <plainsource@humanmind.me>"
 
 # User
-# --- Fix to change gid of 999 to 99 so that addgroup is free to create a group with 999 as gid
+# --- Fix to change docker gid to 998 (if it is in use) so that addgroup is free to create a group with docker gid.
 ARG USER_NAME
 ARG USER_UID
 ARG DOCKER_GID
-RUN sed -i "s/999/99/" /etc/group && \
+ARG DOCKER_GNAME
+RUN sed -i "s/$DOCKER_GID/998/" /etc/group && \
 	adduser --disabled-password --gecos "" --uid "$USER_UID" "$USER_NAME" && \
-	addgroup --gid "$DOCKER_GID" "docker" && adduser "$USER_NAME" "docker"
+	addgroup --gid "$DOCKER_GID" "$DOCKER_GNAME" && adduser "$USER_NAME" "$DOCKER_GNAME"
 
 # Essentials
 RUN apk add --update build-base && \
 	apk add --update xz && \
 	apk add --update docker && \
 	apk add --update git && \
+	apk add --update rsync && \
     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 && \
+RUN gem install --no-document ./smartmachine-$SMARTMACHINE_VERSION.gem && \
 	rm ./smartmachine-$SMARTMACHINE_VERSION.gem
 
 # smartmachine master key

data/lib/smart_machine/engine.rb

@@ -1,82 +1,107 @@
 # 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
+  class Engine < SmartMachine::Base
+    def initialize
+      @scp = SmartMachine::SCP.new
+      @grids_nginx = SmartMachine::Grids::Nginx.new
+      @syncer = SmartMachine::Syncer.new
+      @machine = SmartMachine::Machine.new
+
+      @gem_cache_dir = Gem::Specification.find_by_name("smartmachine").cache_dir
+      @gem_cache_dir = "../smartmachine/pkg"
+
+      if platform_on_machine?(os: "linux", distro_name: "debian")
+        @docker_gid = "getent group docker | cut -d: -f3"
+        @docker_gname = "docker"
+        @docker_socket_path = "/var/run/docker.sock"
+        @remote_smartmachine_dir = "/home/`whoami`/smartmachine"
+      # elsif platform_on_machine?(os: "mac")
+      #   @docker_gid = "id -g"
+      #   @docker_gname = "staff"
+      #   @docker_socket_path = "/Users/`whoami`/Library/Containers/com.docker.docker/Data/docker.sock"
+      #   @remote_smartmachine_dir = "/Users/`whoami`/Desktop/smartmachine"
+      else
+        raise("OS not supported to set docker_gid, docker_gname and docker_socket_path")
+      end
+    end
+
+    def install
+      puts "-----> Installing SmartMachine Engine"
+
+      if @machine.run_on_machine commands: "mkdir -p #{@remote_smartmachine_dir}/tmp/engine"
+        @scp.upload!(local_path: "#{SmartMachine.config.gem_dir}/lib/smart_machine/engine/Dockerfile", remote_path: "~/smartmachine/tmp/engine")
+        @scp.upload!(local_path: "#{@gem_cache_dir}/smartmachine-#{SmartMachine.version}.gem", remote_path: "~/smartmachine/tmp/engine")
+      end
+
+      puts "-----> Creating image for Engine ... "
+      command = [
+        "docker image build --quiet --tag #{engine_image_name_with_version}",
+        "--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=`#{@docker_gid}`",
+        "--build-arg DOCKER_GNAME=#{@docker_gname}",
+        "#{@remote_smartmachine_dir}/tmp/engine"
+      ]
+      @machine.run_on_machine commands: command.join(" ")
+      puts "done"
+
+      puts "-----> Adding Engine to PATH ... "
+      commands = [
+        "mkdir -p #{@remote_smartmachine_dir}/bin && touch #{@remote_smartmachine_dir}/bin/smartengine",
+        "echo '#{smartengine_binary_template}' > #{@remote_smartmachine_dir}/bin/smartengine",
+        "chmod +x #{@remote_smartmachine_dir}/bin/smartengine",
+        "sudo ln -sf #{@remote_smartmachine_dir}/bin/smartengine /usr/local/bin/smartengine",
+        "rm -r #{@remote_smartmachine_dir}/tmp/engine",
+        "smartengine --version"
+      ]
+      @machine.run_on_machine(commands: commands)
+      puts "done"
+
+      @grids_nginx.create_htpasswd_files
+
+      @syncer.sync(initial: true)
+
+      puts "-----> SmartMachine Engine Installation Complete"
+    end
+
+    def uninstall
+      puts "-----> Uninstalling SmartMachine Engine"
+
+      commands = [
+        "sudo rm /usr/local/bin/smartengine",
+        "sudo rm #{@remote_smartmachine_dir}/bin/smartengine",
+        "docker rmi $(docker images -q #{engine_image_name})"
+      ]
+      @machine.run_on_machine(commands: commands)
+
+      puts "-----> SmartMachine Engine Uninstallation Complete"
+    end
+
+    private
+
+    def smartengine_binary_template
+      <<~BASH
+        #!/bin/bash
+
+        docker run -i --rm \
+        -e INSIDE_ENGINE="yes" \
+        -v "#{@remote_smartmachine_dir}:/home/`whoami`/machine" \
+        -v "#{@docker_socket_path}:/var/run/docker.sock" \
+        -w "/home/`whoami`/machine" \
+        -u `id -u` \
+        --entrypoint "smartmachine" \
+        #{engine_image_name_with_version} "$@"
+      BASH
+    end
+
+    def engine_image_name_with_version
+      "#{engine_image_name}:#{SmartMachine.version}"
+    end
+
+    def engine_image_name
+      "smartmachine/smartengine"
+    end
+  end
 end