tpt-rails 1.2.2 → 1.4.2

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.rb

@@ -68,5 +68,10 @@ module Tpt::Rails
     def config # :nodoc:
       configured? ? @config : raise(NotConfigured)
     end
+
+    # This should be set by the deployment tool. E.g. Jenkins: https://git.io/JJFiD
+    def release_version
+      ENV['TPT_RELEASE_VERSION'].presence
+    end
   end
 end

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

@@ -29,18 +29,21 @@ class Tpt::Rails::Internal::Datadog # :nodoc:
     url = @statsd_url || 'statsd://localhost'
     uri = URI.parse(url)
 
+    tags = ["env:#{Tpt::Rails.app_env}"]
+    tags << ["tpt_release_version:#{Tpt::Rails.release_version}"] if Tpt::Rails.release_version
+
     ::Datadog::Statsd.new(
       uri.host,
       uri.port || DEFAULT_STATSD_PORT,
-      {
-        namespace: Tpt::Rails.app_name,
-        tags: ["env:#{Tpt::Rails.app_env}"],
-      }
+      namespace: Tpt::Rails.app_name,
+      tags: tags,
     )
   end
 
   def configure_tracing
     uri = URI.parse(@trace_url)
+    tags = { 'env' => Tpt::Rails.app_env }
+    tags["tpt_release_version"] = Tpt::Rails.release_version if Tpt::Rails.release_version
 
     ::Datadog.configure do |c|
       # This will activate auto-instrumentation for Rails
@@ -53,8 +56,10 @@ class Tpt::Rails::Internal::Datadog # :nodoc:
         enabled: true,
         hostname: uri.host,
         port: uri.port || DEFAULT_TRACE_PORT,
-        tags: { 'env' => Tpt::Rails.app_env },
+        tags: tags,
       )
+
+      c.logger.level = ::Logger::WARN
     end
 
     ::Datadog::Pipeline.before_flush(

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

@@ -49,6 +49,7 @@ class Tpt::Rails::Internal::ErrorReporter # :nodoc:
 
     Bugsnag.configure do |config|
       config.api_key = @bugsnag_api_key
+      config.app_version = Tpt::Rails.release_version if Tpt::Rails.release_version
     end
   end
 
@@ -58,8 +59,10 @@ class Tpt::Rails::Internal::ErrorReporter # :nodoc:
 
     Rollbar.configure do |config|
       config.access_token = @rollbar_access_token
+      config.code_version = Tpt::Rails.release_version if Tpt::Rails.release_version
       config.enabled = @rollbar_enabled
       config.environment = Tpt::Rails.app_env
+      config.populate_empty_backtraces = true
     end
   end
 end