kubetailrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b945e0de1dfdd765db891edb1a5e8c59a6cf7c1940a81147a4cd3c31b398003
+  data.tar.gz: bbebd5de583b686f18750f26bb2b9b52f3505da68285286e91f20417c0ecfa23
+SHA512:
+  metadata.gz: 871dc15cb59a8b657d4488fa08f78a04db28910b9aac8ff1938944d943d7a9a99b895164d6fe39f1ce8541a41730da3e34a84c09a89486bf73c2870fea13885d
+  data.tar.gz: 86d562f6163e7206a5c7a95f52bf8dd2e56de246590b35b4fdd338c1bc1624aacdbd2a7df91475f9612e737e320bdc7ba53ea86cb7bdb0f54ea6d0c89baaf6fc

data/.pryrc

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#
+# Define some debugging behaviours to ease debugging sessions.
+# src: https://github.com/deivid-rodriguez/pry-byebug?tab=readme-ov-file#matching-byebug-behaviour
+#
+
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end
+
+# Hit Enter to repeat last command
+Pry::Commands.command(/^$/, 'repeat last command') do
+  pry_instance.run_command Pry.history.to_a.last
+end

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 40
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-27
+
+- Initial release

data/Guardfile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#
+# Guard is a command line tool to easily handle events on file system modifications.
+# More info at https://github.com/guard/guard#readme
+#
+
+#
+# Configuration generated by using `guard init minitest`.
+#
+guard :minitest do
+  watch(%r{^test/(.*)/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end
+
+#
+# Configuration generated by using `guard init cucumber`.
+#
+cucumber_options = {
+  # Need to disable this in order to make it work with recent version of cucumber.
+  # src: https://github.com/guard/guard-cucumber/issues/41#issuecomment-716199847
+  notification: false,
+  cmd_additional_args: '--publish-quiet'
+}
+
+guard 'cucumber', cucumber_options do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$}) { 'features' }
+
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'features'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Louis Lin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Kubetailrb
+
+> Tail your Kubernetes pod logs at the same time.
+
+> [!NOTE]
+> This project is a pet project I used to learn the [Ruby programming language](https://www.ruby-lang.org/en/).
+> So you might find lots of my [personal notes](./journey_log.md) in the codebase.
+>
+> If you want to have something that works, please look at the following
+> projects that were used as inspirations instead:
+>
+> - https://github.com/stern/stern
+> - https://github.com/johanhaleby/kubetail
+
+![kubetailrb](./kubetailrb.png)
+
+## Installation
+
+```sh
+# Install dependencies.
+./bin/setup
+
+# Install gem onto your local machine
+bundle exec rake install
+```
+
+## Usage
+
+```bash
+# show help
+kubetailrb -h
+
+# follow pod logs
+kubetailrb 'clock' --namespace sandbox
+
+# follow pod structured JSON logs and display in human friendly way
+kubetailrb 'clock-json' --namespace sandbox --pretty --raw --follow
+# or with shorter flags
+kubetailrb 'clock-json' -n sandbox -p -r -f
+
+# you can filter the pods using regex on the pod names
+kubetailrb '^clock(?!-json)' -n sandbox -p -r
+
+```
+
+## Development
+
+```bash
+# Open interactive prompt to allow you to experiment.
+./bin/console
+
+# Release new version
+NEW_VERSION=1.0.1 \
+  && sed "s/VERSION = \".*\"/VERSION = \"${NEW_VERSION}\"/" lib/kubetailrb/version.rb
+  && bundle exec rake release
+
+# Check available tasks that can be run
+bundle exec rake --tasks
+
+# During your development phase, run tests automatically.
+bundle exec rake test:watch
+
+# Run tests, cucumber features and lint.
+bundle exec rake
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/l-lin/kubetailrb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+require 'bundler/gem_tasks'
+
+require 'minitest/test_task'
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new
+
+task default: %i[test cucumber rubocop]
+
+namespace :test do
+  desc 'Watch files and re-execute tests.'
+  task :watch do
+    exec('guard -c')
+  end
+end
+
+K8S_NAMESPACE = 'sandbox'
+
+namespace :k8s do
+  desc 'Create local Kubernetes cluster.'
+  task :create do
+    next if k8s_up?
+
+    puts 'Starting local Kubernetes cluster...'
+    puts `k3d cluster create --config k3d/default.yml \
+        --k3s-arg '--kubelet-arg=eviction-hard=imagefs.available<1%,nodefs.available<1%@agent:*' \
+        --k3s-arg '--kubelet-arg=eviction-minimum-reclaim=imagefs.available=1%,nodefs.available=1%@agent:*';`
+
+    puts "Creating namespace #{K8S_NAMESPACE}"
+    `kubectl create namespace #{K8S_NAMESPACE}`
+    `kubens #{K8S_NAMESPACE}`
+  end
+
+  desc 'Destroy local Kubernetes cluster.'
+  task :nuke do
+    next unless k8s_up?
+
+    k3d_cluster = `k3d cluster list --no-headers`.split(' ').first
+    puts "Destroying local Kubernetes cluster '#{k3d_cluster}'!!!"
+    `k3d cluster delete #{k3d_cluster}`
+  end
+
+  desc 'Deploy application to k8s.'
+  task :deploy, [:app_name] do |_, args|
+    next unless k8s_up?
+
+    app_name = args[:app_name]
+
+    next if app_name.nil? || app_name.strip.empty?
+
+    docker_image = "registry.localhost:5000/#{app_name}"
+    clock_dir = "k3d/#{app_name}"
+
+    puts "Building Docker image #{docker_image}"
+    `docker build -t #{docker_image} #{clock_dir}`
+    `docker push #{docker_image}`
+    puts `kubectl delete po #{app_name} --force true` if pod_up?(app_name)
+    puts `kubectl run #{app_name} --image #{docker_image}`
+  end
+
+  desc 'Deploy all applications to k8s.'
+  task :deploy_all do
+    Rake::Task['k8s:deploy'].invoke('clock')
+    # Rake does not actually run the task, but rather it adds it to a task
+    # queue. So we need to re-enable the task so it can be run again.
+    Rake::Task['k8s:deploy'].reenable
+    Rake::Task['k8s:deploy'].invoke('clock-json')
+  end
+end
+
+def k8s_up?
+  !`k3d cluster list --no-headers`.strip.empty?
+end
+
+def pod_up?(app_name)
+  !`kubectl get po | grep '^#{app_name}'`.strip.empty?
+end

data/exe/kubetailrb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'kubetailrb'
+
+Kubetailrb::CLI.new.execute(*ARGV)