seira 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c56a6815270947a2915bcb6cb95f9fbeecc50b607557be8bafa0d957590cf4d
-  data.tar.gz: 8be5c3f5488ce6aa79a79e5b4ec574325ac70f9d999c63c7ece6fea14df97d16
+  metadata.gz: 06e2e516ae84d1bcdc4f3320eeb13c83dc6cd162bfbe5e249b53e2b3af74885c
+  data.tar.gz: 027a214ded3ab47b25fe29b9e8943bd268fe908ff9aa87993ffa07e9c395e350
 SHA512:
-  metadata.gz: 45e01a9b78960db1e1a9bce63169b90f913321a8f18acbfb7657c1aa930390ba493bc2074e1f8a485f38df04e011ef837af598ab3b268273ce3583c0d6ec1348
-  data.tar.gz: 4383b3e47a808a5ee602e6d7c4a9f95327f24b4ffddd0414e95067e04cac0a00ca86cffd56bf42ebefa4b6e25fddae65729f5fdfca963e693c2708c97d16c498
+  metadata.gz: f6cc9ea8137d0ae4578a5fbdbeac88f8e8d01916dd8e64f8dc83d4ac30517fda718ae06d0d02b5c354e9d80e3ee3ab3f75df433dda45ac85b60e512cc878b058
+  data.tar.gz: 828524836a6abc488bc29a3333733887e57b39351f9d54b8ecb9986c49520abd6e8564b97425f702fed90b2256f68c558303c76ee6be49fc58362a3898fc4f32

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on: push
+
+jobs:
+  test:
+
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        ruby-version: ['2.6.3', '2.7.2']
+
+    steps:
+      # Pin to this commit: v2
+      - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+      - name: Set up Ruby
+        # Pin to this commit, v1.82.0
+        uses: ruby/setup-ruby@5e4f0a10bfc39c97cd5358121291e27e5d97e09b
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/README.md

@@ -1,7 +1,7 @@
 # Seira
 
 [![Gem Version](https://badge.fury.io/rb/seira.svg)](https://badge.fury.io/rb/seira)
-[![Build Status](https://travis-ci.org/joinhandshake/seira.svg?branch=master)](https://travis-ci.org/joinhandshake/seira)
+[![Build Status](https://github.com/joinhandshake/seira/actions/workflows/ruby.yml/badge.svg)](https://github.com/joinhandshake/seira/actions)
 
 An opinionated library for building applications on Kubernetes.
 
@@ -83,6 +83,15 @@ seira:
 
 This specification is read in and used to determine what `gcloud` context to use and what `kubectl` cluster to use when operating commands. For example, `seira internal` will connect to `org-internal` gcloud configuration and `gke_org-internal_us-central1-a_internal` kubectl cluster. For shorthand, `seira i` shorthand is specified as an alias.
 
+### Application Configuration Files
+
+Each app can also define configuration files. These files specify details that allow seira to execute commands with minimal user input, and declare aspects of the application. This file lives in the app folder with the name `.seira.app.yaml`. An example configuration file:
+
+```
+# The name of the sql instance as it shows in GCP Cloud SQL UI
+primary_sql_instance: app-database-name
+```
+
 ### Regions and Zones
 
 All clusters should have a `region` option specified. For zonal clusters (clusters that are NOT regional) should also specify their `zone`.
@@ -156,7 +165,7 @@ Pods can be listed and also exec'd into.
 
 `seira staging app-name pods list`
 
-`seira staging app-name pods run`
+`seira staging app-name pods connect --pod=<POD-NAME>`
 
 ## Development
 

data/lib/helpers.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module Seira
   class Helpers
     include Seira::Commands
@@ -37,6 +39,13 @@ module Seira
         Secrets.new(app: context[:app], action: 'get', args: [], context: context).get(key)
       end
 
+      def get_seira_app_config(context:)
+        yaml_file_path = "kubernetes/#{context[:cluster]}/#{context[:app]}/.seira.app.yaml"
+        YAML.load_file(yaml_file_path)
+      rescue
+        fail "Failed to load the configuration file at #{yaml_file_path}. Please add configuration file and retry."
+      end
+
       def get_current_replicas(deployment:, context:)
         output = Seira::Commands.kubectl("get deployment #{deployment} -o json", context: context, return_output: true)
         JSON.parse(output)['spec']['replicas']

data/lib/seira/db.rb

@@ -75,16 +75,8 @@ module Seira
       end
     end
 
-    # NOTE: Relies on the pgbouncer instance being named based on the db name, as is done in create command
     def primary_instance
-      database_url = Helpers.get_secret(context: context, key: 'DATABASE_URL')
-      return nil unless database_url
-
-      primary_uri = URI.parse(database_url)
-      host = primary_uri.host
-
-      # Convert handshake-onyx-burmese-pgbouncer-service to handshake-onyx-burmese
-      host.gsub('-pgbouncer-service', '')
+      Seira::Helpers.get_seira_app_config(context: context)['primary_sql_instance']
     end
 
     private
@@ -331,10 +323,13 @@ module Seira
 
     def run_psql
       as_admin = false
+      instance_name = nil
 
       args.each do |arg|
         if arg == '--as-root-user'
           as_admin = true
+        elsif arg.start_with? '--instance='
+          instance_name = arg.split('=')[1]
         else
           puts "Warning: Unrecognized argument '#{arg}'"
         end
@@ -344,7 +339,7 @@ module Seira
         puts "!! Warning !!! You are running as root PSQL user `postgres`. This super user account has full admin priveleges. Use with extreme care."
       end
 
-      execute_db_command(nil, interactive: true, as_admin: as_admin)
+      execute_db_command(nil, interactive: true, instance_name: instance_name, as_admin: as_admin)
     end
 
     def run_table_sizes
@@ -488,6 +483,8 @@ module Seira
       # TODO(josh): move pgbouncer naming logic here and in Create to a common location
       instance_name ||= primary_instance
       private_ip = Helpers.sql_ips(instance_name, context: context)[:private]
+
+      # NOTE: Relies on the pgbouncer instance being named based on the db name, as is done in create command
       pgbouncer_tier ||= instance_name.gsub("#{app}-", '')
       matching_pods = Helpers.fetch_pods(context: context, filters: { tier: pgbouncer_tier })
       if matching_pods.empty?

data/lib/seira/jobs.rb

@@ -57,7 +57,19 @@ module Seira
     def run_help
       puts SUMMARY
       puts "\n\n"
-      puts "TODO"
+      puts <<~HELPTEXT
+        help:      Display the help page.
+        list:      List the currently running jobs in the given application namespace.
+        delete:    Delete a stuck migration job via Kubernetes job 'seira cluster app delete job-name'.
+        run:       Execute a given command to issue a schema migration.
+
+        options:
+          --template-file: Provide a job template file to use. (--template-file=template.yaml.erb)
+          --async:         Wait for the job to finish before exiting.
+          --no_delete:     Do not delete the Kubernetes job after it is finished.
+          --size:          Use a predetermined resource sizing template for this job. (Default size: 1)
+
+      HELPTEXT
     end
 
     def run_list
@@ -75,6 +87,7 @@ module Seira
       async = false # Wait for job to finish before continuing.
       no_delete = false # Delete at end
       resource_hash = RESOURCE_SIZES['1']
+      template_file = "template.yaml"
 
       # Loop through args and process any that aren't just the command to run
       loop do
@@ -94,6 +107,8 @@ module Seira
         elsif arg.start_with?('--size=')
           size = arg.split('=')[1]
           resource_hash = RESOURCE_SIZES[size]
+        elsif arg.start_with?('--template-file=')
+          template_file = arg.split('=')[1]
         else
           puts "Warning: Unrecognized argument #{arg}"
         end
@@ -113,7 +128,7 @@ module Seira
 
       source = "kubernetes/#{context[:cluster]}/#{app}" # TODO: Move to method in app.rb
       Dir.mktmpdir do |destination|
-        file_name = discover_job_template_file_name(source)
+        file_name = discover_job_template_file_name(source, template_file)
 
         FileUtils.mkdir_p destination # Create the nested directory
         FileUtils.copy_file "#{source}/jobs/#{file_name}", "#{destination}/#{file_name}"
@@ -174,11 +189,11 @@ module Seira
       end
     end
 
-    def discover_job_template_file_name(source)
-      if File.exist?("#{source}/jobs/template.yaml.erb")
-        "template.yaml.erb"
+    def discover_job_template_file_name(source, template_file)
+      if File.exist?("#{source}/jobs/#{template_file}.erb")
+        "#{template_file}.erb"
       else
-        "template.yaml"
+        template_file
       end
     end
   end

data/lib/seira/pods.rb

@@ -31,8 +31,6 @@ module Seira
         run_top
       when 'connect'
         run_connect
-      when 'run'
-        run_run
       else
         fail "Unknown command encountered"
       end

data/lib/seira/random.rb

@@ -70,7 +70,6 @@ module Seira
         bombay
         bongo
         bonobo
-        booby
         budgerigar
         buffalo
         bulldog
@@ -120,7 +119,6 @@ module Seira
         dachshund
         dalmatian
         deer
-        dhole
         dingo
         dinosaur
         discus
@@ -193,7 +191,6 @@ module Seira
         hippopotamus
         hornet
         horse
-        human
         hummingbird
         hyena
         ibis

data/lib/seira/version.rb

@@ -1,3 +1,3 @@
 module Seira
-  VERSION = "0.7.3".freeze
+  VERSION = "0.7.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seira
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.5
 platform: ruby
 authors:
 - Scott Ringwelski
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -103,12 +103,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".default-rubocop.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -143,7 +143,7 @@ homepage: https://github.com/joinhandshake/seira
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: An opinionated library for building applications on Kubernetes.
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-language: ruby
-notifications:
-  email: false
-rvm:
-  - 2.5.3
-before_install: gem install bundler