shiplane 0.1.16 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 847be5563eac5f1b7d49c018a662a77d065d31022a1edf22bfeb347526459ada
-  data.tar.gz: ca5d1d1635161bd9cf4a5286fb2b42a13886ecd5b65df934f5dec5a560b7902e
+  metadata.gz: 50eae2e296a334c2af2f5ea208d46aabccef50b18d689d60756992086e545a36
+  data.tar.gz: 01763e335f6cae1046cc3808af25b0deeb657de21e52e3721e8b3d46361cf6d4
 SHA512:
-  metadata.gz: 9109eed0795ebb3211b118563c89781f621b2bde7c16c38131c1d0b8f62075f1ed3a55da3a5a23ca584e75b211c237f1de4905b0d5bb0e7a17205e659c3d9b56
-  data.tar.gz: c07ff2c9e6bf6d68f2f983fa8497c2f7128533e34b986eb765d4aa7ea114eada3df65a20ec91d1e27f55c783ed01ad9c6206fc71225ec8a3d341a6a338ead732
+  metadata.gz: ce597515a61d717166c1508e99013b329c40114d9481d0067da045eec1519ee7b39211646cdccd388bae32f2b5c6c1c9dffbf59f29985225e2e7958132758350
+  data.tar.gz: 17be9eabc9af8c6f5425802a994f61cee4aa5084f63875ad5f10d4028669598b8b5d344a16151c0c054456b9e91d063aec506f1d6772e115b85fd2a50bf78bcb

data/README.md

@@ -164,6 +164,11 @@ Shiplane::SafeBuild.wrap do
 end
 ```
 
+#### Using Build Cache
+Shiplane is designed to always build using the --no-cache flag in order to guaranteee clean, repeatable builds, but if you find yourself troubleshooting or otherwise needing to build multiple times, you might like to use the following flag to speed up the process. Note that this is intended to be a debugging tool. Using it for production building could potentially part of the build process to run in one context and another part to run in another. Such a case might cause both positive and negative results that are difficult to troubleshoot because they are not repeatable. Don't do this, but DO use this responsibly to make your life easier when troubleshooting.
+
+`USE_BUILD_CACHE=true bundle exec cap production shiplane`
+
 ## Becoming Involved
 ### Community Channels
 You can join our [Discord community](https://discord.gg/drrn2YG) to ask any questions you might have or to get ahold of someone in the community who might be able to help you (I hang out here just about every day of the week and most of the weekend). There is no guarantee of service implied, but we absolutely believe in helping out our fellow developers and will do so as we are able. If you feel you know some stuff about Shiplane, feel free to hang out and please help out as well!

data/lib/generators/shiplane/install/templates/deploy.rb.erb

@@ -8,7 +8,7 @@ lock '3.11.0'
 set :application, 'podcaster'
 set :repo_url, 'git@github.com:kirillian/podcaster.git'
 
-set :deploy_to, '/var/www/battlecryforfreedom'
+set :deploy_to, '/var/www/my_app_network'
 
 # Default value for :log_level is :debug
 # set :log_level, :debug
@@ -54,8 +54,21 @@ set :sha, `git rev-parse HEAD`.chomp
 set :shiplane_docker_registry_username, ENV['DOCKERHUB_USERNAME']
 set :shiplane_docker_registry_password, ENV['DOCKERHUB_PASSWORD']
 
+
+set :shiplane_build_environment_variables, {
+  # The following example Fetches RAILS_ENV from your Capistrano environment-specific configuration
+  # RAILS_ENV: proc { fetch(:rails_env, 'production') },
+}
+
+# The following setting points shiplane to Github's Registry
+# set :shiplane_docker_registry_url, 'ghcr.io'
+
+# The following settings assign the username and token/password needed to login to a given registry
+# set :shiplane_docker_registry_username, ENV['SHIPLANE_CONTAINER_REGISTRY_USERNAME']
+# set :shiplane_docker_registry_token, ENV['SHIPLANE_CONTAINER_REGISTRY_TOKEN']
+
 set :shiplane_networks, {
-  battlecryforfreedom: {
+  my_app_network: {
     connections: [
       "nginx_reverse_proxy",
       "nginx-proxy-letsencrypt",
@@ -65,28 +78,28 @@ set :shiplane_networks, {
 
 set :shiplane_containers, {
   app: {
-    alias: 'battlecryforfreedom-app',
+    alias: 'my_app-app',
     volumes: [],
     environment: [],
     expose: 3000,
     capistrano_role: "docker",
-    repo: "kirillian2/podcaster",
+    repo: "my_docker_repo_account_name/my_docker_repo",
     command: 'bin/start',
-    virtual_host: "battlecryforfreedom.com",
-    letsencrypt_email: "john.epperson@battlecryforfreedom.com",
+    virtual_host: "my_app.com",
+    letsencrypt_email: "john.epperson@my_app_network.com",
     networks: [
-      "battlecryforfreedom"
+      "my_app_network"
     ],
   },
   sidekiq: {
-    alias: 'battlecryforfreedom-sidekiq',
+    alias: 'my_app-sidekiq',
     volumes: [],
     environment: [],
     capistrano_role: "docker",
-    repo: "kirillian2/podcaster",
+    repo: "my_docker_repo_account_name/my_docker_repo",
     command: 'bin/start_sidekiq_workers',
     networks: [
-      "battlecryforfreedom"
+      "my_app_network"
     ],
   },
   redis: {
@@ -101,22 +114,37 @@ set :shiplane_containers, {
     repo: "redis",
     tag: "4.0.9-alpine",
     networks: [
-      "battlecryforfreedom"
+      "my_app_network"
     ],
+    deploy: {
+      # This setting will tell shiplane NOT to restart this container every deploy
+      restart: false,
+    },
   },
   postgres: {
     alias: 'postgres',
     volumes: [
       "/var/lib/postgres/data:/var/lib/postgresql/data",
     ],
+    environment: {
+      POSTGRES_PASSWORD: ENV['DATABASE_PASSWORD'],
+      POSTGRES_USER: ENV['DATABASE_USERNAME'],
+    },
+    flags: {
+      'shm-size' => '256MB',
+    },
     expose: 5432,
     publish: 5432,
     capistrano_role: "docker",
     repo: "postgres",
     tag: "9.6",
     networks: [
-      "battlecryforfreedom"
+      "my_app_network"
     ],
+    deploy: {
+      # This setting will tell shiplane NOT to restart this container every deploy
+      restart: false,
+    },
   },
 }
 

data/lib/generators/shiplane/install/templates/production_dockerfile_stages.erb

@@ -6,6 +6,8 @@ COPY . $APP_PATH
 
 WORKDIR $APP_PATH
 
+ARG RAILS_ENV production
+ENV RAILS_ENV $RAILS_ENV
 ARG GITHUB_TOKEN
 ENV GITHUB_TOKEN $GITHUB_TOKEN
 ENV SHIPLANE building
@@ -36,7 +38,8 @@ WORKDIR $APP_PATH
 RUN bundle config --local path vendor/bundle
 RUN bundle config --local without development:test:assets
 
-ENV RAILS_ENV production
+ARG RAILS_ENV production
+ENV RAILS_ENV $RAILS_ENV
 ENV SHIPLANE running
 ENV RAILS_LOG_TO_STDOUT true
 ENV RAILS_SERVE_STATIC_FILES true

data/lib/generators/shiplane/install/templates/shiplane.yml.erb

@@ -6,9 +6,12 @@ project:
 bootstrap:
   env_file: .env.production
   chef-bootstrapper:
-    package_name: chefdk_3.6.57-1_amd64.deb
-    package_url: https://packages.chef.io/files/stable/chefdk/3.6.57/ubuntu/18.04/chefdk_3.6.57-1_amd64.deb
+    package_name: chefdk_3.13.1-1_amd64.deb
+    package_url: https://packages.chef.io/files/stable/chefdk/3.13.1/ubuntu/16.04/chefdk_3.13.1-1_amd64.deb
 build:
+  registry:
+    # url: ghcr.io # for Github Container Service. Should work for similar services such as Gitlab
+    # url: :dockerhub # for default Dockerhub Service
   settings_folder: .shiplane
   environment_file: .env.production
   compose_filepath: docker-compose.yml
@@ -31,9 +34,9 @@ build:
       - services.container-name.depends_on
 deploy:
   servers:
-    # put the server domain or ip address here
+    # `server-url` is your server domain or ip address here (e.g. `12.345.67.89` or `myapp.com`)
     server-url:
-      # Only set this flag if you need docker to run as the sudo user (default Ubuntu AMI on AWS requires this)
+      # Only set this flag if you need docker to escalate permissions and run everything as sudo (default Ubuntu AMI on AWS requires this)
       requires_sudo: false
       # Put SSH options here
       # ssh_options:

data/lib/shiplane/build.rb

@@ -19,8 +19,99 @@ module Shiplane
       @postfix = postfix
 
       Dotenv.overload File.join(Dir.pwd, build_config.fetch('environment_file', '.env'))
+
+      # Add any ENV variable overrides from the capistrano configuration
+      environment_variable_overrides = fetch(:shiplane_build_environment_variables, {})
+      environment_variable_overrides.each do |key, value|
+        if value.is_a? Proc
+          ENV[key.to_s] = value.call
+        else
+          ENV[key.to_s] = value
+        end
+      end
     end
 
+    def build!
+      unless File.exist?(File.join(project_folder, Shiplane::SHIPLANE_CONFIG_FILENAME))
+        Shiplane::CheckoutArtifact.checkout!(sha)
+        Shiplane::ConvertComposeFile.convert_output!(project_folder, sha)
+      end
+
+      buildable_artifacts.each do |(artifact_name, attributes)|
+        compose_context = docker_config.fetch('services', {}).fetch(artifact_name.to_s, {})
+        Shiplane::ConvertDockerfile.convert_output!(project_folder, attributes, compose_context)
+
+        FileUtils.cd project_folder do
+          steps(artifact_name, attributes).select{|step| step.fetch(:condition, true) }.each do |step|
+            puts step[:notify_before] if step.has_key? :notify_before
+            success = system(step[:command])
+            raise StepFailureException.new(step[:command], artifact_name) unless success
+            puts step[:notify_after] if step.has_key? :notify_after
+          end
+        end
+      end
+    rescue StepFailureException => e
+      puts e.message
+      raise if ENV['RAISE_EXCEPTIONS_ON_FAILED_BUILD']
+    end
+
+    def steps(artifact_name, attributes)
+      [
+        { command: build_command(artifact_name), notify_before: "Building Artifact: #{artifact_name}...", notify_after: "Docker Compose Built", stop_on_failure: true },
+        { command: tag_command(artifact_name, attributes, sha), notify_before: "Tagging Build [#{sha}]...", stop_on_failure: true },
+        { command: tag_command(artifact_name, attributes, "#{postfix}-#{sha}"), notify_before: "Tagging Build [#{postfix}-#{sha}]...", stop_on_failure: true, condition: !!postfix },
+        { command: tag_command(artifact_name, attributes, "#{postfix}-latest"), notify_before: "Tagging Build [#{postfix}-latest]...", stop_on_failure: true, condition: !!postfix && tag_latest },
+        { command: tag_command(artifact_name, attributes), notify_before: "Tagging Build [latest]...", stop_on_failure: true, condition: tag_latest },
+        { command: token_login_command , notify_before: "Logging into Container Registry...", stop_on_failure: true },
+        { command: push_command(attributes, "#{sha}"), notify_before: "Pushing Image", notify_after: "Completed Artifact: #{artifact_name}...", stop_on_failure: true },
+        { command: push_command(attributes, "#{postfix}-#{sha}"), notify_before: "Pushing #{postfix} Image", notify_after: "Completed Artifact: #{artifact_name}...", stop_on_failure: true, condition: !!postfix },
+        { command: push_command(attributes, "#{postfix}-latest"), notify_before: "Pushing Latest #{postfix} Image", notify_after: "Completed Latest Artifact: #{artifact_name}...", stop_on_failure: true, condition: !!postfix && tag_latest },
+        { command: push_command(attributes, "latest"), notify_before: "Pushing Latest Image", notify_after: "Completed Latest Artifact: #{artifact_name}...", stop_on_failure: true, condition: tag_latest },
+      ]
+    end
+
+    # Commands
+    def build_command(artifact_name)
+      [
+        'docker-compose',
+        'build',
+        build_cache_option,
+        artifact_name,
+      ].compact.join(' ')
+    end
+
+    def token_login_command
+      @token_login_command ||= [
+        'echo',
+        "\"#{login_token}\"",
+        '|',
+        'docker',
+        'login',
+        registry_url,
+        '--username',
+        login_username,
+        '--password-stdin',
+      ].compact.join(' ')
+    end
+
+    def tag_command(artifact_name, attributes, tag='latest')
+      [
+        'docker',
+        'tag',
+        build_output_image_name(artifact_name),
+        "#{repo_name(attributes)}:#{tag}",
+      ].compact.join(' ')
+    end
+
+    def push_command(attributes, tag='latest')
+      [
+        'docker',
+        'push',
+        "#{repo_name(attributes)}:#{tag}",
+      ].compact.join(' ')
+    end
+
+    # Properties
     def appname
       @appname ||= project_config['appname']
     end
@@ -45,44 +136,57 @@ module Shiplane
       build_config.fetch('artifacts', {})
     end
 
-    def build!
-      unless File.exist?(File.join(project_folder, Shiplane::SHIPLANE_CONFIG_FILENAME))
-        Shiplane::CheckoutArtifact.checkout!(sha)
-        Shiplane::ConvertComposeFile.convert_output!(project_folder, sha)
-      end
+    def default_registry_configuration
+      {
+        'url' => :dockerhub,
+        'auth_method' => 'token',
+      }
+    end
 
-      buildable_artifacts.each do |(artifact_name, attributes)|
-        compose_context = docker_config.fetch('services', {}).fetch(artifact_name.to_s, {})
-        Shiplane::ConvertDockerfile.convert_output!(project_folder, attributes, compose_context)
+    def dockerhub?
+      registry_configuration['url'] == :dockerhub
+    end
 
-        FileUtils.cd project_folder do
-          steps(artifact_name, attributes).select{|step| step.fetch(:condition, true) }.each do |step|
-            puts step[:notify_before] if step.has_key? :notify_before
-            success = system(step[:command])
-            raise StepFailureException.new(step[:command], artifact_name) unless success
-            puts step[:notify_after] if step.has_key? :notify_after
-          end
-        end
-      end
-    rescue StepFailureException => e
-      puts e.message
-      raise if ENV['RAISE_EXCEPTIONS_ON_FAILED_BUILD']
+    def token_auth?
+      registry_configuration['auth_method'] == 'token'
     end
 
-    def steps(artifact_name, attributes)
+    def registry_configuration
+      @registry_configuration ||= default_registry_configuration.merge(build_config.fetch('registry', {}))
+    end
+
+    def registry_url
+      @registry_url ||= dockerhub? ? nil : registry_configuration['url']
+    end
+
+    def repo_name(attributes)
       [
-        { command: "docker-compose build --no-cache #{artifact_name}", notify_before: "Building Artifact: #{artifact_name}...", notify_after: "Docker Compose Built", stop_on_failure: true },
-        { command: "docker tag #{attributes['repo']}:#{sha} #{attributes['repo']}:#{postfix}-#{sha}", notify_before: "Tagging Build...", stop_on_failure: true, condition: !!postfix },
-        { command: "docker tag #{attributes['repo']}:#{sha} #{attributes['repo']}:#{postfix}-latest", notify_before: "Tagging Build...", stop_on_failure: true, condition: !!postfix && tag_latest },
-        { command: "docker tag #{attributes['repo']}:#{sha} #{attributes['repo']}:latest", notify_before: "Tagging Latest Build...", stop_on_failure: true, condition: tag_latest },
-        { command: "echo '#{ENV['DOCKERHUB_PASSWORD']}' | docker login --username #{ENV['DOCKERHUB_USERNAME']} --password-stdin", notify_before: "Logging into DockerHub...", stop_on_failure: true },
-        { command: "docker push '#{attributes['repo']}:#{sha}'", notify_before: "Pushing Image", notify_after: "Completed Artifact: #{artifact_name}...", stop_on_failure: true },
-        { command: "docker push '#{attributes['repo']}:#{postfix}-#{sha}'", notify_before: "Pushing #{postfix} Image", notify_after: "Completed Artifact: #{artifact_name}...", stop_on_failure: true, condition: !!postfix },
-        { command: "docker push '#{attributes['repo']}:#{postfix}-latest'", notify_before: "Pushing Latest #{postfix} Image", notify_after: "Completed Latest Artifact: #{artifact_name}...", stop_on_failure: true, condition: !!postfix && tag_latest },
-        { command: "docker push '#{attributes['repo']}:latest'", notify_before: "Pushing Latest Image", notify_after: "Completed Latest Artifact: #{artifact_name}...", stop_on_failure: true, condition: tag_latest },
-      ]
+        registry_url,
+        attributes['repo'],
+      ].compact.join('/')
+    end
+
+    def login_token
+      return ENV['DOCKERHUB_PASSWORD'] if dockerhub? && token_auth?
+
+      ENV['SHIPLANE_CONTAINER_REGISTRY_TOKEN']
+    end
+
+    def login_username
+      return ENV['DOCKERHUB_USERNAME'] if dockerhub? && token_auth?
+
+      ENV['SHIPLANE_CONTAINER_REGISTRY_USERNAME']
+    end
+
+    def build_output_image_name(artifact_name)
+      @build_output_image_name ||= "#{appname}-#{sha}_#{artifact_name}:latest"
+    end
+
+    def build_cache_option
+      ENV['USE_BUILD_CACHE'] == 'true' ? nil : "--no-cache"
     end
 
+    # API Helper Methods
     def self.build!(sha, postfix = nil)
       new(sha, postfix: postfix).build!
     end

data/lib/shiplane/convert_compose_file.rb

@@ -32,10 +32,6 @@ module Shiplane
 
     def converted_output
       @converted_output ||= converted_compose_hash.dup.tap do |hash|
-        build_config.fetch('artifacts', {}).each do |(appname, config)|
-          hash.deep_merge!({ 'services' => { appname => { 'image' => "#{config['repo']}:#{sha}" } } })
-        end
-
         hash.traverse! do |key, value|
           if (key == 'env_file' && value == '.env.development')
             [key, '.env.production']

data/lib/shiplane/deploy/container_configuration.rb

@@ -64,7 +64,7 @@ module Shiplane
       end
 
       def network_connect_commands(role)
-        @network_commands ||= networks.map do |network|
+        @network_commands ||= networks[1..-1].map do |network|
           [
             docker_command(role),
             "network connect",
@@ -84,6 +84,8 @@ module Shiplane
           published_ports.map{|port| "-p #{port}" },
           exposed_ports.map{|port| "--expose #{port}" },
           "--name #{unique_container_name}",
+          "--network=#{networks.first}",
+          "--network-alias=#{network_alias}",
           virtual_host ? "-e VIRTUAL_HOST=#{virtual_host}" : nil,
           letsencrypt_host ? "-e LETSENCRYPT_HOST=#{letsencrypt_host}" : nil,
           letsencrypt_email ? "-e LETSENCRYPT_EMAIL=#{letsencrypt_email}" : nil,

data/lib/shiplane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shiplane
-  VERSION = "0.1.16"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiplane
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.2.4
 platform: ruby
 authors:
 - John Epperson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shiplane_bootstrappers_chef
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: shiplane_deployers_capistrano_docker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +156,7 @@ homepage: https://github.com/kirillian/shiplane
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A toolbox for converting developer docker-compose files into production-ready
   images.