helm-wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3da406ae1f3c001d4b51c4f649f63f303c36b974190a94da96eac15a9fcb4aa
+  data.tar.gz: 22d5e3f7ba99bcdbc33b547630d8b7e48a347ebdf5e99773e9335277374c7eea
+SHA512:
+  metadata.gz: ec9bf88db860c8e788f4c00a2216acd695b6de238f23c1e98ea90bb969523f8a60a721cdebce64d5c7629f61b2179d2194eadd446c6faeae8f261c976f0e09fd
+  data.tar.gz: 2e04c841ef35f60edcf7a2fa934b0f1f92af7b73970d431e501bccdf89a8a92fcfbf7d9a97cd57dc53ea62cde23351fe0f74ac1317d8e02dba842273a7b7edb5

data/.gitignore

@@ -0,0 +1,28 @@
+###############################################################################
+
+**/*.DS_Store
+**/*.swp
+**/*.tmp
+**/*~
+
+###############################################################################
+
+.idea
+
+###############################################################################
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+###############################################################################
+
+/archlinux/
+!/archlinux/PKGBUILD
+
+###############################################################################

data/.gitlab-ci.yml

@@ -0,0 +1,37 @@
+###############################################################################
+
+image: ruby
+
+###############################################################################
+
+stages:
+  - test
+  - publish
+
+###############################################################################
+
+test:
+  stage : test
+  script:
+    - echo "-- Beginning Test --"
+    - echo "-- Tests not implemented yet --"
+
+###############################################################################
+
+deploy:
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'
+  stage: publish
+  script:
+    - echo "-- Beginning Publish --"
+    - test -n "${GEM_HOST_API_KEY}"
+    - echo "RubyGems API key found!"
+    - hash rake
+    - hash ruby
+    - hash gem
+    - echo "-- Publishing Gem --"
+    - rake release
+    - echo "-- Listing Sums --"
+    - sha256sum "pkg"/*.gem
+
+###############################################################################

data/Gemfile

@@ -0,0 +1,13 @@
+###############################################################################
+
+# frozen_string_literal: true
+
+###############################################################################
+
+source "https://rubygems.org"
+
+###############################################################################
+
+gemspec
+
+###############################################################################

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Richard Lees, BITServices Ltd.
+
+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/Rakefile

@@ -0,0 +1,13 @@
+###############################################################################
+
+# frozen_string_literal: true
+
+###############################################################################
+
+require "bundler/gem_tasks"
+
+###############################################################################
+
+task default: %i[]
+
+###############################################################################

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+###############################################################################
+
+# frozen_string_literal: true
+
+###############################################################################
+
+require "bundler/setup"
+require "irb"
+require "helm-wrapper"
+
+###############################################################################
+
+IRB.start(__FILE__)
+
+###############################################################################

data/bin/setup

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+###############################################################################
+
+set -euo pipefail
+
+###############################################################################
+
+IFS=$'\n\t'
+
+###############################################################################
+
+set -vx
+
+###############################################################################
+
+bundle install
+
+###############################################################################

data/helm-wrapper.gemspec

@@ -0,0 +1,38 @@
+###############################################################################
+
+# frozen_string_literal: true
+
+###############################################################################
+
+require_relative "lib/helm-wrapper/version"
+
+###############################################################################
+
+Gem::Specification.new do |spec|
+  spec.name        = "helm-wrapper"
+  spec.version     = HelmWrapper::VERSION
+  spec.authors     = ["Richard Lees"]
+  spec.email       = ["git0@bitservices.io"]
+
+  spec.summary     = "A ruby wrapper for managing Helm binaries and chart deployment."
+  spec.description = "A ruby wrapper for managing Helm binaries and chart deployment. Helm Wrapper also supports authenticating with specific Kubernetes clusters."
+  spec.homepage    = "https://gitlab.com/rlees85-ruby/helm-wrapper/"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:archlinux|test|spec|features)/}) or f.match(%r{\Aavatar(?:_group)?\.png\z}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rake', '~> 13.0'
+end
+
+###############################################################################

data/lib/helm-wrapper.rb

@@ -0,0 +1,59 @@
+###############################################################################
+
+require_relative 'helm-wrapper/shared'
+require_relative 'helm-wrapper/tasks'
+require_relative 'helm-wrapper/version'
+
+###############################################################################
+
+require_relative 'helm-wrapper/common'
+
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  @logger = HelmWrapper::Shared::Logging.logger_for("HelmWrapper")
+
+###############################################################################
+
+  @logger.info("Helm Wrapper for Ruby - version: #{HelmWrapper::VERSION}")
+
+###############################################################################
+
+  def self.define_tasks(chart:, namespace:, release:, options: Hash.new)
+    @logger.info("Building tasks for chart: #{chart}...")
+
+    @logger.fatal("Options must be specified as a hash!") unless options.kind_of?(Hash)
+
+    binary_options = Hash.new
+    binary_options["base"]    = options.key?("binary-base")    ? options["binary-base"]    : File.join(Dir.pwd, "vendor", "helm")
+    binary_options["version"] = options.key?("binary-version") ? options["binary-version"] : Shared::Latest.instance.version
+
+    chart_options = Hash.new
+    chart_options["name"]  = chart
+    chart_options["repos"] = options.key?("chart-repos") ? options["chart-repos"] : Array.new
+
+    config_options = Hash.new
+    config_options["auth-azure"]         = options.key?("config-auth-azure")         ? options["config-auth-azure"]         : false
+    config_options["auth-azure-options"] = options.key?("config-auth-azure-options") ? options["config-auth-azure-options"] : Hash.new
+    config_options["base"]               = options.key?("config-base")               ? options["config-base"]               : File.join(Dir.pwd, "config")
+    config_options["namespace"]          = namespace
+    config_options["release"]            = release
+
+    binary = HelmWrapper::Shared::Binary.new(options: binary_options)
+    chart  = HelmWrapper::Shared::Chart.new(options: chart_options)
+
+    tasks = Array.new
+    tasks << HelmWrapper::Tasks::Apply.new(binary: binary, chart: chart, options: config_options)
+    tasks << HelmWrapper::Tasks::Binary.new(binary: binary)
+    tasks << HelmWrapper::Tasks::Destroy.new(binary: binary, chart: chart, options: config_options)
+    return tasks
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/helm-wrapper/common.rb

@@ -0,0 +1,27 @@
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  def self.create_directory(directory:, purpose: nil, exists: true)
+    return exists if File.directory?(directory)
+
+    result = false
+
+    if not purpose.nil? and purpose.kind_of?(String) and not purpose.strip.empty? then
+      @logger.info("Creating directory for: #{purpose}, path: #{directory}")
+    else
+      @logger.info("Creating directory: #{directory}")
+    end
+
+    FileUtils.mkdir_p(directory)
+
+    result = File.directory?(directory)
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/helm-wrapper/shared.rb

@@ -0,0 +1,16 @@
+###############################################################################
+
+require_relative 'shared/logger'
+require_relative 'shared/logging'
+
+###############################################################################
+
+require_relative 'shared/auths'
+require_relative 'shared/binary'
+require_relative 'shared/chart'
+require_relative 'shared/config'
+require_relative 'shared/latest'
+require_relative 'shared/runner'
+require_relative 'shared/variables'
+
+###############################################################################

data/lib/helm-wrapper/shared/auths.rb

@@ -0,0 +1,9 @@
+###############################################################################
+
+require_relative 'auths/common'
+
+###############################################################################
+
+require_relative 'auths/azure'
+
+###############################################################################

data/lib/helm-wrapper/shared/auths/azure.rb

@@ -0,0 +1,176 @@
+###############################################################################
+
+require 'tempfile'
+
+###############################################################################
+
+module HelmWrapper
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    module Auths
+
+###############################################################################
+
+      class Azure < Common
+
+###############################################################################
+
+        include HelmWrapper::Shared::Logging
+
+###############################################################################
+
+        @@az   = "az"
+        @@type = "azure"
+
+###############################################################################
+
+        @ca_tempfile = nil
+        @token       = nil
+
+###############################################################################
+
+        attr_reader :ca
+        attr_reader :endpoint
+
+###############################################################################
+
+        def initialize(options:, variables:)
+          construct(options: options, variables: variables)
+        end
+
+###############################################################################
+
+        def auth()
+          @ca_tempfile = Tempfile.new('helm-wrapper-auths-azure-ca')
+
+          begin
+            @ca_tempfile.write(ca)
+          ensure
+            @ca_tempfile.close
+          end
+
+          logger.success("Azure authenticator successfully written Kubernetes CA to file!")
+
+          ENV["HELM_KUBECAFILE"]    = @ca_tempfile.path
+          ENV["HELM_KUBEAPISERVER"] = @endpoint
+          ENV["HELM_KUBETOKEN"]     = @token
+
+          logger.success("Azure authenticator environment variables set!")
+        end
+
+###############################################################################
+
+        def clear()
+          unless @ca_tempfile.nil?
+            @ca_tempfile.unlink
+            @ca_tempfile = nil
+
+            logger.info("Azure authenticator Kubernetes CA file cleared!")
+          end
+
+          ENV.delete("HELM_KUBECAFILE")
+          ENV.delete("HELM_KUBEAPISERVER")
+          ENV.delete("HELM_KUBETOKEN")
+
+          logger.info("Azure authenticator environment variables cleared!")
+        end
+
+###############################################################################
+
+        private
+
+###############################################################################
+
+        def cli()
+          output  = logger.colour ? "jsonc" : "json"
+          cmdline = "\"#{@@az}\" version --output \"#{output}\""
+          return(system(cmdline) || false)
+        end
+
+###############################################################################
+
+        def secret(vault:, name:)
+          logger.info("Getting secret: #{name}, from key vault: #{vault}...")
+
+          cmdline = "\"#{@@az}\" keyvault secret show --vault-name \"#{vault}\" --name \"#{name}\" --query \"value\" --output \"tsv\""
+          stdout  = `#{cmdline}`
+          code    = $?.exitstatus
+
+          logger.fatal("Failed to get secret: #{name} from key vault: #{vault}!") if (code != 0 or stdout.strip.empty?)
+
+          return(stdout.strip)
+        end
+
+###############################################################################
+
+        def specific()
+          logger.fatal("Azure CLI must bpassworde installed and accessible to use the Azure authenticator.") unless cli
+
+          logger.fatal("Azure authenticator mandatory option 'keyvault' has not been set!") unless @options.key?("keyvault")
+          logger.fatal("Azure authenticator keyvault must be a string!") unless @options["keyvault"].kind_of?(String)
+          logger.fatal("Azure authenticator keyvault must not be blank!") if @options["keyvault"].strip.empty?
+
+          keyvault = @options["keyvault"]
+          if @options.key?("ca-certificate") then
+            logger.fatal("Azure authenticator keyvault certificate for Kubernetes CA must be a string!") unless @options["ca-certificate"].kind_of?(String)
+            logger.fatal("Azure authenticator keyvault certificate for Kubernetes CA must not be blank!") if @options["ca-certificate"].strip.empty?
+
+            ca = @options["ca-certificate"]
+          else
+            ca = "kubernetes-ca"
+          end
+
+          if @options.key?("endpoint-secret") then
+            logger.fatal("Azure authenticator keyvault secret for endpoint must be a string!") unless @options["endpoint-secret"].kind_of?(String)
+            logger.fatal("Azure authenticator keyvault secret for endpoint must not be blank!") if @options["endpoint-secret"].strip.empty?
+
+            endpoint = @options["endpoint-secret"]
+          else
+            endpoint = "kubernetes-endpoint"
+          end
+
+          if @options.key?("token-secret") then
+            logger.fatal("Azure authenticator keyvault secret for token must be a string!") unless @options["token-secret"].kind_of?(String)
+            logger.fatal("Azure authenticator keyvault secret for token must not be blank!") if @options["token-secret"].strip.empty?
+
+            token = @options["token-secret"]
+          else
+            token = "kubernetes-token"
+          end
+
+          begin
+            keyvault = keyvault % @variables.values
+            ca       = ca       % @variables.values
+            endpoint = endpoint % @variables.values
+            token    = token    % @variables.values
+          rescue
+            logger.fatal("Azure authenticator options contain variables that are not included in the configuration file!")
+          end
+
+          @ca       = secret(vault: keyvault, name: ca)
+          @endpoint = secret(vault: keyvault, name: endpoint)
+          @token    = secret(vault: keyvault, name: token)
+        end
+
+###############################################################################
+
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################