helm_upgrade_logs 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa3f3a0b230ebece6f834e3f1d350f7dce7efdc38e9798f6e88e2c2ac2e4ebea
-  data.tar.gz: '09b2dc417d34ceada26ea29976dceab275d035c69da9fac86afbf613b2f239b1'
+  metadata.gz: e5195e2b08d8a4c6838d8cbf16fa070551bed1953008f46873d6f41ac07c829d
+  data.tar.gz: 338bab0411ebc7e0a059b66392a30342187a6a9fb1ba623a3796baee331a5119
 SHA512:
-  metadata.gz: 6b079a3c801b1cfc3ed7ebfe43b669e8845cf02bb2980e541e58fe1b049d4138e0cbb120a64099e97335bc95b0b98f2510a934299ff470251ebf56bf247cfbb3
-  data.tar.gz: 40d106a0b06352621fc90cfb8653fbc3f279d8676d438eeb592e6fa94a39bc896f8a690df4a6633654d410f9bae5600605790fbcd1bdbf33c95aa114d9403053
+  metadata.gz: 5d7b9c585181eef228e5bdaebacbc3d5d1764e6d0bbcb6aeb62db8389482f2011bba423d4d836dae44c8c16d0e2c94cab8352ef60b5376cb884b46ed2e858c75
+  data.tar.gz: 1417cbbe9bcbcc02501d62c30eac1b6d13b9ee8bbe060f577e2342d188539e215ea73c32d25a072bb3f401a29fd3436a5a8de524ebdd73fce829d820eed459a3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.2.3] - 2022-04-20
+
+- Configuration on initial wait for pods logs and subsequent wait limits
+
 ## [0.2.2] - 2022-04-20
 
 - Wait for logs on each pod having a process for logging each pod

data/README.md

@@ -20,7 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-This gem is purely about an `exe` to wrap around `helm` commands and to log helpful commands.
+This gem is purely about an `exe` to wrap around `helm` commands and to log events and pod logs that happen as
+part of that release while it is being released. 
+
 Once installed, install/upgrade a helm chart with
 
 ```bash
@@ -29,17 +31,29 @@ helm_upgrade_logs --install redis bitnami/redis --set auth.enabled=false --versi
 
 After the `helm_upgrade_logs` command put any options that would normally add after `helm upgrade`.
 
+This library waits for logs to start in pods for 90 seconds or controlled by environment variable `helm_upgrade_logs_log_start`.
+After that it waits 35 seconds for logs to start in pods after the first one. 
+This is controlled by environment variable `helm_upgrade_logs_pod_start`
+
 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`.
+### Aside bash script
+
+This also has a bash script which can be used directly although it will probably not work on CI
+and also does not close background processes so not ideal.
+
+However if you do want to try it, to install `nginx` from the chart `bitnami/nginx` run
 
 ```
 curl -s https://raw.githubusercontent.com/SamuelGarrattIqa/helm_upgrade_logs/main/bin/helm_upgrade_logs.sh | bash -s -- --install nginx bitnami/nginx
 ```
 
+## TODO
+* Make library handle `n`, `--namespace` from helm command
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/helm_upgrade_logs/version.rb

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

data/lib/helm_upgrade_logs.rb

@@ -3,6 +3,9 @@
 require 'open3'
 require_relative "helm_upgrade_logs/version"
 
+ENV['helm_upgrade_logs_log_start'] ||= '90'
+ENV['helm_upgrade_logs_pod_start'] ||= '35'
+
 # 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'
@@ -12,29 +15,29 @@ 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 {
+  ENV['helm_upgrade_logs_log_start'].to_i.times do |i|
     sleep 1
-    stdout, stderr, _ = Open3.capture3 "kubectl logs -lapp.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=#{$release_name}"
+    stdout, stderr, _ = Open3.capture3 "kubectl logs -lapp.kubernetes.io/instance=#{$release_name}"
     if stderr.empty? && !stdout.strip.empty?
-      puts 'Pods with logs found'
+      puts '[INFO] Pods with logs found'
       break
     else
-      puts "Waiting for pod logs: #{stderr}"
+      puts "[INFO] Waiting for pod logs: #{stderr}" if i % 3 == 0
     end
-  }
+  end
 end
 
 def wait_for_specific_pod_to_log(pod_name)
-  30.times {
+  ENV['helm_upgrade_logs_pod_start'].to_i.times do |i|
     sleep 1
     stdout, stderr, _ = Open3.capture3 "kubectl logs #{pod_name}"
     if stderr.empty? && !stdout.strip.empty?
-      puts "Pod #{pod_name} with logs found"
+      puts "[INFO] Pod #{pod_name} with logs found"
       break
     else
-      puts "Waiting for pod #{pod_name} logs: #{stderr}"
+      puts "[INFO] Waiting for pod #{pod_name} logs: #{stderr}" if i % 2 == 0
     end
-  }
+  end
 end
 
 def get_pods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helm_upgrade_logs
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Samuel Garratt