helm_upgrade_logs 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 864a01e8bcbdeac4562c86337446da6a9f95915ced886c546f3914eccaca9bf9
-  data.tar.gz: 806925901b5506f6294c5c211bd8c2df91294118441273b02af469f70938f792
+  metadata.gz: 612089e7637694fdb0bca10be78d1cda044a99c3925a436867f0c7efd7ab5813
+  data.tar.gz: 0c83667889b979ca3bcd7ccf54d74ffe5c16e750de625977c117cbd53d25b536
 SHA512:
-  metadata.gz: 3bb83e455d0a989793547053ffbd46ad6be6fca3354405acf0d6f71c2a3ebafd9ef3a63e50efc6c8df079e163d1d7ed29757d9620459ea2798fe69deb4b2caa0
-  data.tar.gz: a2750e80477d1024c8b05a277f3ed34541c1f7860d61640ec6873f66a37e11bf652864d3c1df1603e2b6a96de227c9de31c852b70ba2593dc410cdead1c3dc3f
+  metadata.gz: 1edb515198878e0f9602001bc08ba9018d657b4c1efc569a0b2e46c57ba10395a81a578cd0c57ae300ab6aee01d4e2dcd62550c1203cb64cb66cd8de3f7d7d4f
+  data.tar.gz: 652c953b9d59e33a58d54d880a86be9058822ca286266735016d0a1a8fffa7fc41fc51537aca66db7d24e9531fb47009336c245ed32900caec141164fbc47805

data/.github/workflows/test.yml

@@ -53,5 +53,7 @@ jobs:
 #      run: sleep 70
     - name: Add bitnami repo
       run: helm repo add bitnami https://charts.bitnami.com/bitnami
-    - name: Install through gem exe
+    - name: Install bitnami
       run: ./exe/helm_upgrade_logs --install nginx bitnami/nginx --wait --debug --set service.type=ClusterIP --set replicaCount=2
+    - name: Install Redis
+      run: ./exe/helm_upgrade_logs --install redis bitnami/redis --set auth.enabled=false --version 14.0.2 --wait

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-## [Unreleased]
+## [0.2.0] - 2022-04-20
+
+- Monitor helm upgrade command and periodically reload getting logs when new pods appear
+
+## [0.1.6] - 2022-04-17
+
+- Add `helm_test_logs` exe to check logs during `helm test`
+- Add `pod-running-timeout` of 300s to try and pick up logs that might take a while to appear
+
+## [0.1.5] - 2022-04-16
+
+- Only look at logs for release name
 
 ## [0.1.4] - 2022-04-16
 

data/README.md

@@ -20,10 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-Still not working in a proper sense of a gem but the following kinda works if you want to install a release called `nginx` from the chart `bitnami/nginx`.
+This gem is purely about an `exe` to wrap around `helm` commands and to log helpful commands.
+Once installed, install/upgrade a helm chart with
 
+```bash
+helm_upgrade_logs --install redis bitnami/redis --set auth.enabled=false --version 14.0.2 --wait
 ```
-curl -s https://gitlab.com/samuel-garratt/helm_upgrade_logs/-/raw/master/bin/helm_upgrade_logs.sh | bash -s -- --install nginx bitnami/nginx
+
+After the `helm_upgrade_logs` command put any options that would normally add after `helm upgrade`.
+
+To test a chart showing it logs, in a similar way run
+```bash
+helm_test_logs redis
+```
+
+This also has a bash script which can be used directly. E.g., to install `nginx` from the chart `bitnami/nginx`.
+
+```
+curl -s https://raw.githubusercontent.com/SamuelGarrattIqa/helm_upgrade_logs/main/bin/helm_upgrade_logs.sh | bash -s -- --install nginx bitnami/nginx
 ```
 
 ## Development
@@ -34,7 +48,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/helm_upgrade_logs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/samuel-garratt/helm_upgrade_logs/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/SamuelGarrattIqa/helm_upgrade_logs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/SamuelGarrattIqa/helm_upgrade_logs/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -42,4 +56,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the HelmUpgradeLogs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/samuel-garratt/helm_upgrade_logs/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the HelmUpgradeLogs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SamuelGarrattIqa/helm_upgrade_logs/blob/main/CODE_OF_CONDUCT.md).

data/exe/helm_test_logs

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'helm_upgrade_logs'
+
+$release_name = ARGV.find { |arg| !arg.start_with?('-') }
+
+helm_pid = Process.spawn "helm test #{ARGV.join(' ')}"
+
+log_pid = Process.spawn "kubectl logs -lapp.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=#{$release_name} -f --all-containers --prefix --ignore-errors=true --max-log-requests=20 --timestamps=true"
+
+Process.wait helm_pid
+puts `kill #{log_pid}`

data/exe/helm_upgrade_logs

@@ -5,36 +5,27 @@ require 'open3'
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
 require 'helm_upgrade_logs'
 
-# Approach not ideal as it will for all containers to be ready and want to stream logs before that
-def wait_for_container_ready
-  wait_pid = Process.spawn 'kubectl wait --for=condition=ContainersReady pod --selector "app.kubernetes.io/managed-by=Helm" --timeout=30s'
-  Process.wait wait_pid
-end
-
-# Wait for pods with logs to be present
-# Not ideal due to https://github.com/kubernetes/kubernetes/issues/28746
-def wait_for_pod
-  90.times {
-    sleep 1
-    stdout, stderr, _ = Open3.capture3 "kubectl logs -lapp.kubernetes.io/managed-by=Helm"
-    if stderr.empty? && !stdout.strip.empty?
-      puts 'Pods with logs found'
-      break
-    else
-      puts "Waiting for pod logs: #{stderr}"
-    end
-  }
-end
+$release_name = ARGV.find { |arg| !arg.start_with?('-') }
 
 helm_pid = Process.spawn "helm upgrade #{ARGV.join(' ')}"
 
 event_pid = Process.spawn 'kubectl get events --watch-only=true'
 service_pid = Process.spawn 'kubectl get services --watch-only=true'
 
-wait_for_pod
-log_pid = Process.spawn 'kubectl logs -lapp.kubernetes.io/managed-by=Helm -f --all-containers --prefix --pod-running-timeout=20s --ignore-errors=true --max-log-requests=20 --timestamps=true'
+wait_for_pod_to_log
 
-Process.wait helm_pid
-puts `kill #{log_pid}`
+@pods = []
+
+while Process.waitpid(helm_pid, Process::WNOHANG) == nil do
+  pods = get_pods
+  if pods != @pods
+    @pods = pods
+    puts "[INFO] Pods: #{pods.join(',')}"
+    puts `kill #{@log_pid}` if @log_pid
+    @log_pid = Process.spawn "kubectl logs -lapp.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=#{$release_name} -f --all-containers --prefix --ignore-errors=true --max-log-requests=20 --timestamps=true --since=0s"
+  end
+  sleep 2.5
+end
+puts `kill #{@log_pid}`
 puts `kill #{event_pid}`
 puts `kill #{service_pid}`

data/get_pods.rb

@@ -0,0 +1,7 @@
+require 'open3'
+
+$release_name = 'redis'
+stdout, stderr, _ = Open3.capture3 "kubectl get pods -lapp.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=#{$release_name} -o name"
+if stderr.empty?
+  puts stdout.lines.join(',')
+end

data/lib/helm_upgrade_logs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HelmUpgradeLogs
-  VERSION = "0.1.4"
+  VERSION = "0.1.7"
 end

data/lib/helm_upgrade_logs.rb

@@ -1,7 +1,38 @@
 # frozen_string_literal: true
 
+require 'open3'
 require_relative "helm_upgrade_logs/version"
 
+# Approach not ideal as it will for all containers to be ready and want to stream logs before that
+def wait_for_container_ready
+  wait_pid = Process.spawn 'kubectl wait --for=condition=ContainersReady pod --selector "app.kubernetes.io/managed-by=Helm" --timeout=30s'
+  Process.wait wait_pid
+end
+
+# Wait for pods with logs to be present
+# Not ideal due to https://github.com/kubernetes/kubernetes/issues/28746
+def wait_for_pod_to_log
+  90.times {
+    sleep 1
+    stdout, stderr, _ = Open3.capture3 "kubectl logs -lapp.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=#{$release_name}"
+    if stderr.empty? && !stdout.strip.empty?
+      puts 'Pods with logs found'
+      break
+    else
+      puts "Waiting for pod logs: #{stderr}"
+    end
+  }
+end
+
+def get_pods
+  stdout, stderr, _ = Open3.capture3 "kubectl get pods -lapp.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=#{$release_name} -o name"
+  if stderr.empty?
+    stdout.lines.collect { |pod| pod.strip }
+  else
+    []
+  end
+end
+
 module HelmUpgradeLogs
   class Error < StandardError; end
   # Your code goes here...

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: helm_upgrade_logs
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-16 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies: []
 description: Basic wrapper around helm and kubectl to allow easy debugging of a helm
   release. All arguments after a usual helm upgrade are used as normal
 email:
 - samuel.garratt@sentify.co
 executables:
+- helm_test_logs
 - helm_upgrade_logs
 extensions: []
 extra_rdoc_files: []
@@ -38,7 +39,9 @@ files:
 - bin/helm_upgrade_logs.sh
 - bin/setup
 - bin/start_kind.sh
+- exe/helm_test_logs
 - exe/helm_upgrade_logs
+- get_pods.rb
 - helm_upgrade_logs.gemspec
 - lib/helm_upgrade_logs.rb
 - lib/helm_upgrade_logs/version.rb