tpt-rails 1.4.0.rc1 → 1.5.0

data/lib/generators/{tpt_rails → tpt/rails}/kubernetes/templates/kubernetes/helm/templates/service.yaml.tt

@@ -17,6 +17,8 @@ metadata:
     tpt/owner: {{ .Values.annotations.owner }}
     tpt/creator: {{ .Values.annotations.creator | default "UNKNOWN" | quote }}
     tpt/release: "{{ .Release.Name }}"
+    tpt/costEnv: {{ .Values.annotations.costEnv | quote }}
+    tpt/costCategory: {{ .Values.annotations.costCategory | quote }}
   annotations:
     getambassador.io/config: |
       apiVersion: ambassador/v1

data/lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/values.prod.yaml.tt

@@ -0,0 +1,82 @@
+name: <%= Tpt::Rails.app_name %>
+deploy_env: production
+
+annotations:
+  costEnv: production
+
+image:
+  name: <%= Tpt::Rails.app_name %>
+  repository: teacherspayteachers/<%= Tpt::Rails.app_name %>
+  tag: latest
+  pullPolicy: Always
+
+environment:
+  ENVIRONMENT: production
+  APP_ENV: production
+  RAILS_ENV: production
+  RACK_TIMEOUT_SERVICE_TIMEOUT: "20"
+  RACK_TIMEOUT_TERM_ON_TIMEOUT: "5"
+
+  # To set up a staging/prod DB:
+  # - Create the DB in the TpT terraform repo
+  # - Use the root DB account to create an application DB user
+  # - Add needed the following keys with proper values to
+  #   the '<%= Tpt::Rails.app_name %>-secrets' kube secret:
+  #     - <%= Tpt::Rails.app_name %>-prod-db-host
+  #     - <%= Tpt::Rails.app_name %>-prod-db-replica-host
+  #     - <%= Tpt::Rails.app_name %>-prod-db-name
+  #     - <%= Tpt::Rails.app_name %>-prod-db-password
+  #     - <%= Tpt::Rails.app_name %>-prod-db-user
+  DATABASE_HOST: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-prod-db-host
+  DATABASE_REPLICA_HOST: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-prod-db-replica-host
+  DATABASE_NAME: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-prod-db-name
+  DATABASE_PASSWORD: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-prod-db-password
+  DATABASE_USER: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-prod-db-user
+
+copy-secrets:
+  enabled: false
+
+mysql:
+  enabled: false
+
+postgresql:
+  enabled: false
+
+redis:
+  enabled: false
+
+autoscaler:
+  minimumPods: 3
+  maximumPods: 6
+  targetCPUUtilizationPercentage: 70
+
+rollingUpdate:
+  maxSurge: 25%
+
+# Create ELB
+# service:
+#   type: LoadBalancer
+#   port: 80
+
+db-migrate:
+  enabled: false

data/lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/values.staging.yaml.tt

@@ -0,0 +1,125 @@
+name: <%= Tpt::Rails.app_name %>
+deploy_env: staging
+
+annotations:
+  costEnv: staging
+
+image:
+  name: <%= Tpt::Rails.app_name %>
+  repository: teacherspayteachers/<%= Tpt::Rails.app_name %>
+  tag: latest
+  pullPolicy: Always
+
+environment:
+  APP_ENV: staging
+  ENVIRONMENT: staging
+  RAILS_ENV: production
+  RACK_TIMEOUT_SERVICE_TIMEOUT: "20"
+  RACK_TIMEOUT_TERM_ON_TIMEOUT: "1"
+
+  # To set up a staging/prod DB:
+  # - Create the DB in the TpT terraform repo
+  # - Use the root DB account to create an application DB user
+  # - Add needed the following keys with proper values to
+  #   the '<%= Tpt::Rails.app_name %>-secrets' kube secret:
+  #     - <%= Tpt::Rails.app_name %>-staging-db-host
+  #     - <%= Tpt::Rails.app_name %>-staging-db-replica-host
+  #     - <%= Tpt::Rails.app_name %>-staging-db-name
+  #     - <%= Tpt::Rails.app_name %>-staging-db-password
+  #     - <%= Tpt::Rails.app_name %>-staging-db-user
+  DATABASE_HOST: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-staging-db-host
+  DATABASE_REPLICA_HOST: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-staging-db-replica-host
+  DATABASE_NAME: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-staging-db-name
+  DATABASE_PASSWORD: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-staging-db-password
+  DATABASE_USER: |-
+    valueFrom:
+      secretKeyRef:
+        name: <%= Tpt::Rails.app_name %>-secrets
+        key: <%= Tpt::Rails.app_name %>-staging-db-user
+
+copy-secrets:
+  enabled: false
+
+mysql:
+  enabled: false
+
+postgresql:
+  enabled: false
+
+redis:
+  enabled: false
+
+autoscaler:
+  minimumPods: 1
+  maximumPods: 2
+  targetCPUUtilizationPercentage: 70
+
+rollingUpdate:
+  maxSurge: 25%
+
+# Create ELB
+# service:
+#   type: LoadBalancer
+#   port: 80
+
+db-migrate:
+  enabled: false
+  migration:
+    env:
+      - name: APP_ENV
+        value: staging
+      - name: APP_NAME
+        value: <%= Tpt::Rails.app_name %>
+      # The db-migrate chart sets the following environment variables, which we can use to construct
+      # a Rails-friendly DB_URL.
+      # - PROXY_HOST
+      # - PROXY_PASSWORD
+      # - PROXY_USER
+      - name: DB_URL
+        value: "mysql2://$(PROXY_USER):$(PROXY_PASSWORD)@$(PROXY_HOST):3306/<%= Tpt::Rails.app_name %>"
+      # We don't override DB_MAX_EXECUTION_TIME here because it only applies to `select` queries and we
+      # plan to write migrations such that any `select` queries are fast.
+      # We specify the READ timeout because when testing that was the one that seemed to be used for
+      # `alter table` commands.
+      - name: DB_READ_TIMEOUT
+        value: "604800"
+      - name: DB_WRITE_TIMEOUT
+        value: "604800"
+      - name: RAILS_ENV
+        value: production
+      - name: SECRET_KEY_BASE
+        valueFrom:
+          secretKeyRef:
+            name: <%= config.fetch(:secrets_name) %>
+            key: <%= config.fetch(:secrets_key) %>
+  proxy-osc:
+    dryRun: false
+    target:
+      host:
+        secret:
+          name: <%= config.fetch(:secrets_name) %>
+          key: <%= Tpt::Rails.app_name %>-staging-db-host
+      user:
+        secret:
+          name: <%= config.fetch(:secrets_name) %>
+          key: <%= Tpt::Rails.app_name %>-staging-db-user
+      password:
+        secret:
+          name: <%= config.fetch(:secrets_name) %>
+          key: <%= Tpt::Rails.app_name %>-staging-db-password

data/lib/generators/{tpt_rails → tpt/rails}/kubernetes/templates/kubernetes/helm/values.yaml.tt

@@ -9,19 +9,26 @@ deploy_env: integration
 # There are added to Kubernetes in various ways as labels/etc
 annotations:
   owner: <%= config.fetch(:team_name) %>
+  # tpt/costEnv can be [development, integration, staging, production, uncategorized]
+  costEnv: integration
+  # tpt/costCategory can be [core_domains, data, easel, infrastructure, kubernetes, marketplace, search, schools, uncategorized]
+  costCategory: uncategorized
 
 # Docker image configuration for the pod
-image:
+image: &appImage
   name: <%= Tpt::Rails.app_name %>
-  repository: <%= Tpt::Rails.app_name %>
+  repository: teacherspayteachers/<%= Tpt::Rails.app_name %>
   tag: latest # most recently pushed
   pullPolicy: Always # always pull, don't use a cached version
 
-# Used by a Helm hook that runs migration
-migrateCommand: 'bin/rails db:prepare'
-
-# Container count
-replicas: 1
+# Used by a Helm hook that sets up database schema and seeds.
+# We don't override DB_MAX_EXECUTION_TIME here because it only applies to `select` queries and we
+# plan to write migrations such that any `select` queries are fast.
+# We specify the READ timeout because when testing that was the one that seemed to be used for
+# `alter table` commands.
+dbPrepare:
+  command: "DB_READ_TIMEOUT=600 DB_WRITE_TIMEOUT=600 bin/rails db:prepare"
+  enabled: true
 
 revisionHistoryLimit: 5
 
@@ -38,12 +45,18 @@ rollingUpdate:
 
 mysql:
   enabled: true
+  imageTag: 5.7.12
   podAnnotations:
     # istio is a service mesh. the istio sidecar interferes with how other pods connect to the MySQL
     # pod.
     sidecar.istio.io/inject: "false"
-  # mysqlRootPassword is only used in this file and is only for ODEs
-  mysqlRootPassword: "123456"
+  # Leave "mysqlDatabase" commented out.
+  # Specifying the db name causes our mysql chart to proactively create the database. This then
+  # causes db:prepare to assume it needs to *run* all migrations, instead creating the db +
+  # bootstrapping the schema from db/schema.rb. The latter is the correct way to set up a new DB.
+  # mysqlDatabase: &mysqlDatabase "<%= Tpt::Rails.app_name %>"
+  # mysqlRootPassword is read by our ODE mysql chart
+  mysqlRootPassword: &mysqlRootPassword "123456"
   persistence:
     enabled: false
 
@@ -67,7 +80,7 @@ service:
 ## Configure resource requests and limits
 ## ref: http://kubernetes.io/docs/user-guide/compute-resources/
 ##
-resources:
+resources: &resources
   # requests is guaranteed. kubernetes will only put your pod on a node where it can guarantee these
   # amounts.
   requests: &requests
@@ -94,12 +107,13 @@ environment:
   APP_NAME: <%= Tpt::Rails.app_name %>
   APP_ENV: integration
   DD_TRACE_DEBUG: '1'
-  # DATABASE_URL is only used in ODEs
-  DATABASE_URL: 'mysql2://root:{{ .Values.mysql.mysqlRootPassword }}@{{ template "<%= Tpt::Rails.app_name %>.fullname" . }}-mysql:3306/<%= Tpt::Rails.app_name %>_production'
   RAILS_ENV: 'production'
   RAILS_LOG_TO_STDOUT: '1'
   RAILS_SERVE_STATIC_FILES: '1'
   CLUSTER_SELECTOR: 'app={{ template "<%= Tpt::Rails.app_name %>.fullname" . }}'
+  RACK_TIMEOUT_SERVICE_TIMEOUT: "20"
+  RACK_TIMEOUT_TERM_ON_TIMEOUT: "1"
+
   APP_ENV_NAME: |-
     valueFrom:
       fieldRef:
@@ -116,12 +130,24 @@ environment:
     valueFrom:
       fieldRef:
         fieldPath: status.podIP
+
+  DATABASE_HOST: '{{ template "<%= Tpt::Rails.app_name %>.fullname" . }}-mysql'
+  DATABASE_REPLICA_HOST: '$(DATABASE_HOST)'
+  DATABASE_NAME: '<%= Tpt::Rails.app_name %>'
+  DATABASE_PASSWORD: *mysqlRootPassword
+  DATABASE_USER: root
+  # Using "DB" prefix here because kube env vars can only reference other env vars that come before
+  # them alphabetically.
+  DB_URL:         "mysql2://$(DATABASE_USER):$(DATABASE_PASSWORD)@$(DATABASE_HOST)/$(DATABASE_NAME)"
+  DB_REPLICA_URL: "mysql2://$(DATABASE_USER):$(DATABASE_PASSWORD)@$(DATABASE_REPLICA_HOST)/$(DATABASE_NAME)"
+
   DATADOG_TRACE_HOST: |-
     valueFrom:
       fieldRef:
         fieldPath: status.hostIP
   DATADOG_TRACE_PORT: "8126"
   DATADOG_TRACE_URL: "datadog://$(DATADOG_TRACE_HOST):$(DATADOG_TRACE_PORT)"
+
   DOGSTATSD_HOST: |-
     valueFrom:
       fieldRef:
@@ -135,11 +161,11 @@ copy-secrets:
     - <%= config.fetch(:secrets_name) %>
 
 secrets:
-  - name: RAILS_MASTER_KEY
+  - name: SECRET_KEY_BASE
     valueFrom:
       secretKeyRef:
         name: <%= config.fetch(:secrets_name) %>
-        key: rails-master-key
+        key: <%= config.fetch(:secrets_key) %>
 
 # liveness: Whether the pod is up.
 # After `initialDelaySeconds` if this is failing Kube will crash+restart the pod.
@@ -170,3 +196,48 @@ autoscaler:
   minimumPods: 1
   maximumPods: 1
   targetCPUUtilizationPercentage: 70 # no effect if minimumPods == maximumPods
+
+# Database migration support.
+db-migrate:
+  enabled: false
+  migration:
+    command:
+      - bin/rails
+      - db:migrate
+    image: *appImage
+    env:
+      - name: APP_ENV
+        value: integration
+      - name: APP_NAME
+        value: <%= Tpt::Rails.app_name %>
+      # The db-migrate chart sets the following environment variables, which we can use to construct
+      # a Rails-friendly DB_URL.
+      # - PROXY_HOST
+      # - PROXY_PASSWORD
+      # - PROXY_USER
+      - name: DB_URL
+        value: "mysql2://$(PROXY_USER):$(PROXY_PASSWORD)@$(PROXY_HOST):3306/<%= Tpt::Rails.app_name %>"
+      # We don't override DB_MAX_EXECUTION_TIME here because it only applies to `select` queries and we
+      # plan to write migrations such that any `select` queries are fast.
+      # We specify the READ timeout because when testing that was the one that seemed to be used for
+      # `alter table` commands.
+      - name: DB_READ_TIMEOUT
+        value: "604800"
+      - name: DB_WRITE_TIMEOUT
+        value: "604800"
+      - name: RAILS_ENV
+        value: production
+      - name: SECRET_KEY_BASE
+        valueFrom:
+          secretKeyRef:
+            name: <%= config.fetch(:secrets_name) %>
+            key: <%= config.fetch(:secrets_key) %>
+    resources: *resources
+  proxy-osc:
+    logLevel: debug
+    target:
+      # When host is not set, proxy-osc defaults to [release-name]-mysql
+      # host:
+      user: root
+      password: *mysqlRootPassword
+  schedule: "*/1 * * * *"

data/lib/tpt/rails/internal/error_reporter.rb

@@ -55,7 +55,7 @@ class Tpt::Rails::Internal::ErrorReporter # :nodoc:
 
   def configure_rollbar
     # Ensure that rollbar has been added to the app's Gemfile
-    gem 'rollbar', '>= 2.23.2', '< 3'
+    gem 'rollbar', '>= 2.23.2', '< 4'
 
     Rollbar.configure do |config|
       config.access_token = @rollbar_access_token

data/lib/tpt/rails/version.rb

@@ -1,5 +1,6 @@
 module Tpt
   module Rails
-    VERSION = '1.4.0.rc1'
+    # Do not change this manually. Our tooling will do it automatically.
+    VERSION = '1.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tpt-rails
 version: !ruby/object:Gem::Version
-  version: 1.4.0.rc1
+  version: 1.5.0
 platform: ruby
 authors:
 - TpT
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.1.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3.3
+        version: 6.1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.1.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3.3
+        version: 6.1.3.2
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -72,8 +72,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -91,34 +91,29 @@ files:
 - app/models/tpt/rails/application_record.rb
 - app/views/layouts/tpt/rails/application.html.erb
 - config/routes.rb
-- lib/generators/tpt_rails/configuration/configuration_generator.rb
-- lib/generators/tpt_rails/configuration/templates/config/initializers/tpt_rails.rb
-- lib/generators/tpt_rails/continuous_integration/continuous_integration_generator.rb
-- lib/generators/tpt_rails/continuous_integration/templates/ci/Dockerfile.tt
-- lib/generators/tpt_rails/continuous_integration/templates/ci/docker-compose.yaml.tt
-- lib/generators/tpt_rails/continuous_integration/templates/ci/tasks/project.test.unit
-- lib/generators/tpt_rails/continuous_integration/templates/ci/test.Jenkinsfile.tt
-- lib/generators/tpt_rails/continuous_integration/templates/ci/test.config.xml.tt
-- lib/generators/tpt_rails/continuous_integration/templates/ci/tptcd.Jenkinsfile.tt
-- lib/generators/tpt_rails/continuous_integration/templates/ci/tptci.Jenkinsfile.tt
-- lib/generators/tpt_rails/kubernetes/kubernetes_generator.rb
-- lib/generators/tpt_rails/kubernetes/templates/Dockerfile.tt
-- lib/generators/tpt_rails/kubernetes/templates/entrypoint.sh
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/Chart.yaml.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/README.md
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/requirements.yaml.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/NOTES.txt.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/_env.yaml
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/_helpers.tpl.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/autoscaler.yaml.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/deployment.yaml.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/hooks/db-migrate.yaml.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/service.yaml.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/values.prod.yaml.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/values.staging.yaml.tt
-- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/values.yaml.tt
-- lib/generators/tpt_rails/postman/postman.yaml.tt
-- lib/tasks/tpt/rails_tasks.rake
+- lib/generators/tpt/rails/configuration/configuration_generator.rb
+- lib/generators/tpt/rails/configuration/templates/config/initializers/tpt_rails.rb
+- lib/generators/tpt/rails/continuous_integration/continuous_integration_generator.rb
+- lib/generators/tpt/rails/continuous_integration/templates/ci/Dockerfile.tt
+- lib/generators/tpt/rails/continuous_integration/templates/ci/docker-compose.yaml.tt
+- lib/generators/tpt/rails/continuous_integration/templates/ci/tasks/project.test.unit.tt
+- lib/generators/tpt/rails/kubernetes/kubernetes_generator.rb
+- lib/generators/tpt/rails/kubernetes/templates/Dockerfile.tt
+- lib/generators/tpt/rails/kubernetes/templates/entrypoint.sh
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/Chart.yaml.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/README.md
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/requirements.yaml.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/templates/NOTES.txt.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/templates/_env.yaml
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/templates/_helpers.tpl.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/templates/autoscaler.yaml.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/templates/deployment.yaml.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/templates/hooks/db-prepare.yaml.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/templates/service.yaml.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/values.prod.yaml.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/values.staging.yaml.tt
+- lib/generators/tpt/rails/kubernetes/templates/kubernetes/helm/values.yaml.tt
+- lib/generators/tpt/rails/postman/postman.yaml.tt
 - lib/tpt/rails.rb
 - lib/tpt/rails/config.rb
 - lib/tpt/rails/engine.rb
@@ -132,7 +127,7 @@ homepage: https://github.com/TeachersPayTeachers/tpt-rails
 licenses:
 - Nonstandard
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,12 +138,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Utils for TpT Rails apps
 test_files: []