pfab 0.47.0 → 0.47.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e28fe9d6553bcc3431be88840b25a125f3e09d63b8d7f7cd64ad2dc228c24e1
-  data.tar.gz: 799b4f11d0f403817e5463b436febe46dc9c1f34a29b0fe49891c303f3562b30
+  metadata.gz: dbb68461622144901fb5d3ccb9a2b7b61d4ed6f0ff84ac3e5c460bb71da57c50
+  data.tar.gz: ded9c69475e17fc6372929e4d8ba15a9a44658465c3bf540acbe5a969cf0ab47
 SHA512:
-  metadata.gz: d3706eed717012e358490617bc783e1308908638e1747cd16183c9a64bcb42371b9018811229be295d2930ead49ec7ddf10d049e758b93bb15eae4c72883931d
-  data.tar.gz: 85d3b5dee612fa22765d0149faa2e4420d7d2466908f4638e7c30a5c7e675ccdea41aa725002168fb218d0be353573d53827dcbf69e062a46b42504b0bb53f26
+  metadata.gz: 0eb4a105bddccb81cd41aff0a3f8a7d1823bfce820e7e96e396815fb99d4b083330838c4ce5f41a767889122fbad585301ccd404f2e079d1910e5b03329b0a13
+  data.tar.gz: c3051634c832771bcc004d78188c8aaf31cfafd8a8b81db84539895e6dc41c99b314743cad87d54be1fac9e41618a328d0b98ef7e4bd74fd9a1627f45052031e

data/README.markdown

@@ -1,8 +1,128 @@
 pfab
 ===================
 
-The missing k8s deployer
+The missing kubernetes deployer / utility
 
+## Why?
+pfab's goal is to let you write a clear, concise `application.yaml` and then "just work". 
+If you have a kubernetes cluster, a functioning local application and CI, you should be able to create your first deployment done
+in 5 minutes.
+
+pfab is designed to support strong opinions, but you're free to have whatever opinion you like by having your own deployable types.
+
+This is what we use to deploy [Prefab](https://prefab.cloud/). 
+
+## Example
+
+This is an example of a simple application.yaml that we hope is self explanatory.
+
+```yaml
+# application.yaml
+name: myapp
+
+deployables:
+  dbmigrate:
+    type: job
+    command: bundle exec rake db:migrate
+  upsert-usage-logs:
+    type: cron
+    schedule: 2 6 * * *
+    command: bundle exec rake upsert-logs
+  application:
+    type: web
+    command: bundle exec rails server
+    staging:
+      host: api.staginghost.com
+      replicas: 1
+    production:
+      host: api.host.com
+      replicas: 2
+      
+staging:
+  environment:
+    RAILS_ENV: "staging"
+production:
+  environment:
+    RAILS_ENV: "production"
+```
+Given an `application.yaml` like this we can run:
+```bash
+~/Documents/workspace/myapp (main)  $ pfab shipit
+# Check image repository for an image or build and push one
+# Generate kubernetes yaml
+# Apply kubernetes yaml
+
+# Now we can quickly check the status
+~/Documents/workspace/myapp (main)  $ pfab status
+kubectl config use-context staging
+Switched to context "staging".
+kubectl get ingresses,jobs,services,cronjobs,deployments,pods -l application=myapp --namespace=myapp 
+NAME                                                    CLASS    HOSTS                  ADDRESS   PORTS     AGE
+ingress.networking.k8s.io/ingress-myapp-web-web   <none>   api.staginghost.com             80, 443   224d
+
+NAME                                               COMPLETIONS   DURATION   AGE
+job.batch/job-myapp-job-dbmigrate-7854c854   1/1           3m34s      205d
+
+NAME                          TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)   AGE
+service/myapp-web-web   ClusterIP   10.1.1.1    <none>        80/TCP    224d
+
+NAME                                                             SCHEDULE    SUSPEND   ACTIVE   LAST SCHEDULE   AGE
+cronjob.batch/myapp-cron-upsert-usage-logs-92d90b8e   2 6 * * *   False     0        <none>          62m
+
+NAME                                  READY   UP-TO-DATE   AVAILABLE   AGE
+deployment.apps/myapp-web-web   1/1     1            1           224d
+
+NAME                                       READY   STATUS    RESTARTS   AGE
+pod/myapp-web-web-8678649967-fqfgb   1/1     Running   0          42h
+
+# or tail the logs
+~/Documents/workspace/myapp (master)  $ pfab logs
+kubectl config use-context prefab-cloud-staging
+Switched to context "prefab-cloud-staging".
+which app?
+1. myapp-job-dbmigrate
+2. myapp-web-web
+3. myapp-cron-upsert-usage-logs
+?  2
+kubectl logs -f myapp-web-web-8678649967-fqfgb --namespace=myapp 
+=> Booting Puma
+=> Rails 5.1.7 application starting in staging 
+...
+
+# or exec into a pod
+~/Documents/workspace/myapp (master)  $ pfab exec
+kubectl config use-context staging
+Switched to context "staging".
+which app?
+1. myapp-web-web
+?  1
+kubectl exec -it myapp-web-web-8678649967-fqfgb --namespace=myapp -- /bin/sh
+# _
+
+```
+
+## Deployable Types
+pfab supports `web`, `job`, `cron`, and `daemon` deployables. Each deployable type is just a ruby file that outputs json. To add your own you could simply create / modify the `web.rb`. Best practice is to put as much messy, boiler plate as possible into the templates and keep the `application.yaml` as clean as possible. An example of a deployable is [cron.rb](https://github.com/prefab-cloud/pfab/blob/main/lib/pfab/templates/cron.rb).
+
+
+## What it Does
+```
+  COMMANDS:
+        
+    apply         kubectl apply         
+    build         build image           
+    clean         clean up pods         
+    exec          kubectl exec into a pod              
+    generate_yaml build k8s yaml from application.yaml    
+    logs          tail logs             
+    restart       rolling restart of a deployment                       
+    run_local     run an app locally            
+    shipit        build, generate, apply                
+    status        status of an app      
+```
+
+## Project Status
+This is very much an internal tool today. It would be worth having a conversation before using it yourself. You may want to just fork it and have it your way.
 
 ## Setup
 
@@ -19,6 +139,15 @@ envs:
 ```
 
 # application.yaml
+Supported Features (see examples below)
+- Env Vars & env specific env vars
+- Secrets from k8s secrets
+- Config Maps & env_from
+- Custom probes
+- cpu/memory limits
+- TLS certs
+- GRPC / h2c
+
 ```$yaml
 name: myapp
 prebuild: "mvn -T 4 clean package"
@@ -80,16 +209,6 @@ environment:
 ```
 
 
-
-# Profit
-```
-pfab shipit
-pfab status
-pfab logs
-pfab exec
-pfab run_local
-```
-
 Contributing to pfab
 ------------------------------------------
 

data/lib/pfab/cli.rb

@@ -211,11 +211,9 @@ module Pfab
         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")
-
-        # watch
-        selector = "application=#{@application_yaml['name']}"
-        kubectl "get pods -l #{selector} -w"
       end
+      selector = "application=#{@application_yaml['name']}"
+      kubectl "get pods -l #{selector} -w"
     end
 
     def image_exists?(full_image_name)

data/lib/pfab/version.rb

@@ -2,7 +2,7 @@ module Pfab
   module Version
     MAJOR = 0
     MINOR = 47
-    PATCH = 0
+    PATCH = 1
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/pfab.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: pfab 0.47.0 ruby lib
+# stub: pfab 0.47.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pfab".freeze
-  s.version = "0.47.0"
+  s.version = "0.47.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jeff Dwyer".freeze]
-  s.date = "2023-11-03"
+  s.date = "2023-12-19"
   s.description = "k8s helper".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.executables = ["pfab".freeze]
@@ -44,19 +44,33 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/prefab-cloud/pfab".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.4.6".freeze
+  s.rubygems_version = "3.3.7".freeze
   s.summary = "helper gem".freeze
 
-  s.specification_version = 4
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
 
-  s.add_runtime_dependency(%q<commander>.freeze, [">= 0"])
-  s.add_runtime_dependency(%q<activesupport>.freeze, [">= 0"])
-  s.add_runtime_dependency(%q<pry-byebug>.freeze, [">= 0"])
-  s.add_runtime_dependency(%q<styled_yaml>.freeze, ["~> 0.0.1"])
-  s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
-  s.add_development_dependency(%q<bundler>.freeze, ["~> 2.3"])
-  s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4.9"])
-  s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
-  s.add_development_dependency(%q<test-unit>.freeze, [">= 0"])
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<commander>.freeze, [">= 0"])
+    s.add_runtime_dependency(%q<activesupport>.freeze, [">= 0"])
+    s.add_runtime_dependency(%q<pry-byebug>.freeze, [">= 0"])
+    s.add_runtime_dependency(%q<styled_yaml>.freeze, ["~> 0.0.1"])
+    s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_development_dependency(%q<bundler>.freeze, ["~> 2.3"])
+    s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4.9"])
+    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_development_dependency(%q<test-unit>.freeze, [">= 0"])
+  else
+    s.add_dependency(%q<commander>.freeze, [">= 0"])
+    s.add_dependency(%q<activesupport>.freeze, [">= 0"])
+    s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
+    s.add_dependency(%q<styled_yaml>.freeze, ["~> 0.0.1"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 2.3"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2.4.9"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<test-unit>.freeze, [">= 0"])
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pfab
 version: !ruby/object:Gem::Version
-  version: 0.47.0
+  version: 0.47.1
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: helper gem