swarm_orca 0.1.1

data/lib/swarm_orca/orca_cli.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative 'new'
+require_relative 'encrypt'
+module SwarmOrca
+  module Cli
+    # Orca command line class
+    class OrcaCli < Thor
+      desc 'new ORCA_DIRECTORY_NAME GIT_FORK DOCKER_NETWORK',
+           'This Command will create a new Orca project'
+      long_desc <<-ORCA_NEW
+        ORCA_DIRECTORY_NAME: Name of the root directory of orca.\n
+        GIT_FORK: Orca github fork.\n
+        DOCKER_NETWORK: Docker swarm newtwork name.
+      ORCA_NEW
+
+      def new(orca_directory_name, git_fork, docker_network)
+        New.new(root_dir: Dir.pwd,
+                orca_dir_name: orca_directory_name,
+                git_fork: git_fork,
+                network: docker_network).execute
+      end
+
+      desc 'gen_enc_key', 'This Command will generate new encryption key'
+      def gen_enc_key
+        say("Encryption Key: #{Encrypt.generate_key}")
+      end
+
+      desc 'encrypt KEY TEXT', 'This Command will encrypt the given text'
+      def encrypt(key, text)
+        say(Encrypt.new(key).encrypt(text).to_s)
+      end
+
+      desc 'decrypt KEY CIPHER', 'This Command will decrypt the given cipher'
+      def decrypt(key, cipher)
+        say(Encrypt.new(key).decrypt(cipher).to_s)
+      end
+    end
+  end
+end

data/lib/swarm_orca/templates/orca/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/lib/swarm_orca/templates/orca/.ruby-gemset.tt

@@ -0,0 +1 @@
+<%= @gemset %>

data/lib/swarm_orca/templates/orca/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/lib/swarm_orca/templates/orca/README.md

@@ -0,0 +1,93 @@
+# Orca
+- A Template project for deploying services to a docker swarm cluster. This template includes the deployment stakes for the following services.
+
+  * Elasticsearch
+  * Errbit
+  * Nginx
+  * RabbitMQ
+  * Redis
+  * MySql
+
+# Directories & Files Structure
+   - application_stack :
+     a folder that contains docker-comppose templates files for applications.
+  - Capistrano:
+    Capistrano gem home folder
+  - capistrano/config/deploy/template_stage.rb:
+    Deployment stage template.
+  - capistrano/config/deploy
+    Organize deployment stages and their configurations.
+  - capistrano/config/deploy.rb:
+    Define all deployment tasks and functions.
+  - capistrano/log: capistrano log folder
+  - nginx: nginx docker image configurations
+  - redis: redis docker image configurations
+  - seeds: contains applications DB seed scripts and data.
+
+# Deployment Steps
+  - Prepare your deployment stage file under `config/deploy/${your_stage_name}.rb`. You can duplicate the `template_stage` and replace all the necessary configurations.
+  - Upload deployment scripts to the swarm manager server
+
+    ```sh
+    cd capistrano
+    bundle exec cap ${your_stage_name} deploy:setup
+    ```
+
+- Create Databases (assuming that orca have two applications web and backend)
+
+    ```sh
+    ➜ cd capistrano
+    ➜ cap -T | grep "create.*dbs"
+        cap deploy:create_web_dbs
+        cap deploy:create_backend_dbs
+    ```
+
+- Seed Databases (assuming that orca have two applications web and backend)
+
+    ```sh
+    ➜ cd capistrano
+    ➜ cap -T | grep "seed.*dbs"
+        cap deploy:seed_web_dbs
+        cap deploy:seed_backend_dbs
+    ```
+
+- Create and seed all databases at once
+
+    ```sh
+    ➜ cd capistrano
+    ➜ cap deploy:all_dbs
+    ```
+
+- Deploy services/applications individually
+
+  ```sh
+  cd capistrano
+  bundle exec cap ${your_stage_name} deploy:${service_name}
+  ```
+
+- Deploy all services
+
+  ```sh
+  cd capistrano
+  bundle exec cap ${your_stage_name} deploy:all
+  ```
+
+- Deploy subset of the defined services
+  ```
+  export DEPLOYED_STACKS='nginx redis'
+  export FORK=wshihadeh
+  bundle exec cap ${stage} deploy:auto
+  ```
+
+- Check Stage status
+
+  ```
+  bundle exec cap ${your_stage_name} docker:deploy:info
+  ```
+
+
+- Stop a given stack
+
+  ```
+  bundle exec cap ${your_stage_name} docker:stop:${service_name}
+  ```

data/lib/swarm_orca/templates/orca/application_stack/docker-stack-elasticsearch.yml.erb.tt

@@ -0,0 +1,22 @@
+version: '3.7'
+
+networks:
+  <%%= NETWORK %>:
+    external: true
+
+services:
+
+  # --- ELASTICSEARCH ---
+
+  elasticsearch:
+    image: ${ELASTICSEARCH_DOCKER_IMAGE}:${ELASTICSEARCH_DOCKER_IMAGE_TAG}
+    ports:
+    - ${ELASTIC_FIRST_PORT}:9200/tcp
+    - ${ELASTIC_SECOND_PORT}:9300/tcp
+    environment:
+      $$$$$$$$PWD/config: /usr/share/elasticsearch/config
+      $$$$$$$$PWD/esdata: /usr/share/elasticsearch/data
+    deploy:
+      replicas: 1
+    networks:
+      - <%%= NETWORK %>

data/lib/swarm_orca/templates/orca/application_stack/docker-stack-errbit.yml.erb.tt

@@ -0,0 +1,43 @@
+version: '3.7'
+
+networks:
+  <%%= NETWORK %>:
+    external: true
+
+services:
+
+  mongo_db:
+    image: ${ERRBIT_DB_DOCKER_IMAGE}:${ERRBIT_DB_DOCKER_IMAGE_TAG}
+    volumes:
+      - ${MONGO_VOLUME}:/data/db
+    deploy:
+      replicas: 1
+    networks:
+      - <%%= NETWORK %>
+
+  errbit_web:
+    image: ${ERRBIT_DOCKER_IMAGE}:${ERRBIT_DOCKER_IMAGE_TAG}
+    environment:
+      SECRET_KEY_BASE: 152944e50d19ab5601f3ef9bcc15d428fe6cd0d0c94a832b13528f6d5b0f82e6e957a1638695c37af94b3c1bd0f98fb1d0a98951d9ce964c8781892be644ecd0
+      RACK_ENV: production
+      MONGO_URL: 'mongodb://mongo_db'
+      ERRBIT_HOST: ${ERRBIT_HOST}
+      ERRBIT_PROTOCOL: ${ERRBIT_PROTOCOL}
+      ERRBIT_PORT: ${ERRBIT_PORT}
+      GOOGLE_AUTHENTICATION: 'false'
+      GITHUB_AUTHENTICATION: 'false'
+      ERRBIT_LOG_LOCATION: 'STDOUT'
+      PORT: '8080'
+      ERRBIT_USER_HAS_USERNAME: 'true'
+      ERRBIT_PER_APP_NOTIFY_AT_NOTICES: 'true'
+      LDAP_HOST: ${LDAP_HOST}
+      LDAP_USER: ${LDAP_USER}
+      LDAP_PASSWORD: ${LDAP_PASSWORD}
+      http_proxy: ${HTTP_PROXY}
+      https_proxy: ${HTTPS_PROXY}
+      no_proxy: ${NO_PROXY}
+    healthcheck:
+      test: "curl --fail http://localhost:8080/users/sign_in || exit 1"
+      interval: 5s
+    networks:
+      - <%%= NETWORK %>

data/lib/swarm_orca/templates/orca/application_stack/docker-stack-mysql.yml.erb.tt

@@ -0,0 +1,17 @@
+version: '3.7'
+
+networks:
+  <%%= NETWORK %>:
+    external: true
+
+services:
+
+  mysql:
+    image: ${MYSQL_DOCKER_IMAGE}:${MYSQL_DOCKER_IMAGE_TAG}
+    volumes:
+      - ${MYSQL_VOLUME}:/var/lib/mysql
+    environment:
+      - MYSQL_ROOT_PASSWORD=dummy
+    deploy:
+    networks:
+      - <%%= NETWORK %>

data/lib/swarm_orca/templates/orca/application_stack/docker-stack-nginx.yml.erb.tt

@@ -0,0 +1,22 @@
+version: '3.7'
+
+networks:
+  <%%= NETWORK %>:
+    external: true
+
+services:
+
+  # --- NGINX ---
+
+  nginx:
+    image: ${NGINX_DOCKER_IMAGE}:${NGINX_DOCKER_IMAGE_TAG}
+    ports:
+      - '${PORT_HTTP}:80'
+      - '${PORT_HTTPS}:443'
+    deploy:
+      replicas: 1
+      update_config:
+        parallelism: 1
+        delay: 3s
+    networks:
+      - <%%= NETWORK %>

data/lib/swarm_orca/templates/orca/application_stack/docker-stack-rabbitmq.yml.erb.tt

@@ -0,0 +1,19 @@
+version: '3.7'
+
+networks:
+  <%%= NETWORK %>:
+    external: true
+
+services:
+
+  # --- RABBITMQ ---
+
+  rabbitmq:
+    image: ${RABBITMQ_DOCKER_IMAGE}:${RABBITMQ_DOCKER_IMAGE_TAG}
+    hostname: rabbitmq
+    volumes:
+      - ${RABBITMQ_VOLUME}:/var/lib/rabbitmq
+    deploy:
+      replicas: 1
+    networks:
+      - <%%= NETWORK %>

data/lib/swarm_orca/templates/orca/application_stack/docker-stack-redis.yml.erb.tt

@@ -0,0 +1,19 @@
+version: '3.7'
+
+networks:
+  <%%= NETWORK %>:
+    external: true
+
+services:
+
+  redis:
+    image: ${DOCKER_IMAGE_PREFIX}${REDIS_DOCKER_IMAGE}:${REDIS_DOCKER_IMAGE_TAG}
+    ports:
+      - '${PORT}:6379'
+    volumes:
+    - ${NFS_MOUNT}:/data
+    command: ['redis-server', '/usr/local/etc/redis/redis.conf']
+    deploy:
+      replicas: 1
+    networks:
+      - <%%= NETWORK %>

data/lib/swarm_orca/templates/orca/capistrano/Capfile

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Include default deployment tasks
+require 'capistrano/deploy'
+
+require 'shellwords'
+
+# Load the SCM plugin appropriate to your project:
+#
+# require "capistrano/scm/hg"
+# install_plugin Capistrano::SCM::Hg
+# or
+# require "capistrano/scm/svn"
+# install_plugin Capistrano::SCM::Svn
+# or
+require 'swarm_orca'
+
+scm = ENV.fetch('SCM', 'git')
+require "capistrano/scm/#{scm}"
+install_plugin Module.const_get("Capistrano::SCM::#{scm.capitalize}")
+
+# Include tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails
+#   https://github.com/capistrano/passenger
+#
+# require "capistrano/rvm"
+# require "capistrano/rbenv"
+# require "capistrano/chruby"
+# require "capistrano/bundler"
+# require "capistrano/rails/assets"
+# require "capistrano/rails/migrations"
+# require "capistrano/passenger"
+
+# Load custom tasks from `lib/capistrano/tasks` if you have any defined
+Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

data/lib/swarm_orca/templates/orca/capistrano/Gemfile.tt

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'capistrano', '3.8.0'
+gem 'swarm_orca', '<%= @orca_version%>'

data/lib/swarm_orca/templates/orca/capistrano/config/deploy.rb.tt

@@ -0,0 +1,30 @@
+# config valid only for current version of Capistrano
+lock "3.8.0"
+require "capistrano/swarm_orca/set_global_config"
+
+# Overwrite swarm_orca global vars
+
+set :fork, "<%= @git_fork %>"
+set (:network) { "<%= @docker_network %>" }
+
+#Overwite gem global vars
+#set (:repo_url) { ENV["REPO_URL"] || "git@github.com:#{ENV.fetch('FORK', fetch(:fork))}/orca.git" }
+
+#set :keep_releases, 5
+#set (:application) { "orca" }
+#set (:deploy_to) { "/home/deploy/orca" }
+#set :pty, true
+
+#set (:service_stacks) { %w(elasticsearch rabbitmq errbit mysql) }
+#set (:service_stacks_with_build_image) { %w(nginx redis) }
+#set (:db_apps_stacks_mapping), {}
+
+#set (:elasticsearch_apps) { }
+#set the path containing docker command
+#set (:docker_path) { "" }
+set (:docker_erb_templates) { true }
+#set (:docker_cleanup) { %w(yes 1 true).include? ENV.fetch("PRUNE", 'true') }
+#set (:auto_image_build){ %w(yes 1 true).include? ENV.fetch("BUILD_IMAGE", 'true') }
+
+require "capistrano/swarm_orca/deploy"
+require "capistrano/swarm_orca/docker"

data/lib/swarm_orca/templates/orca/capistrano/config/deploy/template_stage.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+server '${SERVER_NAME}', user: '${USER}',
+                         roles: %w[
+                           mysql
+                           rabbitmq
+                           nginx
+                           elasticsearch
+                           redis
+                           swarm_manager
+                         ]
+
+set :shared, network: fetch(:network)
+
+set :mysql,
+    stack_name: 'mysql',
+    mysql_docker_image: 'mysql',
+    mysql_docker_image_tag: '5.7',
+    mysql_volume: "#{fetch(:deploy_to)}/mysql"
+
+set :rabbitmq,
+    stack_name: 'rabbitmq',
+    rabbitmq_docker_image: 'rabbitmq',
+    rabbitmq_docker_image_tag: '3.6-management',
+    rabbitmq_volume: "#{fetch(:deploy_to)}/rabbitmq"
+
+set :nginx,
+    stack_name: 'nginx',
+    nginx_docker_image: 'nginx',
+    nginx_docker_image_tag: 'latest',
+    port_http: '80',
+    port_https: '443'
+
+set :redis,
+    stack_name: 'redis',
+    docker_image_prefix: 'docker.io/',
+    redis_docker_image: 'redis',
+    redis_docker_image_tag: 'latest',
+    nfs_mount: "#{fetch(:deploy_to)}/redis",
+    port: '6379'
+
+set :elasticsearch,
+    stack_name: 'elasticsearch',
+    elasticsearch_docker_image: 'elasticsearch',
+    elasticsearch_docker_image_tag: '5.4.0-alpine',
+    elastic_first_port: '9200',
+    elastic_second_port: '9300'
+
+set :errbit,
+    stack_name: 'errbit',
+    errbit_docker_image: 'docker.io/errbit/errbit',
+    errbit_db_docker_image: 'mongo',
+    errbit_docker_image_tag: 'latest',
+    errbit_db_docker_image_tag: '3.2',
+    errbit_host: '${ERRBIT_HOST}',
+    errbit_protocol: 'http',
+    errbit_port: '80',
+    ldap_host: '${LDAP_HOST}',
+    ldap_user: '${LDAP_USER}',
+    ldap_password: '${LDAP_PASSWORD}',
+    http_proxy: '${HTTP_PROXY}',
+    https_proxy: '${hTTPS_PROXY}',
+    no_proxy: '${NO_PROXY}',
+    mongo_volume: "#{fetch(:deploy_to)}/mongo"