pfab 0.33.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae7b00c6d13d8b45b8366942aff2a3afacc421e798a715bde6acb2455623a1b2
-  data.tar.gz: c94e58d362a8c6f3f6da51dd183b32da9474278eb6aaaf8e8ba2d35c2aab346e
+  metadata.gz: 43fd2d75471720154cc7f601da778a1f2e876ad3a2b6f10b6287a7c5c495a9a2
+  data.tar.gz: ea9b62311da369c161222052886f6203eb5c0abeffcb0eefb70d5624db530443
 SHA512:
-  metadata.gz: '092d1680e87f567c670d566dcebaa029a4c2b30fd841695a4d0bd6a2da0b542f8aa5f41208e70116c374a90a359276f2df0a4bdac511ec28c490ac4ac040538a'
-  data.tar.gz: ef414f2881c18685adef089dfdfd0a61937941ff3945338b74d3025f1f48a77203ca5545df80fa8fdb4bb4f0a2ca9722929c0a3ae780f770d9cb83ee418abd9a
+  metadata.gz: 68fb2dc8204e567dbae8a2d0b693e8f4fb313da71ae3ee99de55f2e80db90241c12a18b9420a780da66ee6e0279e65ba5436f757f1b8c55be6e7fe8b0524e12c
+  data.tar.gz: f14ce8e698afc69632ee311f1735ac0b6ac24de734dbfa2b947a93de120df7845cde3ef4daf28f3bf7f35fed65c97eb7095e8ad1110b380c307870e81e673214

data/CODEOWNERS

@@ -0,0 +1 @@
+*    @prefab-cloud/prefabdevs @prefab-cloud/prefabmaintainers @prefab-cloud/prefabadmins

data/Gemfile.lock

@@ -18,7 +18,7 @@ GIT
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (5.2.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -30,7 +30,7 @@ GEM
     coderay (1.1.2)
     commander (4.4.6)
       highline (~> 1.7.2)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.9)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     docile (1.3.1)
@@ -53,7 +53,7 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    git (1.9.1)
+    git (1.11.0)
       rchardet (~> 1.8)
     github_api (0.19.0)
       addressable (~> 2.4)
@@ -63,19 +63,19 @@ GEM
       oauth2 (~> 1.0)
     hashie (3.6.0)
     highline (1.7.10)
-    i18n (1.2.0)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     json (1.8.6)
     jwt (2.3.0)
     kamelcase (0.0.2)
       semver2 (~> 3)
     method_source (0.9.2)
-    mini_portile2 (2.8.1)
-    minitest (5.11.3)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    nokogiri (1.14.2)
+    nokogiri (1.13.6)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     oauth2 (1.4.7)
@@ -93,7 +93,7 @@ GEM
       pry (~> 0.10)
     psych (4.0.2)
     public_suffix (4.0.6)
-    racc (1.6.2)
+    racc (1.6.0)
     rack (2.2.3)
     rake (13.0.6)
     rchardet (1.8.0)
@@ -109,7 +109,7 @@ GEM
     test-unit (3.2.9)
       power_assert
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -126,4 +126,4 @@ DEPENDENCIES
   test-unit
 
 BUNDLED WITH
-   1.17.2
+   2.3.5

data/README.markdown

@@ -117,9 +117,9 @@ Releasing
 - modify version.rb
 - ```bundle exec rake gemspec```
 - ```git commit ```
-- ```bundle exec rake git:release```
-- ```bundle exec rake build```
-- ```gem push pkg/pfab-0.12.0.gem```
+- ```REMOTE_BRANCH=main LOCAL_BRANCH=main bundle exec rake git:release```
+- ```REMOTE_BRANCH=main LOCAL_BRANCH=main bundle exec rake build```
+- ```gem push pkg/pfab-0.15.0.gem```
 
 Copyright
 ---------

data/lib/pfab/cli.rb

@@ -22,7 +22,14 @@ module Pfab
       $dryrun = false
       global_option("--dryrun") { $dryrun = true }
       $env = :staging
-      global_option("-p") { $env = :production }
+      global_option("-p") do
+        puts "please use `-e production` next time!"
+        $env = :production
+      end
+      global_option("-e", "--environment ENV", "specify target env") do |env_name|
+        puts "Using environment #{env_name}"
+        $env = env_name
+      end
       global_option("-a", "--application_name APP_NAME", "run without prompting for app") do |app_name|
         $app_name = app_name
       end
@@ -31,8 +38,9 @@ module Pfab
         c.syntax = "pfab build"
         c.summary = "build image"
         c.option "--force", "force build and push"
+        c.option "--check", "just check if built"
         c.action do |_args, options|
-          cmd_build(force: options.force)
+          cmd_build(force: options.force, checkonly: options.check)
         end
       end
 
@@ -83,6 +91,18 @@ module Pfab
         end
       end
 
+      command :restart do |c|
+        c.syntax = "pfab restart"
+        c.summary = "rolling restart of a deployment"
+        c.description = "rolling restart of a deployment"
+        c.action do
+          set_kube_context
+          app_name = get_app_name
+
+          puts_and_system "kubectl rollout restart deployment.apps/#{app_name}"
+        end
+      end
+
       command :exec do |c|
         c.syntax = "pfab exec"
         c.summary = "kubectl exec into a  pod"
@@ -190,10 +210,20 @@ module Pfab
         end
         puts_and_system("kubectl apply -f .application-k8s-#{$env}-#{app_name}.yaml")
         puts_and_system("git tag release-#{$env}-#{app_name}-#{Time.now.strftime("%Y-%m-%d-%H-%M-%S")} HEAD")
+        puts_and_system("git push origin --tags")
       end
     end
 
-    def cmd_build(force: false)
+    def image_exists?(full_image_name)
+
+      # return 0 if image exists 1 if not
+      cmd = "docker manifest inspect #{full_image_name} > /dev/null ; echo $?"
+      say "Looking for images with #{cmd}"
+      existing = `#{cmd}`.strip
+      existing == "0"
+    end
+
+    def cmd_build(force: false, checkonly: false)
       rev = get_current_sha
       say "This repo is at rev: #{rev}"
       uncommitted_changes = !`git diff-index HEAD --`.empty?
@@ -209,13 +239,14 @@ module Pfab
 
       full_image_name = "#{container_repository}/#{image_name}:#{rev}"
 
-      cmd = "docker images -q #{full_image_name}"
-      say "Looking for images with #{cmd}"
-      existing = `#{cmd}`
-
-      if !existing.to_s.empty? && !force
-        say "Found image #{full_image_name} already, skipping prebuild, build & push"
-        return true
+      unless force
+        if image_exists?(full_image_name)
+          say "Found image #{full_image_name} already, skipping prebuild, build & push"
+          return true
+        else
+          say "No image #{full_image_name} present"
+        end
+        return if checkonly
       end
 
       say "No image #{full_image_name} present, building"
@@ -234,13 +265,23 @@ module Pfab
         end
       end
 
-      puts_and_system "docker build -t #{image_name} --platform amd64 ."
+      build_cmd = "docker build -t #{image_name} --platform amd64 ."
+      puts build_cmd
+      result = system(build_cmd)
 
-      puts_and_system "docker tag #{image_name}:latest #{image_name}:#{rev}"
-      puts_and_system "docker tag #{image_name}:#{rev} #{full_image_name}"
+      puts "Build Result #{result}"
+
+      if result
+        puts_and_system "docker tag #{image_name}:latest #{image_name}:#{rev}"
+        puts_and_system "docker tag #{image_name}:#{rev} #{full_image_name}"
+
+        puts_and_system "docker push #{container_repository}/#{image_name}:#{rev}"
+        return true
+      else
+        say "Build Did Not Succeed"
+        return false
+      end
 
-      puts_and_system "docker push #{container_repository}/#{image_name}:#{rev}"
-      return true
     end
 
     def yy
@@ -263,7 +304,7 @@ module Pfab
     end
 
     def get_current_sha
-      `git rev-parse --short --verify HEAD`.chomp
+      `git rev-parse --short=8 --verify HEAD`.chomp
     end
 
     def set_kube_context

data/lib/pfab/templates/base.rb

@@ -17,6 +17,10 @@ module Pfab
         app_vars.dig(@data["env"], key) || app_vars[key]
       end
 
+      def get_namespace()
+        get("namespace") || @data['env']
+      end
+
       def cpu(req_type)
         default_cpu_string = @data["config"]["default_cpu_string"] || "50m/250m"
         (request, limit) = (get("cpu") || default_cpu_string).split("/")
@@ -42,8 +46,24 @@ module Pfab
         }
       end
 
+      # overridden in subtypes
+      def application_type
+        "base"
+      end
+
+      def deploy_id
+        "#{@data['application']}.#{application_type}.#{@data['deployed_name']}"
+      end
+
       def env_vars
-        env_vars = { "DEPLOYED_NAME" => { value: @data['deployed_name'] } }
+        env_vars = { "DEPLOYED_NAME" => { value: @data['deployed_name'] },
+                     "DEPLOY_ID" => { value: deploy_id },
+                     "POD_ID" => { valueFrom: { fieldRef: { fieldPath: 'metadata.name' } } },
+                     "SPEC_NODENAME" => { valueFrom: { fieldRef: { fieldPath: 'spec.nodeName' } } },
+                     "DD_ENV" => { valueFrom: { fieldRef: { fieldPath: "metadata.labels['tags.datadoghq.com/env']" } } },
+                     "DD_SERVICE" => { valueFrom: { fieldRef: { fieldPath: "metadata.labels['tags.datadoghq.com/service']" } } },
+                     "DD_VERSION" => { valueFrom: { fieldRef: { fieldPath: "metadata.labels['tags.datadoghq.com/version']" } } }
+        }
 
         # load defaults
         load_env_vars(env_vars, @data.dig("application_yaml", :environment))
@@ -65,6 +85,11 @@ module Pfab
             env_vars[env_var_name] = { valueFrom: {
               fieldRef: { fieldPath: field_name }
             } }
+          elsif v.to_s.start_with? "configmap/"
+             (_, configmap_name, key_name) = v.split("/")
+             env_vars[env_var_name] = { valueFrom: {
+               configMapKeyRef: { name: configmap_name, key: key_name }
+             } }
           else
             env_vars[env_var_name] = { value: v }
           end

data/lib/pfab/templates/cron.rb

@@ -5,17 +5,25 @@ module Pfab
         f << YAML.dump(job.deep_stringify_keys)
       end
 
+      def application_type
+        "cron"
+      end
+
       def job
         {
-          apiVersion: "batch/v1beta1",
+          apiVersion: "batch/v1",
           kind: "CronJob",
           metadata: {
             name: "#{@data['deployed_name']}-#{@data['sha']}",
-            namespace: @data['env'],
+            namespace: get_namespace,
             labels: {
               application: @data['application'],
               "deployed-name" => @data['deployed_name'],
-              "application-type" => "job",
+              "application-type" => application_type,
+              "deploy-id" => deploy_id,
+              "tags.datadoghq.com/env": @data['env'],
+              "tags.datadoghq.com/service": @data['deployed_name'],
+              "tags.datadoghq.com/version": "#{@data['sha']}"
             }
           },
           spec: {
@@ -39,10 +47,13 @@ module Pfab
                       application: @data['application'],
                       "deployed-name" => @data['deployed_name'],
                       "application-type" => "cron",
+                      "tags.datadoghq.com/env": @data['env'],
+                      "tags.datadoghq.com/service": @data['deployed_name'],
+                      "tags.datadoghq.com/version": "#{@data['sha']}"
                     },
                   },
                   spec: {
-
+                    serviceAccountName: get('serviceAccountName'),
                     containers: [
                       {
                         image: image_name,
@@ -53,7 +64,7 @@ module Pfab
                       },
                     ],
                     restartPolicy: "Never",
-                  },
+                  }.compact,
                 },
                 backoffLimit: 2,
               },

data/lib/pfab/templates/daemon.rb

@@ -5,17 +5,25 @@ module Pfab
         f << YAML.dump(deployment.deep_stringify_keys)
       end
 
+      def application_type
+        "daemon"
+      end
+
       def deployment
         {
           kind: "Deployment",
           apiVersion: "apps/v1",
           metadata: {
             name: @data['deployed_name'],
-            namespace: @data['env'],
+            namespace: get_namespace,
             labels: {
               application: @data['application'],
               "deployed-name" => @data['deployed_name'],
-              "application-type" => "daemon",
+              "application-type" => application_type,
+              "deploy-id" => deploy_id,
+              "tags.datadoghq.com/env": @data['env'],
+              "tags.datadoghq.com/service": @data['deployed_name'],
+              "tags.datadoghq.com/version":"#{@data['sha']}"
             }
           },
           spec: {
@@ -35,9 +43,13 @@ module Pfab
                   application: @data['application'],
                   "deployed-name" => @data['deployed_name'],
                   "application-type" => "daemon",
+                  "tags.datadoghq.com/env": @data['env'],
+                  "tags.datadoghq.com/service": @data['deployed_name'],
+                  "tags.datadoghq.com/version": "#{@data['sha']}"
                 },
               },
               spec: {
+                serviceAccountName: get('serviceAccountName'),
                 containers: [
                   {
                     image: image_name,
@@ -47,9 +59,9 @@ module Pfab
                     resources: resources,
                   }
                 ]
-              },
+              }.compact,
             },
-          },
+          }.compact,
         }
       end
     end

data/lib/pfab/templates/job.rb

@@ -5,31 +5,43 @@ module Pfab
         f << YAML.dump(job.deep_stringify_keys)
       end
 
+      def application_type
+        "job"
+      end
+
       def job
         {
           apiVersion: "batch/v1",
           kind: "Job",
           metadata: {
             name: "job-#{@data['deployed_name']}-#{@data['sha']}",
-            namespace: @data['env'],
+            namespace: get_namespace,
             labels: {
               application: @data['application'],
               "deployed-name" => @data['deployed_name'],
-              "application-type" => "job",
+              "application-type" => application_type,
+              "deploy-id" => deploy_id,
+              "tags.datadoghq.com/env": @data['env'],
+              "tags.datadoghq.com/service": @data['deployed_name'],
+              "tags.datadoghq.com/version":"#{@data['sha']}"
             }
           },
           spec: {
             template: {
               metadata: {
                 name: "#{@data['deployed_name']}-#{@data['sha']}",
-                namespace: @data['env'],
+                namespace: get_namespace,
                 labels: {
                   application: @data['application'],
                   "deployed-name" => @data['deployed_name'],
                   "application-type" => "job",
+                  "tags.datadoghq.com/env": @data['env'],
+                  "tags.datadoghq.com/service": @data['deployed_name'],
+                  "tags.datadoghq.com/version": "#{@data['sha']}"
                 },
               },
               spec: {
+                serviceAccountName: get('serviceAccountName'),
                 containers: [
                   {
                     image: image_name,
@@ -40,7 +52,7 @@ module Pfab
                   },
                 ],
                 restartPolicy: "Never",
-              },
+              }.compact,
             },
             backoffLimit: 0,
           },

data/lib/pfab/templates/web.rb

@@ -6,7 +6,11 @@ module Pfab
           puts "No host to deploy to for #{@data['deployed_name']}. Skipping."
         else
           f << YAML.dump(service.deep_stringify_keys)
-          f << YAML.dump(ingress.deep_stringify_keys)
+          if not app_vars.has_key?('generateIngressEnabled') || app_vars['generateIngressEnabled']
+            f << YAML.dump(ingress.deep_stringify_keys)
+          else
+            puts "skipping ingress because ingress_disabled = #{@data['generateIngressEnabled']}"
+          end
           f << YAML.dump(deployment.deep_stringify_keys)
         end
       end
@@ -17,11 +21,12 @@ module Pfab
           kind: "Service",
           metadata: {
             name: @data['deployed_name'],
-            namespace: @data['env'],
+            namespace: get_namespace,
             labels: {
               application: @data['application'],
               "deployed-name" => @data['deployed_name'],
-            }
+            },
+            annotations: service_annotations,
           },
           spec: {
             selector: {
@@ -31,20 +36,27 @@ module Pfab
               {
                 name: "http",
                 port: 80,
-                targetPort: get("port"),
-              }
+                targetPort: app_vars["port"],
+                appProtocol: app_vars["appProtocol"]
+              }.compact
             ]
           }
         }
       end
 
+      def service_annotations
+        h = {}
+        h["traefik.ingress.kubernetes.io/service.serversscheme"] = "h2c" if get("protocol") == "h2c"
+        h
+      end
+
       def ingress
         {
           apiVersion: "networking.k8s.io/v1",
           kind: "Ingress",
           metadata: {
             name: "ingress-#{@data['deployed_name']}",
-            namespace: @data['env'],
+            namespace: get_namespace,
             labels: {
               application: @data['application'],
               "deployed-name" => @data['deployed_name'],
@@ -107,7 +119,6 @@ module Pfab
           "traefik.ingress.kubernetes.io/router.entrypoints" => "websecure",
           "traefik.ingress.kubernetes.io/router.tls" => "true"
         }
-        h["ingress.kubernetes.io/protocol"] = "h2c" if get("protocol") == "h2c"
         h
       end
 
@@ -130,17 +141,60 @@ module Pfab
         get("readinessProbe") || default_probe
       end
 
+      def startupProbe
+        get("startupProbe") || default_probe
+      end
+
+      def application_type
+        "web"
+      end
+
       def deployment
+        secret_mounts = get("secretMounts") || []
+        volume_mounts = []
+        volumes = []
+        secret_mounts.each do |secret_mount|
+          volumes.append({
+                           name: secret_mount['name'],
+                           secret: { secretName: secret_mount['secretName'] }
+                         })
+          volume_mounts.append({
+                                 name: secret_mount['name'],
+                                 mountPath: secret_mount['path'],
+                                 readOnly: secret_mount['readOnly'] || true
+                               })
+        end
+
+        if get("datadogVolumeMountEnabled")
+          datadog_volume_name = "ddsocket"
+          datadog_path = "/var/run/datadog"
+          volumes.append({
+                           name: datadog_volume_name,
+                           hostPath: {
+                            path: datadog_path
+                           }
+                         })
+          volume_mounts.append(
+            name: datadog_volume_name,
+            mountPath: datadog_path,
+            readOnly: true
+          )
+        end
+
         {
           kind: "Deployment",
           apiVersion: "apps/v1",
           metadata: {
             name: @data['deployed_name'],
-            namespace: @data['env'],
+            namespace: get_namespace,
             labels: {
               application: @data['application'],
               "deployed-name" => @data['deployed_name'],
-              "application-type" => "web",
+              "application-type" => application_type,
+              "deploy-id" => deploy_id,
+              "tags.datadoghq.com/env": @data['env'],
+              "tags.datadoghq.com/service": @data['deployed_name'],
+              "tags.datadoghq.com/version":"#{@data['sha']}"
             }
           },
           spec: {
@@ -165,9 +219,13 @@ module Pfab
                   application: @data['application'],
                   "deployed-name" => @data['deployed_name'],
                   "application-type" => "web",
+                  "tags.datadoghq.com/env": @data['env'],
+                  "tags.datadoghq.com/service": @data['deployed_name'],
+                  "tags.datadoghq.com/version": "#{@data['sha']}"
                 },
               },
               spec: {
+                serviceAccountName: get('serviceAccountName'),
                 containers: [
                   {
                     image: image_name,
@@ -175,13 +233,26 @@ module Pfab
                     command: get("command").split(" "),
                     env: env_vars,
                     resources: resources,
+                    ports: [
+                      {
+                        name: "main",
+                        containerPort: app_vars["port"]
+                      },
+                      {
+                        name: "health-port",
+                        containerPort: 8085 # the default micronaut endpoint port
+                      }
+                    ],
                     livenessProbe: livenessProbe,
                     readinessProbe: readinessProbe,
+                    startupProbe: startupProbe,
+                    volumeMounts: volume_mounts
                   }
-                ]
-              },
+                ],
+                volumes: volumes
+              }.compact,
             },
-          },
+          }.compact,
         }
       end
     end

data/lib/pfab/version.rb

@@ -1,7 +1,7 @@
 module Pfab
   module Version
     MAJOR = 0
-    MINOR = 33
+    MINOR = 34
     PATCH = 0
     BUILD = nil
 

data/pfab.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: pfab 0.33.0 ruby lib
+# stub: pfab 0.34.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pfab".freeze
-  s.version = "0.33.0"
+  s.version = "0.34.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".tool-versions",
+    "CODEOWNERS",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pfab
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - Jeff Dwyer
@@ -133,6 +133,7 @@ extra_rdoc_files:
 files:
 - ".document"
 - ".tool-versions"
+- CODEOWNERS
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt