Merge pull request #117 from code0-tech/109-container-orchestrator

Create orchestrator for system dependencies

Author: Taucher2003

.gitlab-ci.yml

@@ -140,6 +140,7 @@ boot:docker:
       -e SAGITTARIUS_DATABASE_PORT=5432
       -e SAGITTARIUS_REDIS_HOST=redis
       -e SAGITTARIUS_REDIS_PORT=6379
+      -e SAGITTARIUS_DISABLE_ORCHESTRATOR=true
       -e RAILS_ENV=production
       ghcr.io/code0-tech/sagittarius/ci-builds:${CI_COMMIT_SHA} &
     - >
@@ -154,3 +155,33 @@ boot:docker:
       --retry-delay 3
       --retry-connrefused
       http://sagittarius:3000/health/liveness
+
+boot:docker-orchestrated:
+  stage: test
+  image: docker:26.0.0-dind
+  variables:
+    DOCKER_HOST: unix:///var/run/docker.sock
+  script:
+    - /usr/local/bin/dockerd-entrypoint.sh &
+    - sleep 20
+    - docker network create sagittarius_default
+    - >
+      docker run
+      --name sagittarius
+      --network sagittarius_default
+      --network-alias sagittarius
+      -e RAILS_ENV=production
+      -v /var/run/docker.sock:/var/run/docker.sock
+      ghcr.io/code0-tech/sagittarius/ci-builds:${CI_COMMIT_SHA} &
+    - >
+      docker run
+      --rm
+      --network sagittarius_default
+      curlimages/curl:8.5.0
+      curl
+      --fail
+      -sv
+      --retry 20
+      --retry-delay 3
+      --retry-connrefused
+      http://sagittarius:3000/health/liveness

.rubocop.yml

@@ -17,6 +17,10 @@ Lint/AmbiguousBlockAssociation:
 Metrics/AbcSize:
   Enabled: false
 
+Metrics/BlockLength:
+  Exclude:
+    - lib/tasks/**/*
+
 Metrics/MethodLength:
   Enabled: false
 

Dockerfile

@@ -56,11 +56,6 @@ RUN apt-get update -qq && \
 COPY --from=build /usr/local/bundle /usr/local/bundle
 COPY --from=build /rails /rails
 
-# Run and own only the runtime files as a non-root user for security
-RUN useradd rails --create-home --shell /bin/bash && \
-    chown -R rails:rails db log storage tmp
-USER rails:rails
-
 # Entrypoint prepares the database.
 ENTRYPOINT ["/rails/bin/docker-entrypoint"]
 

Gemfile

@@ -74,3 +74,5 @@ gem 'sidekiq', '~> 7.1'
 gem 'lograge', '~> 0.14.0'
 
 gem 'declarative_policy', '~> 1.1'
+
+gem 'docker-api', '~> 2.2'

Gemfile.lock

@@ -102,9 +102,13 @@ GEM
     declarative_policy (1.1.0)
     diff-lcs (1.5.1)
     docile (1.4.0)
+    docker-api (2.2.0)
+      excon (>= 0.47.0)
+      multi_json
     drb (2.2.1)
     erubi (1.12.0)
     escape_utils (1.3.0)
+    excon (0.110.0)
     extended-markdown-filter (0.7.0)
       html-pipeline (~> 2.9)
     factory_bot (6.4.5)
@@ -153,6 +157,7 @@ GEM
     mini_mime (1.1.5)
     minitest (5.22.3)
     msgpack (1.7.2)
+    multi_json (1.15.0)
     mutex_m (0.2.0)
     net-imap (0.4.10)
       date
@@ -336,6 +341,7 @@ DEPENDENCIES
   database_cleaner-active_record (~> 2.1)
   debug
   declarative_policy (~> 1.1)
+  docker-api (~> 2.2)
   factory_bot_rails (~> 6.2)
   graphql (~> 2.1)
   graphql-docs (~> 4.0)

bin/docker-entrypoint

@@ -1,7 +1,22 @@
 #!/bin/bash -e
 
-# If running the rails server then create or migrate existing database
 if [ "${1}" == "./bin/rails" ] && [ "${2}" == "server" ]; then
+  if [ "${SAGITTARIUS_DISABLE_ORCHESTRATOR}" != "true" ]; then
+    # orchestrate dependencies
+    bundle exec rake \
+      orchestrator:start[postgresql] \
+      orchestrator:start[redis] \
+      orchestrator:await_healthy[postgresql,5] \
+      orchestrator:await_healthy[redis,5] \
+      orchestrator:connect_self
+
+    bundle exec rake orchestrator:debug
+
+    # create connection environment variables
+    eval $(bundle exec rake orchestrator:create_connection_environment[postgresql,redis])
+  fi
+
+  # prepare database
   bundle exec rake db:prepare
   FILTER=01_application_settings bundle exec rake db:seed_fu
 fi

config/initializers/application_settings.rb

@@ -2,7 +2,7 @@
 
 Rails.application.config.to_prepare do
   next unless Rails.env.production?
-  next if ARGV.grep(/db:/).any?
+  next if ARGV.grep(/db:|orchestrator:/).any?
 
   ApplicationSetting.assert_settings_present!
 end

lib/sagittarius/orchestrator/container.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Sagittarius
+  module Orchestrator
+    class Container
+      attr_accessor :internal_container
+
+      def image
+        raise NotImplementedError
+      end
+
+      def name
+        raise NotImplementedError
+      end
+
+      def cmd
+        nil
+      end
+
+      def environment_variables
+        []
+      end
+
+      def volumes
+        []
+      end
+
+      def ports
+        nil
+      end
+
+      def healthy?
+        return false if internal_container.nil?
+
+        internal_container.refresh!
+        internal_container.info['State']['Status'] == 'running'
+      end
+
+      def self.[](container)
+        Containers.const_get(container.capitalize).new
+      end
+    end
+  end
+end

lib/sagittarius/orchestrator/containers/postgresql.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Sagittarius
+  module Orchestrator
+    module Containers
+      class Postgresql < Container
+        def image
+          'postgres:16.1'
+        end
+
+        def name
+          'postgresql'
+        end
+
+        def environment_variables
+          config = ActiveRecord::Base.connection_db_config.configuration_hash
+
+          %W[
+            POSTGRES_USER=#{config[:username]}
+            POSTGRES_PASSWORD=#{config[:password]}
+            POSTGRES_DB=#{config[:database]}
+          ]
+        end
+
+        def volumes
+          {
+            data: '/var/lib/postgresql/data/',
+          }
+        end
+
+        def ports
+          {
+            '5432/tcp' => [{ 'HostIp' => '127.0.0.1', 'HostPort' => '5433' }],
+          }
+        end
+
+        def healthy?
+          # exec returns [[stdout], [], exit_code]
+          super && internal_container.exec(%w[pg_isready]).last.zero?
+        end
+
+        def orchestrator_connection_details
+          return {} unless healthy?
+
+          {
+            SAGITTARIUS_DATABASE_HOST: internal_container.info['Name'].delete_prefix('/'),
+            SAGITTARIUS_DATABASE_PORT: 5432,
+          }
+        end
+      end
+    end
+  end
+end

lib/sagittarius/orchestrator/containers/redis.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sagittarius
+  module Orchestrator
+    module Containers
+      class Redis < Container
+        def image
+          'redis:7.2.3-alpine'
+        end
+
+        def name
+          'redis'
+        end
+
+        def cmd
+          %w[redis-server --save 1 1 --loglevel warning]
+        end
+
+        def volumes
+          {
+            data: '/data',
+          }
+        end
+
+        def ports
+          {
+            '6379/tcp' => [{ 'HostIp' => '127.0.0.1', 'HostPort' => '6380' }],
+          }
+        end
+
+        def orchestrator_connection_details
+          return {} unless healthy?
+
+          {
+            SAGITTARIUS_REDIS_HOST: internal_container.info['Name'].delete_prefix('/'),
+            SAGITTARIUS_REDIS_PORT: 6379,
+          }
+        end
+      end
+    end
+  end
+end