kran 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79c4036c8b185127e7157d85eff69305ef0d9bc124e4fbfc9f1ff336fdaae6fe
-  data.tar.gz: 1950703c5f3f10e734a39277ec2ede994fa6703ff2c16c3b5f174f03dc9aafab
+  metadata.gz: cadcace7c5bf8d83aa3ab9007caba40361fef547a91a7d9016a4707c92daa813
+  data.tar.gz: f9b29ad876cbe00d2e4b47fb8143ac399243de3207c28f4e3c5c766747cb7bd1
 SHA512:
-  metadata.gz: 93fc5a593bb95f3b212d5657d446b08d264de9e186302732320671f94eef43713cd6b84a59b690c800950c4b45d0b74501aa9557146077251d856557821fa0a4
-  data.tar.gz: e058664d0ede94f9fa65d6d8e59f18e9b55836b176f612cf387e597c8d030e392cc50df4118cabbe3105223c6a90fc969524cb02eff709252129db934b963f99
+  metadata.gz: 385f44dd50a3464299967fe2b85018a40d791a44c9272a7acb687e7a58be39324f03c4ad684097b0cc6259224746df737320f7b6a37ac7472362ac8e6ef6b3b2
+  data.tar.gz: eeb759046f23efeb8baa880e02aea5fb9bcca32e9542d243bf81b864f0ca37c76a0313ea74c6599033460642c0cfaa2547f2a179ca132b6fe774a0fdff509d2f

data/README.md

@@ -1,11 +1,14 @@
 # kran
 
+[![Gem Version](https://img.shields.io/gem/v/kran)](https://rubygems.org/gems/kran)
+[![CI](https://github.com/yfxie/kran/actions/workflows/ci.yml/badge.svg)](https://github.com/yfxie/kran/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/yfxie/kran/badge.svg?branch=main)](https://coveralls.io/github/yfxie/kran?branch=main)
+[![License](https://img.shields.io/github/license/yfxie/kran)](LICENSE)
+
 Deploy to Kubernetes with [krane](https://github.com/Shopify/krane), the simple way.
 One command builds the image, pushes it, renders the krane templates and deploys them. A few more
 commands cover the daily work: logs, exec, details, audit.
 
-Kran is the German word for crane.
-
 ## Install
 
 ```sh
@@ -34,7 +37,6 @@ If you have used [kamal](https://kamal-deploy.org), this will feel just as simpl
 one config file, one command to deploy.
 
 Documentation: https://kran.bincode.tw
-Source: https://github.com/yfxie/kran
 
 ## Develop
 

data/lib/kran/commands/docker.rb

@@ -28,9 +28,8 @@ module Kran
       private
 
       def docker(*args)
-        command = Shell.join(["docker", *args.compact])
-        remote = @config.builder.remote
-        remote ? "DOCKER_HOST=#{Shell.escape(remote)} #{command}" : command
+        env = @config.env.merge({ "DOCKER_HOST" => @config.builder.remote }.compact)
+        Shell.with_env(env, Shell.join(["docker", *args.compact]))
       end
 
       def platform(archs)

data/lib/kran/commands/krane.rb

@@ -18,8 +18,7 @@ module Kran
         # krane parses options with Thor, where a repeated -f replaces the earlier one
         # instead of appending to it, so every file has to follow a single -f.
         files = [@config.krane.secrets, "-"].compact
-        command = krane("deploy", kubernetes.namespace, kubernetes.context, "-f", *files)
-        kubernetes.kubeconfig ? "KUBECONFIG=#{Shell.escape(kubernetes.kubeconfig)} #{command}" : command
+        krane("deploy", kubernetes.namespace, kubernetes.context, "-f", *files, kubeconfig: kubernetes.kubeconfig)
       end
 
       def pipeline(tag)
@@ -36,8 +35,9 @@ module Kran
 
       private
 
-      def krane(*args)
-        "#{@config.krane.command} #{Shell.join(args)}"
+      def krane(*args, kubeconfig: nil)
+        env = @config.env.merge({ "KUBECONFIG" => kubeconfig }.compact)
+        Shell.with_env(env, "#{@config.krane.command} #{Shell.join(args)}")
       end
     end
   end

data/lib/kran/commands/kubectl.rb

@@ -46,8 +46,8 @@ module Kran
 
       def kubectl(*args)
         kubernetes = @config.kubernetes
-        command = Shell.join(["kubectl", "--context", kubernetes.context, "--namespace", kubernetes.namespace, *args.compact])
-        kubernetes.kubeconfig ? "KUBECONFIG=#{Shell.escape(kubernetes.kubeconfig)} #{command}" : command
+        env = @config.env.merge({ "KUBECONFIG" => kubernetes.kubeconfig }.compact)
+        Shell.with_env(env, Shell.join(["kubectl", "--context", kubernetes.context, "--namespace", kubernetes.namespace, *args.compact]))
       end
     end
   end

data/lib/kran/configuration.rb

@@ -71,5 +71,9 @@ module Kran
     def aliases
       @raw.fetch("aliases", {})
     end
+
+    def env
+      @raw.fetch("env", {}).transform_values(&:to_s)
+    end
   end
 end

data/lib/kran/shell.rb

@@ -15,5 +15,10 @@ module Kran
     def join(words)
       words.map { |word| escape(word) }.join(" ")
     end
+
+    def with_env(env, command)
+      assignments = env.map { |name, value| "#{name}=#{escape(value)}" }
+      [*assignments, command].join(" ")
+    end
   end
 end

data/lib/kran/templates/kran.yml

@@ -46,6 +46,12 @@ app:
   # Container inside the pod (kubectl -c). Defaults to the pod's default container.
   # container: web
 
+# Environment variables put in front of every docker, krane and kubectl command, for settings those
+# tools read from the environment: which cloud account docker's credential helper and kubectl's
+# auth plugin sign in with, for example.
+# env:
+#   CLOUDSDK_ACTIVE_CONFIG_NAME: acme
+
 # Shortcuts run with `kran <alias>`. Extra arguments are appended to the command.
 aliases:
   shell: exec --interactive bash

data/lib/kran/version.rb

@@ -1,3 +1,3 @@
 module Kran
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kran
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yi Feng Xie