chopshop-logreader 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6832e1640a4f8c99cfbdc2a010d39aac2510891a8505445e7ea5ce7e0f8d981
-  data.tar.gz: 50d99bafbfa934f38a0a5e4bd7cf730863be08f83af926813beea6ed652b5581
+  metadata.gz: aa1d6a0266d4f7ee6fe20dd3a0d0e5042e1f587f5d276ba11a514b811742ff1c
+  data.tar.gz: d90185bece540bbce81b47e31a8346ad976f17ed54688d0234c26a3f277c62bf
 SHA512:
-  metadata.gz: 02bb0cc3fd4371687cf0a90fc8b6e0b2d60b44e883da50b7b1b659a177fef8079044ef44f7fcfed316f7802fb40ec86763f764bdba5259e8ac73b5d0567756c9
-  data.tar.gz: 3cdea25e30bc8f814ec426a3a39cd4a561a459679d01a651c70d8da98acb2c0c2d4d9b5b7493dd3229548ee67eb9973c3d9899e2e524c274e84d74c8c7b78ed7
+  metadata.gz: 3bd32954bfc925ff2194b51ea5704764152b248134a5e228b30973d5f7c2991fb8cccf540db357193fe76508a2ba03cb54dc271223cf1a4946ed2fc035614045
+  data.tar.gz: a993a805d2f281005b75b64cbc94deae2fc1401ec19d29a5f08370e6f426cc28c13664349050c21703b6394afefd34d21a286b33b2939537afd5ca01bdc6bf36

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chopshop-logreader (0.1.1)
+    chopshop-logreader (0.2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -13,10 +13,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.2)
   chopshop-logreader!
   minitest (~> 5.0)
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.17.2
+   2.2.33

data/README.md

@@ -1,5 +1,6 @@
 # Chopshop::Logreader
 
+This is a simple CLI tool that allows you to find & follow the logs for the most recently running kubernetes pod with a given name for a given status (default status is "Running"). As of now there is no support for searching for pods that started running in a given window of time, although that is a possible feature add if requested. if a valid pod is not found, it will ping the API once a second until one is found or the program is exited. This primarily just wraps some `kubectl` commands and handles parsing the output in standard way to quickly find a pod's logs.
 
 ## Installation
 
@@ -11,20 +12,66 @@ gem 'chopshop-logreader'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install chopshop-logreader
+```bash
+gem install chopshop-logreader
+```
+
+## Getting started
+
+This gem assumes 2 things.
+
+1. you will provide a cloud provider profile (think aws) via one of 3 sources:
+    - an option on the command line (`-p PROFILE` or `--profile PROFILE`)
+    - via the ENV VAR `AWS_PROFILE`
+    - via the ENV VAR `PROFILE`
+
+2. you will provide a tenant via one of 2 sources:
+    - an option on the command line (`t TENANT` or `--tenant TENANT`)
+    - via the ENV VAR `DEFAULT_TENANT`
+
+Ideally you will set those env vars before starting.
 
 ## Usage
 
-`chopshop-logreader -h` to get help
-example use:
-`chopshop-logreader SERVICE_NAME_HERE -n connect -s Running -l 10 -f false`
-default use:
-`chopshop-logreader profile-reader` expands to `chopshop-logreader profile-reader -n connect -s Running -l -1 -f true`
+to get help:
+
+```bash
+chopshop-logreader -h
+```
+
+example uses:
+
+```bash
+chopshop-logreader SERVICE_NAME_HERE -n connect -s Completed -l 10 -f false
+```
+
+```bash
+chopshop-logreader SERVICE_NAME_HERE -n connect -s Error -l -1 -f true
+```
+
+```bash
+chopshop-logreader SERVICE_NAME_HERE -n connect -s Error -l -1 -f true -t some-cool-tenant-name -p my-cool-aws-dev-profile
+```
+
+### Default Use
+
+```bash
+chopshop-logreader profile-reader
+```
+
+expands to
+
+```bash
+chopshop-logreader profile-reader -n connect -s Running -l -1 -f true
+```
 
+the default use also assumes your have set the ENV VARS `DEFAULT_TENANT` and either `AWS_PROFILE` or `PROFILE`
 
 ## Development
 
@@ -43,3 +90,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Chopshop::Logreader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chopshop-logreader/blob/master/CODE_OF_CONDUCT.md).
+
+## Project TODO
+
+- add a startup script that will set the default profile/tenant for a user

data/chopshop-logreader.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

data/lib/chopshop/logreader/executor.rb

@@ -24,22 +24,30 @@ module Chopshop
 
       def execute!
         options = @parser.parse 
-
-        container = nil
-        service = ARGV[0]
-        puts "looking for valid container"
-        while !container
-          containers = `kubectl get pods --namespace #{options[:namespace]} | grep #{service}`
-          container = containers.split("\n").map {|line| line.split(" ") }.each do |line|
+        profile = options.profile || ENV["AWS_PROFILE"] || ENV["PROFILE"]
+        tenant = options.tenant || ENV["DEFAULT_TENANT"]
+        region = options.region || ENV["AWS_REGION"] || "us-east-1"
+        container = options.container
+
+        service = nil
+        service_name = ARGV[0]
+        `rally-kubectl -a #{region} -e #{profile} -t #{tenant}`
+        puts "looking for valid service container"
+        while !service
+          services = `kubectl get pods --namespace #{options.namespace} | grep #{service_name}`
+          service = services.split("\n").map {|line| line.split(" ") }.each do |line|
             match_data = REGEX.match(line[4])
             line[5] = TIME_CALCULATOR[match_data.captures[1].downcase] * match_data.captures[0].to_i + TIME_CALCULATOR[match_data.captures[3].downcase] * match_data.captures[2].to_i
-          end.select{|line| line[2] == options[:status] }.sort_by {|line| line[5] }.first
-
-          if container
-            exec "kubectl logs --follow=#{options[:follow]} --tail=#{options[:lines]} --namespace connect #{container[0]}"
+          end.select{|line| line[2] == options.status }.sort_by {|line| line[5] }.first
+
+          if service
+            if container
+              exec "kubectl logs --follow=#{options.follow} --tail=#{options.lines} --namespace connect --container=#{container} #{service[0]}"
+            else
+              exec "kubectl logs --follow=#{options.follow} --tail=#{options.lines} --namespace connect #{service[0]}"
+            end
           end
 
-
           print "."
           sleep 1
         end

data/lib/chopshop/logreader/parser.rb

@@ -1,18 +1,24 @@
 require "optparse"
+require 'ostruct'
 
 module Chopshop
   module Logreader
     class Parser
       def parse
-        options = {
+        options = OpenStruct.new(
           follow: true, # follow output from log file
           lines: -1, # whole file always,
-          status: "Running", # look for a currently running container
-          namespace: "connect"
-        }
+          status: "Running", # look for a currently running service
+          namespace: "connect",
+          tenant: nil,
+          profile: nil,
+          region: nil,
+          container: nil
+        )
+
 
         OptionParser.new do |opts|
-          opts.banner = "Usage: ruby log-reader.rb SERVICE [options]"
+          opts.banner = "Usage: chopshop-logreader SERVICE [options]"
 
           opts.on("-f [FOLLOW]", "--follow [FOLLOW]", "boolean true/false on whether to follow output from the file. default: true", TrueClass) do |follow|
             options[:follow] = follow
@@ -22,14 +28,29 @@ module Chopshop
             options[:lines] = lines
           end
 
-          opts.on("-s [STATUS]", "--status [STATUS]", "valid values: Completed|Running|Error. will only look for containers with the given status. default: Running", String) do |status|
+          opts.on("-s [STATUS]", "--status [STATUS]", "valid values: Completed|Running|Error. will only look for services/jobs with the given status. default: Running", String) do |status|
             options[:status] = status
           end
 
-          opts.on("-n [NAMESPACE]", "--namespace [NAMESPACE]", "sets the kubernetes namespace to look for containers in. default: connect", String) do |status|
+          opts.on("-n [NAMESPACE]", "--namespace [NAMESPACE]", "sets the kubernetes namespace to look for service/job in. default: connect", String) do |status|
             options[:status] = status
           end
 
+          opts.on("-p [PROFILE]", "--profile [PROFILE]", "chooses the cloud profile to use for permissions. default: nil.  You must provide this value or set the ENV VAR AWS_PROFILE' or the ENV VAR 'PROFILE'", String) do |profile|
+            options[:profile] = profile
+          end
+
+          opts.on("-r [REGION]", "--region [REGION]", "sets the cloud region to look for a tenant within. default: us-east-1.  You may also provide this value via the ENV VAR 'AWS_REGION'", String) do |region|
+            options[:region] = region
+          end
+
+          opts.on("-c [CONTAINER]", "--container [CONTAINER]", "sets the kubernetes tenant to look for containers in. default: nil. Often not needed", String) do |container|
+            options[:container] = container
+          end
+
+          opts.on("-t [TENANT]", "--tenant [TENANT]", "sets the kubernetes tenant to look for the service/job in. default: nil.  You must provide this value or set the ENV VAR DEFAULT_TENANT'", String) do |tenant|
+            options[:tenant] = tenant
+          end
 
           opts.on("-h", "--help", "Prints this help") do
             puts opts

data/lib/chopshop/logreader/version.rb

@@ -1,5 +1,5 @@
 module Chopshop
   module Logreader
-    VERSION = "0.1.2"
+    VERSION = "0.2.3"
   end
 end

data/lib/chopshop/logreader.rb

@@ -1,7 +1,6 @@
 module Chopshop
   module Logreader
     class Error < StandardError; end
-    # Your code goes here...
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chopshop-logreader
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Travis Perdue
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+description:
 email:
 - travis.perdue@rallyhealth.com
 executables:
@@ -87,7 +87,7 @@ metadata:
   homepage_uri: https://github.com/tperdue321/chopshop-logreader
   source_code_uri: https://github.com/tperdue321/chopshop-logreader
   changelog_uri: https://github.com/tperdue321/chopshop-logreader
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Read logs out of kubernetes
 test_files: []