stack_car 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be5319f55289a7290898afd746925c52ca00abd632f8c8bb15bc9fd9ef42b91b
-  data.tar.gz: 5fc7e21e1ff7bb056ddcdfe2fd35da741f5d0d27e9f7491ce7dee44483a2e50f
+  metadata.gz: 80132883ba506f9cf4414a46f560a2040e8843596b7a94e3d6f9baab6ae3a4d4
+  data.tar.gz: bb84c75a79f699e7bb04aa877eaed36f3acb9e8c8d9bf294d9f4fa7bbe579ddc
 SHA512:
-  metadata.gz: e911986bdbecd0848db4a0987eb631f52d0e76271c67f06761a0364332db693c25bf0f34911169dd9a2caeb907c74e095d98a6352d1fc9264cacf15dddef1cf2
-  data.tar.gz: 3a8790e739b56f07648edb147f9dd2dde7e77875c3b45ccadb342d243880ceee34a97f5e1da236d2204a65778409c26a196c74c08c87e906a7297bc81829aac6
+  metadata.gz: 1e03c8620fcd08038774e75c2cfeefa75a2bae7d42708c0240c774e3584391695a87349c50bba6b0c7b444e46e66d73b2e96b1439bbf09f0104670b83e3fb831
+  data.tar.gz: 3196614e6fd6ce06b7408aa292e4ae0b19ef57aa9df8643899fcf378ad840a2d4d469695010ca04948676b9a46b7b655947cbaa0bf686c59c27b3b385b73341a

data/.gitlab-ci.yml

@@ -1,17 +1,22 @@
-image: ruby:2.3
+stages:
+  - rspec 
 
 before_script:
-  bundle
+  - bundle
 
-pages:
-  script:
-  - bundle exec yardoc --plugin yard-thor -o public - templates/.* templates/* 
-  artifacts:
-    paths:
-    - public
-  only:
-  - master 
+# pages:
+#   script:
+#   - bundle exec yardoc --plugin yard-thor -o public - templates/.* templates/* 
+#   artifacts:
+#     paths:
+#     - public
+#   only:
+#   - master 
 
-test:
+rspec:
+  stage: rspec
+  image: ruby:2.3
   script:
-    bundle exec rake
+    - bundle exec rspec
+  tags:
+    - docker

data/README.md

@@ -4,6 +4,13 @@
 
 Stack Car is an opinionated set of tools around Docker and Rails.  It provides convenent methods to start and stop docker-compose, to deploy with rancher and a set of templates to get a new Rails app in to docker as quickly as possible.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Development](#development)
+- [Dockerizing an Application](#dockerizing-an-application)
+- [Generating a Helm Chart](#generating-a-helm-chart)
 
 ## Installation
 
@@ -54,6 +61,58 @@ Developing stack_car often requires a rails application for you to run updated c
 - Run `bundle exec rake release`
   - This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Dockerizing an application
+
+Dockerizing your application with stack_car can be thought of in 2 steps:
+- **Generate the file templates**
+- **Customize provided templates to the requirements of the application**
+
+### Generate templates (`sc dockerize`)
+You can generate requisite files for running your application for local development in Docker with the **dockerize** command.
+
+To **dockerize** your application:
+- `cd` into your project dir
+- Run `sc dockerize` to generate files, appending **service flags** to scaffold any other services your application requires
+  - **For example**:
+    - For rails/postgres: `sc dockerize --postgres`
+    - For rails/mysql/redis: `sc dockerize --mysql --redis`
+
+This command will provide:
+- `Dockerfile`
+- `docker-compose.yml`
+- `.env*` files
+-  **ops** files to get you set up for running your application with **nginx**.
+
+### Customize templates
+
+stack_car will have provided sensible defaults for your services but customization will be required per needs of each project (ie api tokens and email configuration where applicable).
+
+**Customization workflow**
+- Do a text search to find and replace any instances `CHANGEME` in the generated files
+- Add any **general environment variables** to `.env`
+  - This sets defaults for all docker compose environments
+- Add any **development environment variables** to `.env.development` 
+  - These set up any new values or overrides specific to your development env
+- Run `sc build` to build your image
+  - On failed build, browse the terminal output to track down and squash any misconfigurations. Rebuild
+- Upon successful build, run `sc up` to spin up project
+  - If you get errors, browse the terminal output to track down and squash any misconfigurations (refer to the Docker dashboard to see separate logs for each service)
+- Visit site at `localhost:3000`
+  - Alternatively, visit it at the host you have specified to work with **Dory**
+- **Note**: *Depending on the DB required by your application, you will need to create the DB. You need to do that within from the container:*
+  - Using the `bundle-exec` command: `sc bundle-exec db:create`
+  - Shelling in and running in the container shell:
+  ```bash
+      sc exec bash
+      bundle exec rails db:create
+  ```
+
+Once all services are running and speaking to each other you are good to go.
+
+**Tips**:
+- Any changes to `Dockerfile` will require `sc build` for the changes to manifest
+- Changes to `docker-compose.yml` **do not require rebuild unless you have changed the image**
+
 ## Generating a Helm Chart
 
 stack_car's **dockerize** command can be used in conjunction with available flags to generate a **Helm chart** template for your application. You will need to create the *values* files with necessary configuration values from the *sample-values* provided by stack_car, but the command will effectively give you the baseline Notch8 template (scripts, template files, template helpers, sample values file) for a **Helm base Kubernetes deploy**
@@ -88,15 +147,14 @@ Since values files are likely to contain sensitive information like API keys, th
 
 Example workflow (given values file is already created):
 - Edit values file
-- `chart/bin/encrypt staging <keybase-team-name>`
-  - This command will create `staging-values.yaml.enc`
-- `git add staging-values.yaml.enc`
+- `bin/encrypt-secrets`
+  - This command will create/update `staging-values.yaml.enc`
 - Commit and push
 
 When pulling down a repo or branch, you will need to start by decrypting.
 
 Example:
-- `chart/bin/decrypt staging`
+- `bin/decrypt-secrets`
 
 ## Contributing
 

data/lib/stack_car/cli.rb

@@ -39,7 +39,55 @@ module StackCar
       run("#{dotenv} docker-compose stop #{options[:service]}")
       run_with_exit("rm -rf tmp/pids/*")
     end
-    map down: :stop
+
+    method_option :volumes, aliases: '-v'
+    method_option :rmi
+    method_option :'remove-orphans'
+    method_option :service, aliases: '-s'
+    method_option :timeout, aliases: '-t'
+    method_option :all, aliases: '-a'
+    method_option :help, aliases: '-h'
+    desc 'down', 'stops and removes containers and networks specific to this project by default, run with -h for more options'
+    def down
+      setup
+      ensure_development_env
+
+      if options[:help]
+        run('docker-compose down --help')
+        say 'Additional stack_car options:'
+        say '    -a, --all               Removes all containers, networks, volumes, and'
+        say '                            images created by `up`.'
+        say '    -s, --service           Specify a service defined in the Compose file'
+        say '                            whose containers and volumes should be removed.'
+        exit(0)
+      end
+
+      if options[:service]
+        rm_vol = true if options[:volumes]
+
+        remove_container(options[:service], rm_vol)
+        exit(0)
+      end
+
+      run_conf = 'Running down will stop and remove all of the Docker containers and networks ' \
+                 'defined in the docker-compose.yml file. Continue?'
+      prompt_run_confirmation(run_conf)
+
+      args = []
+      if options[:all]
+        prompt_run_confirmation('--all will remove all containers, volumes, networks, local images, and orphaned containers. Continue?')
+
+        args = %w[--volumes --rmi=local --remove-orphans]
+      else
+        args << '--volumes' if options[:volumes]
+        args << '--rmi=local' if options[:rmi]
+        args << '--remove-orphans' if options[:'remove-orphans']
+        args << '--timeout' if options[:timeout]
+      end
+
+      run("#{dotenv} docker-compose down #{args.join(' ')}")
+      run_with_exit('rm -rf tmp/pids/*')
+    end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
     desc "build", "builds specified service, defaults to web"
@@ -167,15 +215,15 @@ module StackCar
     method_option :helm, default: false, type: :boolean, aliases: '-h'
     method_option :git, default: false, type: :boolean, aliases: '-g'
     method_option :heroku, default: false, type: :boolean, aliases: '-h'
-    method_option :hyku, default: false, type: :boolean, aliases: '-u'
+    method_option :hyku, default: false, type: :boolean, aliases: "\--hu"
     method_option :imagemagick, default: false, type: :boolean, aliases: '-i'
-    method_option :memcached, default: false, type: :boolean, aliases: '-mc'
-    method_option :mongodb, default: false, type: :boolean, aliases: '-mg'
+    method_option :memcached, default: false, type: :boolean, aliases: "\--mc"
+    method_option :mongodb, default: false, type: :boolean, aliases: "\--mg"
     method_option :mysql, default: false, type: :boolean, aliases: '-m'
     method_option :postgres, default: false, type: :boolean, aliases: '-p'
-    method_option :rancher, default: false, type: :boolean, aliases: '-dr'
+    method_option :rancher, default: false, type: :boolean, aliases: "\--dr"
     method_option :redis, default: false, type: :boolean, aliases: '-r'
-    method_option :sidekiq, default: false, type: :boolean, aliases: '-sq' # TODO
+    method_option :sidekiq, default: false, type: :boolean, aliases: "\--sk"
     method_option :solr, default: false, type: :boolean, aliases: '-s'
     method_option :yarn, default: false, type: :boolean, aliases: '-y'
     desc 'dockerize DIR', 'Will copy the docker tempates in to your project, see options for supported dependencies'
@@ -218,9 +266,15 @@ module StackCar
        puts template_file
         template("#{template_file}.erb", template_file)
      end
-     template("database.yml.erb", "config/database.yml")
+     directory('.gitlab', '.gitlab')
      template(".env.development.erb", ".env.development")
      template(".env.erb", ".env.production")
+     template(".sops.yaml.erb", ".sops.yaml")
+     template("decrypt-secrets", "bin/decrypt-secrets")
+     template("encrypt-secrets", "bin/encrypt-secrets")
+     template("database.yml.erb", "config/database.yml")
+     template("development.rb.erb", "config/environments/development.rb")
+     template("production.rb.erb", "config/environments/production.rb")
 
      if File.exists?('README.md')
        prepend_to_file "README.md" do
@@ -272,7 +326,7 @@ module StackCar
     protected
     def compose_depends(*excludes)
       @compose_depends = []
-      services = [:postgres, :mysql, :elasticsearch, :solr, :redis, :mongodb, :memcached] - excludes
+      services = [:fcrepo, :postgres, :mysql, :elasticsearch, :sidekiq, :solr, :redis, :mongodb, :memcached] - excludes
       services.each do |service|
         if options[service]
           @compose_depends << "      - #{service}"
@@ -350,5 +404,77 @@ module StackCar
       end
       DotRc.new
     end
+
+    def remove_container(service_name, remove_volumes)
+      container = find_container_by_service(service_name)
+
+      container.map do |id, name|
+        prompt_run_confirmation("Remove #{name} container?")
+
+        if `docker container ls --format "{{.Names}}"`.include?(name)
+          say 'Stopping container...'
+          `docker stop #{id}`
+        end
+
+        say 'Removing container...'
+        `docker container rm #{id}`
+
+        # Ensure container was removed
+        if `docker ps -aqf id=#{id}`.empty?
+          say "  Container #{name} was removed"
+        else
+          say ">>> There was an issue removing container #{name} (#{id})"
+        end
+      end
+
+      remove_volumes_mounted_to_container(@container_volume_names) if remove_volumes
+    end
+
+    def find_container_by_service(service_name)
+      container_id = `docker-compose ps -aq #{service_name}`.strip
+
+      if container_id.empty?
+        say "Unable to locate a container for the service '#{service_name}'"
+        say "Try running `docker-compose ps #{service_name}` to make sure the container exists"
+        exit(1)
+      end
+
+      get_volume_names_for_container(container_id)
+      container_name = `docker ps -af id=#{container_id} --format "{{.Names}}"`.strip
+
+      { container_id => container_name }
+    end
+
+    def remove_volumes_mounted_to_container(volumes)
+      return if volumes.empty?
+
+      prompt_run_confirmation("\n#{volumes.join("\n")}\nRemove these volume(s)?")
+      volumes.each do |v|
+        say 'Removing volume...'
+        `docker volume rm #{v}`
+
+        if `docker volume ls -q`.include?(v)
+          say ">>> There was an issue removing volume #{v}"
+        else
+          say "  Volume #{v} was removed"
+        end
+      end
+    end
+
+    def get_volume_names_for_container(container_id)
+      @container_volume_names ||= []
+      return @container_volume_names unless @container_volume_names.empty?
+
+      JSON.parse(`docker inspect --format="{{json .Mounts}}" #{container_id}`).map do |mount_info|
+        @container_volume_names << mount_info['Name'] if mount_info['Type'] == 'volume'
+      end
+
+      @container_volume_names
+    end
+
+    def prompt_run_confirmation(question)
+      response = ask(question, limited_to: %w[y n])
+      exit(1) unless response == 'y'
+    end
   end
 end

data/lib/stack_car/version.rb

@@ -1,3 +1,3 @@
 module StackCar
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/stack_car.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "yard"

data/templates/.env.erb

@@ -2,6 +2,20 @@ APP_NAME=<%= @project_name %>
 PASSENGER_APP_ENV=development
 REGISTRY_HOST=registry.gitlab.com
 REGISTRY_URI=/CHANGEME/<%= @project_name %>
+
+# SMTP Mailer variables
+# To enable mailer:
+# - Uncomment and edit SMTP vars
+# - Uncomment SMTP Mailer section in respective config/environments file
+# SMTP_USER_NAME=CHANGEME
+# SMTP_PASSWORD=CHANGEME
+# SMTP_ADDRESS=CHANGEME
+# SMTP_DOMAIN=CHANGEME
+# SMTP_PORT=CHANGEME
+# SMTP_TYPE=CHANGEME
+<% if options[:hyku] %>
+# SETTINGS__MULTITENANCY__ADMIN_HOST=CHANGEME
+<% end %>
 TAG=dev
 <% if options[:postgres] -%>
 DATABASE_NAME=<%= @project_name %>

data/templates/.gitlab/issue_templates/Bug.md

@@ -0,0 +1,46 @@
+ # Summary
+
+A short description of the bug. Use # to link to the parent issue or merge request
+
+# Observed Behavior
+
+The current, bugged behavior.
+
+# Expected Behavior
+
+How it should behave once it's fixed. What "done" looks like.
+
+# Screenshots or Video
+
+Include screenshots or videos that demonstrate the bug
+
+# Other Information
+
+Any other logs, related issues, merge requests, wireframes, documentation, slack conversations or anything else that would help the developer try to find and fix this issue, or provide context.
+
+# Acceptance Criteria
+
+This is what done looks like. A higher level checklist of the goals and functionality after this bug is fixed
+
+* [ ] I see these views
+* [ ] When a user does this, that happens
+
+# Steps to Reproduce / Testing Instructions
+
+How did you trigger this bug? Include links to the page where the error occured, if applicable. 
+
+* [ ]  As a (logged in/admin/etc) User
+* [ ]  With these other conditions
+* [ ]  I did these things
+* [ ]  And observed this behavior
+
+## Further information
+
+Edit in any later issues or merge requests that are conencted to this issue, for future reference
+
+### Implementation suggestions
+
+Are nice, but should probably go in a comment. e.g. gems, unrelated issues that dealt with similar problems, stack overflow links.
+
+/label ~"Needs Rework", ~"Ready for Development"
+<!-- By default, should bugs go to Ready for development, to be on the development board, or be like normal issues and go to the planning board> -->

data/templates/.gitlab/issue_templates/Feature.md

@@ -0,0 +1,41 @@
+# Summary
+
+A short description of the feature
+
+# User Stories
+
+What problem is this feature going to solve? 
+
+# Screenshots or Video
+
+Include any relevant media such as wireframes, screenshots, or videos
+
+# Relationships
+
+Are there any other issues or merge requests that are related to this feature (use # to generate a quick link). In particular, is this part of a larger epic, or does it depend on any other tickets being resolved first? Do you need anything else or are you making any other assumptions for this feature?
+
+# Acceptance Criteria
+
+This is what done looks like. A higher level checklist of the goals and functionality of this feature
+
+* [ ] I see these views
+* [ ] When a user does this, that happens
+  
+# Testing Instructions
+
+Steps to demonstrate this feature is properly working. Include a video, if possible. The How to the Acceptance Criteria's What
+
+* [ ] As a (user/admin)
+* [ ] Go here and do these things
+* [ ] To see this happen
+
+
+## Further information
+
+Edit in any later issues or merge requests that are conencted to this issue, for future reference
+
+### Implimentation Suggestions
+
+Any development details that would be helpful when working on this feature e.g. gems, unrelated issues that dealt with similar problems, stack overflow links.
+
+/label ~Icebox

data/templates/.gitlab/issue_templates/Question.md

@@ -0,0 +1,18 @@
+# Summary
+A short description of the question.
+
+## Who has this information
+Consider using @ to tag them, if they're in this repository
+
+# Additional information
+More details about what needs to be answered
+* [ ] Checkboxes are helpful
+* [ ] To make sure all answers are enumerated
+
+# Other links
+Pictures, videos, links to issues, or anything else that might be helpful to provide context for the question
+
+/label ~"Planning in Progress"
+
+/assign me
+<!-- this might cause inboxes to explode, but presumably the one creating a question ticket would be the one who was taking ownership for it, and would be the one responsible for cleaning it up once the question was answered -->

data/templates/.gitlab/merge_request_templates/Bug.md

@@ -0,0 +1,36 @@
+# Summary 
+A short description of the bug
+
+# Related Issue
+Use # to add a quick link to the parent issue(s), or ! for parent merge requests. Also, go to the issue and edit it to mention this MR.
+
+# Expected Behavior
+
+Demo how this merge request is working in the app. Consult the steps for reproducing the bug in the issue. 
+
+# Screenshots / Video
+Include screenshots or video demonstrating how this bug fix works
+
+# Dependencies
+
+Are there any other outstanding issues which need to be resolved before this can be merged?
+
+# Special Attention / Side Effects
+
+Is there anything you would like to have special scrutiny given to during code review? Will the changes in this merge request potentially impact any thing else that isn't explicitly part of this bug fix?
+
+# Testing / Reproduction instructions
+
+Step by step instructions on how to test this bug fix. Include links and username/passswords if necessary. Videos are especially helpful. Also, name any spec files that should be run for this bug fix, or to test any side effects from this bug fix.
+
+1. Go here
+2. Do this
+3. Observe this behavior
+
+# Deployment
+
+Where is this deployed? Are there any additional steps to get this working on staging/production? (e.g. setting up enviromental variables)
+
+# Other Information
+
+Any other logs, related issues, merge requests, wireframes, documentation, slack conversations or anything else that would help the developer try to find and fix this issue, or provide context.

data/templates/.gitlab/merge_request_templates/Feature.md

@@ -0,0 +1,36 @@
+# Summary 
+A short description of the feature
+
+# Related Issue
+Use # to add a quick link to the parent issue(s), or ! for parent merge requests. Also, go to that issue and edit the description to mention this MR.
+
+# Expected Behavior
+
+Demo how this merge request is working in the app. Consult the acceptance criteria in the issue. 
+
+# Screenshots / Video
+Include screenshots or video demonstrating how this feature works
+
+# Dependencies
+
+Are there any other outstanding issues which need to be resolved before this can be merged?
+
+# Special Attention / Side Effects
+
+Is there anything you would like to have special scrutiny given to during code review? Will the changes in this merge request potentially impact any thing else that isn't explicitly part of this feature? 
+
+# Testing / Reproduction instructions
+
+Step by step instructions on how to test this feature. Include links and username/passswords if necessary. Videos are especially helpful. Also, name any spec files that should be run for this feature, or to test any side effects from this feature.
+
+1. Go here
+2. Do this
+3. Observe this behavior
+
+# Deployment
+
+Where is this deployed? Are there any additional steps to get this working on staging/production? (e.g. setting up enviromental variables)
+
+# Other Information
+
+Any other logs, related issues, merge requests, wireframes, documentation, slack conversations or anything else that would help the developer try to find and fix this issue, or provide context.

data/templates/.gitlab-ci.yml.erb

@@ -109,7 +109,7 @@ review:
   only:
     - branches
   except:
-    - master
+    - main
   script:
 <% if options[:rancher] -%>
     - export RANCHER_ENVIRONMENT=staging
@@ -149,7 +149,7 @@ staging:
   - dpl --provider=heroku --app=<%= @project_name %>-staging --api-key=$HEROKU_STAGING_API_KEY --run="bundle exec rake db:migrate"
 <% end -%>
   only:
-    - master
+    - main
   tags:
     - local
 
@@ -167,6 +167,6 @@ production:
 <% end -%>
   when: manual
   only:
-    - master
+    - main
   tags:
     - local

data/templates/.sops.yaml.erb

@@ -0,0 +1,3 @@
+---
+creation_rules:
+  - pgp: "CHANGEME"

data/templates/README.md

@@ -1,19 +1,93 @@
+[Docker development setup](#docker-development-setup)
+
+[Bash into the container](#bash-into-the-container)
+
+[Handling Secrets with SOPS](#handling-secrets-with-sops)
+
+[Deploy a new release](#deploy-a-new-release)
+  
+[Run import from admin page](#run-import-from-admin-page)
+
 # Docker development setup
 
-1) Install Docker.app 
+We recommend committing .env to your repo with good defaults. .env.development, .env.production etc can be used for local overrides and should not be in the repo. See [Handling Secrets with SOPS](#handling-secrets-with-sops) for how to manage secrets.
+
+1) Install Docker.app
 
-2) gem install stack_car
+2) Install stack car
+    ``` bash
+    gem install stack_car
+    ```
 
-3) We recommend committing .env to your repo with good defaults. .env.development, .env.production etc can be used for local overrides and should not be in the repo.
+3) Sign in with dory
+    ``` bash
+    dory up
+    ```
 
-4) sc up
+4) Install dependencies
+    ``` bash
+    yarn install
+    ```
 
+5) Start the server
+    ``` bash
+    sc up
+    ```
+
+6) Load and seed the database
+    ``` bash
+    sc be rake db:migrate db: seed
+    ```
+### Troubleshooting Docker Development Setup
+Confirm or configure settings. Sub your information for the examples.
 ``` bash
-gem install stack_car
-sc up
+git config --global user.name example
+git config --global user.email example@example.com
+docker login registry.gitlab.com
+```
+
+### While in the container you can do the following
+- Run rspec
+    ``` bash
+    bundle exec rspec
+    ```
+- Access the rails console
+    ``` bash
+    bundle exec rails c
+    ```
+
+### Handling Secrets with SOPS
+
+[**SOPS**](https://github.com/mozilla/sops) is used to handle this project's secrets.
 
+The secrets in this repository include:
+- `.env*` files
+- `*-values.yaml` files
+
+Scripts (`bin/decrypt-secrets` and `bin/encrypt-secrets`) are included in this project to help with managing secrets.
+
+**To decrypt secrets**:
+
+You will need to do this if you are new to the project or there have been changes to any secrets files that are required for development.
+
+In terminal:
+```bash
+bin/decrypt-secrets
+```
+
+This will find and decrypt files with the `.enc` extension.
+
+**To encrypt secrets**:
+
+You will need to do this when you have edited secrets and are ready to commit them.
+
+In terminal:
+```bash
+bin/encrypt-secrets
 ```
 
+This will find and output an encrypted version of secret files with an `.enc` extension.
+
 # Deploy a new release
 
 ``` bash
@@ -21,4 +95,4 @@ sc release {staging | production} # creates and pushes the correct tags
 sc deploy {staging | production} # deployes those tags to the server
 ```
 
-Releaese and Deployment are handled by the gitlab ci by default. See ops/deploy-app to deploy from locally, but note all Rancher install pull the currently tagged registry image
+Release and Deployment are handled by the gitlab ci by default. See ops/deploy-app to deploy from locally, but note all Rancher install pull the currently tagged registry image

data/templates/chart/Chart.yaml.tt

@@ -5,25 +5,26 @@ name: <%= @project_name %>
 version: 0.0.1
 dependencies:
 <%- if options[:solr] %>
-  - name: solr 
-    version: 1.3.3
-    repository: https://storage.googleapis.com/kubernetes-charts-incubator
+- name: solr
+  version: 1.5.2
+  repository: https://charts.helm.sh/incubator
+  condition: solr.enabled
 <%- end %>
 <%- if options[:redis] %>
-  - name: redis
-    version: 10.3.1
-    repository: https://kubernetes-charts.storage.googleapis.com/
-    condition: redis.enabled
+- name: redis
+  version: 11.0.4
+  repository: https://charts.bitnami.com/bitnami
+  condition: redis.enabled
 <%- end %>
 <%- if options[:postgres] %>
-  - name: postgresql
-    version: 8.1.2
-    repository: https://kubernetes-charts.storage.googleapis.com/
-    condition: postgresql.enabled
+- name: postgresql
+  version: 10.3.18
+  repository: https://charts.bitnami.com/bitnami
+  condition: postgresql.enabled
 <%- end %>
 <%- if options[:mysql] %>
 - name: mariadb
-  version: 5.x.x
-  repository: https://kubernetes-charts.storage.googleapis.com/
+  version: 7.3.14
+  repository: https://charts.helm.sh/stable
   condition: mariadb.enabled
-<%- end %>
+<%- end %>

data/templates/chart/bin/deploy

@@ -11,4 +11,4 @@ then
     exit 1
 fi
 
-helm upgrade --install --namespace $1-$NAMESPACE $1 . -f $1-values.yaml --set rails.image.tag=$2
+helm upgrade --install --namespace $NAMESPACE-$1 $1 . -f $1-values.yaml --set rails.image.tag=$2

data/templates/chart/bin/remove

@@ -12,4 +12,4 @@ then
 fi
 
 raise 'refusing to remove production' if $1 == 'production'
-helm uninstall --namespace $1-$NAMESPACE $1 . -f $1-values.yaml --set rails.image.tag=$2
+helm uninstall --namespace $NAMESPACE-$1 $1 . -f $1-values.yaml --set rails.image.tag=$2

data/templates/chart/sample-values.yaml.tt

@@ -17,6 +17,7 @@ zookeeper:
     size: 1Gi
 <% end %>
 
+<% if options[:postgres] %>
 postgresql:
   enabled: true
 <% if options[:fedora] %>
@@ -33,6 +34,8 @@ postgresql:
   persistence:
     enabled: true
     size: 1Gi
+<% end %>
+
 <% if options[:mysql] %>
 externalDatabase:
   host: host_name
@@ -117,7 +120,6 @@ env:
     <% if options[:fcrepo] %>
     FC_DATABASE_NAME: fcrepo
     LD_LIBRARY_PATH: /opt/fits-latest/tools/mediainfo/linux
-    SETTINGS__ACTIVE_JOB__QUEUE_ADAPTER: sidekiq
     SETTINGS__CONTACT_EMAIL: admin@example.org
     SETTINGS__DEVISE__INVITATION_FROM_EMAIL: admin@example.org
     SETTINGS__FITS_PATH: /opt/fits/fits.sh
@@ -126,13 +128,26 @@ env:
     SETTINGS__MULTITENANCY__DEFAULT_HOST: "%{tenant}.app.docker"
     SETTINGS__MULTITENANCY__ENABLED: "true"
     <% end %>
+    <% if options[:sidekiq] %>
+    SETTINGS__ACTIVE_JOB__QUEUE_ADAPTER: sidekiq
+    <% end %>
     DATABASE_NAME: <%= @project_name %>
     IN_DOCKER: "true"
     PASSENGER_APP_ENV: production
     RAILS_ENV: production
     RAILS_LOG_TO_STDOUT: "true"
     RAILS_SERVE_STATIC_FILES: "true"
+    # SMTP Mailer vars
+    # Uncomment vars and SMTP Mailer in config/environments/<environment>.rb to enable
+    # SMTP_USER_NAME: CHANGEME
+    # SMTP_ADDRESS: CHANGEME
+    # SMTP_DOMAIN: CHANGEME
+    # SMTP_PORT: CHANGEME
+    # SMTP_TYPE: CHANGEME
 
   secret:
     SECRET_KEY_BASE: secretabc
     DATABASE_PASSWORD: passwordabc
+    # SMTP Mailer secret
+    # Uncomment vars and SMTP Mailer in config/environments/<environment>.rb to enable
+    # SMTP_PASSWORD: CHANGEME

data/templates/chart/templates/_helpers.tpl.tt

@@ -44,7 +44,7 @@ Shorthand for component names
 <%- end %>
 <%- if options[:redis] %>
 {{- define "app.redis.name" -}}
-{{- .Release.Name -}}-redis-master
+{{- .Release.Name -}}-redis-primary
 {{- end -}}
 <%- end %>
 <%- if options[:sidekiq] %>

data/templates/chart/templates/web-ing-wildcard.yaml

@@ -1,5 +1,5 @@
 ---
-apiVersion: extensions/v1beta1
+apiVersion: apps/v1
 kind: Ingress
 metadata:
   name: {{ template "app.web.name" . }}-in-wildcard

data/templates/chart/templates/web-ing.yaml

@@ -1,5 +1,5 @@
 ---
-apiVersion: extensions/v1beta1
+apiVersion: apps/v1 
 kind: Ingress
 metadata:
   name: {{ template "app.web.name" . }}-in

data/templates/database.yml.erb

@@ -2,7 +2,6 @@
 
 <% if options[:mysql] -%>
 login: &login
-  adapter: mysql2
   adapter: <%%= ENV['DATABASE_ADAPTER'] %>
   host: <%%= ENV['DATABASE_HOST'] %>
   username: <%%= ENV['DATABASE_USER'] %>

data/templates/decrypt-secrets

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+# require 'byebug'
+
+parent_dir = File.dirname(__dir__)
+Dir.chdir(File.join(parent_dir))
+[
+  ".env.*",
+  "chart/*-values.yaml",
+  "ops/kube_config.yml",
+  "ops/.backend",
+  "ops/k8s/*-values.yaml"
+].each do |files|
+  Dir.glob(files).each do |file|
+    if file.match(/enc/)
+      next unless File.exists?(file)
+      cmd = "sops --decrypt #{file} > #{file.gsub(/.enc$/, '')}"
+      puts cmd
+      `#{cmd}`
+    end
+  end
+end

data/templates/development.rb.erb

@@ -0,0 +1,90 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  <% if options[:sidekiq] %>
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = !!Sidekiq.server?
+  <% end -%>
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, max-age=172800'
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # SMTP Mailer configuration
+  # Add SMTP settings to your environment and uncomment the following section to enable mailer
+  # if ENV['SMTP_ENABLED'].present? && ENV['SMTP_ENABLED'].to_s == 'true'
+  #   config.action_mailer.smtp_settings = {
+  #     user_name: ENV['SMTP_USER_NAME'],
+  #     password: ENV['SMTP_PASSWORD'],
+  #     address: ENV['SMTP_ADDRESS'],
+  #     domain: ENV['SMTP_DOMAIN'],
+  #     port: ENV['SMTP_PORT'],
+  #     enable_starttls_auto: true,
+  #     authentication: ENV['SMTP_TYPE']
+  #   }
+  #    # ActionMailer Config
+  #   config.action_mailer.delivery_method = :smtp
+  #   config.action_mailer.perform_deliveries = true
+  #   config.action_mailer.raise_delivery_errors = false
+  <% if options[:hyku] %>
+  #   config.action_mailer.asset_host = ENV['SETTINGS__MULTITENANCY__ADMIN_HOST']
+  <% end %>
+  # else
+  #   config.action_mailer.delivery_method = :test
+  # end
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  config.action_mailer.default_url_options = { host: "localhost:3001" }
+
+  config.web_console.whitelisted_ips = ['172.18.0.0/16', '172.27.0.0/16', '0.0.0.0/0']
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  config.active_job.queue_adapter     = Settings.active_job.queue_adapter
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/templates/docker-compose.yml.erb

@@ -110,7 +110,7 @@ services:
         DEPLOY_KEY: "${DEPLOY_KEY}"
         REPO_URL: "${REPO_URL}"
         BRANCH: "${BRANCH}"
-    image: "${REGISTRY_HOST}${REGISTRY_URI}:${TAG:-master}"
+    image: "${REGISTRY_HOST}${REGISTRY_URI}:${TAG:-main}"
     env_file:
       - .env
       - .env.development
@@ -138,6 +138,7 @@ services:
   worker:
     extends: app
     command: ./bin/delayed_job run
+    depends_on:
 <%= compose_depends %>
 <% end %>
 
@@ -145,6 +146,7 @@ services:
   worker:
     extends: app
     command: bundle exec sidekiq
+    depends_on:
 <%= compose_depends %>
 <% end %>
 

data/templates/encrypt-secrets

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# require 'byebug'
+
+parent_dir = File.dirname(__dir__)
+[
+  ".env.*",
+  "chart/*-values.yaml",
+  "ops/kube_config.yml",
+  "ops/.backend",
+  "ops/k8s/*-values.yaml"
+].each do |files|
+  Dir.glob(files).each do |file|
+    next if /enc/.match?(file)
+    cmd = "sops --encrypt #{file} > #{file}.enc"
+    puts cmd
+    `#{cmd}`
+  end
+end

data/templates/production.rb.erb

@@ -0,0 +1,117 @@
+Rails.application.configure do
+    # Settings specified here will take precedence over those in config/application.rb.
+  
+    # Code is not reloaded between requests.
+    config.cache_classes = true
+  
+    # Eager load code on boot. This eager loads most of Rails and
+    # your application in memory, allowing both threaded web servers
+    # and those relying on copy on write to perform better.
+    # Rake tasks automatically ignore this option for performance.
+    config.eager_load = true
+  
+    # Full error reports are disabled and caching is turned on.
+    config.consider_all_requests_local       = false
+    config.action_controller.perform_caching = true
+  
+    # Disable serving static files from the `/public` folder by default since
+    # Apache or NGINX already handles this.
+    config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, s-maxage=31536000, maxage=15552000',
+      'Expires' => "#{1.year.from_now.to_formatted_s(:rfc822)}"
+    }
+    # Compress JavaScripts and CSS.
+    config.assets.js_compressor = Uglifier.new(harmony: true)
+    # config.assets.css_compressor = :sass
+  
+    # Do not fallback to assets pipeline if a precompiled asset is missed.
+    config.assets.compile = false
+  
+    # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+  
+    # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+    config.action_controller.asset_host = Settings.action_controller.asset_host if Settings.action_controller.asset_host
+  
+    # Specifies the header that your server uses for sending files.
+    # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+    # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+  
+    # Mount Action Cable outside main process or domain
+    # config.action_cable.mount_path = nil
+    # config.action_cable.url = 'wss://example.com/cable'
+    # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+  
+    # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+    # config.force_ssl = true
+  
+    # Use the lowest log level to ensure availability of diagnostic information
+    # when problems arise.
+    config.log_level = :debug
+  
+    # Prepend all log lines with the following tags.
+    config.log_tags = [ :request_id ]
+  
+    # Use a different cache store in production.
+    # config.cache_store = :mem_cache_store
+  
+    # Use a real queuing backend for Active Job (and separate queues per environment)
+    require 'active_job/queue_adapters/better_active_elastic_job_adapter'
+    config.active_job.queue_adapter     = Settings.active_job.queue_adapter
+    # config.active_job.queue_name_prefix = "hyku_#{Rails.env}"
+  
+    # SMTP Mailer configuration
+    # Add SMTP settings to your environment and uncomment the following section to enable mailer
+    # if ENV['SMTP_ENABLED'].present? && ENV['SMTP_ENABLED'].to_s == 'true'
+    #   config.action_mailer.smtp_settings = {
+    #     user_name: ENV['SMTP_USER_NAME'],
+    #     password: ENV['SMTP_PASSWORD'],
+    #     address: ENV['SMTP_ADDRESS'],
+    #     domain: ENV['SMTP_DOMAIN'],
+    #     port: ENV['SMTP_PORT'],
+    #     enable_starttls_auto: true,
+    #     authentication: ENV['SMTP_TYPE']
+    #   }
+    #  # ActionMailer Config
+    #   config.action_mailer.delivery_method = :smtp
+    #   config.action_mailer.perform_deliveries = true
+    #   config.action_mailer.raise_delivery_errors = false
+    <% if options[:hyku] %>
+    #   config.action_mailer.asset_host = ENV['SETTINGS__MULTITENANCY__ADMIN_HOST']
+    <% end %>
+    # else
+    #   config.action_mailer.delivery_method = :test
+    # end
+  
+    config.action_mailer.perform_caching = false
+  
+    # Ignore bad email addresses and do not raise email delivery errors.
+    # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+    # config.action_mailer.raise_delivery_errors = false
+    #
+    config.action_mailer.default_url_options = { protocol: Settings.ssl_configured ? 'https' : 'http' }
+  
+    # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+    # the I18n.default_locale when a translation cannot be found).
+    config.i18n.fallbacks = true
+  
+    # Send deprecation notices to registered listeners.
+    config.active_support.deprecation = :notify
+  
+    # Use default logging formatter so that PID and timestamp are not suppressed.
+    config.log_formatter = ::Logger::Formatter.new
+  
+    # Use a different logger for distributed setups.
+    # require 'syslog/logger'
+    # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+  
+    if ENV["RAILS_LOG_TO_STDOUT"].present?
+      logger           = ActiveSupport::Logger.new(STDOUT)
+      logger.formatter = config.log_formatter
+      config.logger = ActiveSupport::TaggedLogging.new(logger)
+    end
+  
+    # Do not dump schema after migrations.
+    config.active_record.dump_schema_after_migration = false
+  end
+  

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stack_car
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Rob Kaufman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-13 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +183,12 @@ files:
 - templates/.env.development.erb
 - templates/.env.erb
 - templates/.gitlab-ci.yml.erb
-- templates/Dockerfile.builder.erb
+- templates/.gitlab/issue_templates/Bug.md
+- templates/.gitlab/issue_templates/Feature.md
+- templates/.gitlab/issue_templates/Question.md
+- templates/.gitlab/merge_request_templates/Bug.md
+- templates/.gitlab/merge_request_templates/Feature.md
+- templates/.sops.yaml.erb
 - templates/Dockerfile.erb
 - templates/README.md
 - templates/chart-fcrepo/fcrepo-deploy.yaml
@@ -198,8 +217,11 @@ files:
 - templates/chart/templates/web-ing.yaml
 - templates/chart/templates/web-svc.yaml
 - templates/database.yml.erb
+- templates/decrypt-secrets
 - templates/deploy.yml.erb
+- templates/development.rb.erb
 - templates/docker-compose.yml.erb
+- templates/encrypt-secrets
 - templates/env.conf.erb
 - templates/hosts.erb
 - templates/nginx.sh.erb
@@ -219,6 +241,7 @@ files:
 - templates/ops/roles/docker.ubuntu/templates/docker.conf
 - templates/ops/roles/docker.ubuntu/tests/vagrant.yml
 - templates/ops/roles/docker.ubuntu/vars/main.yml
+- templates/production.rb.erb
 - templates/provision.yml.erb
 - templates/webapp.conf.erb
 - templates/worker.sh.erb
@@ -240,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: A tool to make rails + docker easy

data/templates/Dockerfile.builder.erb

@@ -1,13 +0,0 @@
-FROM docker:latest
-
-RUN apk update && \
-    apk add bash git ruby-json ansible openssh && \
-    gem install stack_car --no-ri --no-rdoc && \
-<% if options[:rancher] %>
-    wget https://github.com/rancher/cli/releases/download/v0.4.1/rancher-linux-amd64-v0.4.1.tar.gz && \
-    tar zxfv rancher-linux-amd64-v0.4.1.tar.gz && \
-    mv rancher-v0.4.1/rancher /bin/rancher
-<% end %>
-<% if options[:heroku] %>
-    gem install dpl multi_json --no-ri --no-rdoc
-<% end %>