kube_deploy_tools 3.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f4077fc4d8fce7c7d5e9ea6f664f7be3f19b1c9e41ef8a1fa909685f195550d
+  data.tar.gz: 33e8aeebd5a2235e23111c36dcef8b228c0754b45b9a1af03cd2054437649ccc
+SHA512:
+  metadata.gz: aeca489af252fafbc3e493197765b3bbbd8db09ff21ef0372d07d87f53317f00bd3d55e3efdc27fec2d0f7ad9555ead6a5adbff73486cdea45ad3e45efb294c1
+  data.tar.gz: c5be546497348d309048bcefd55f0d255c50f2fd2a21405f091a9042089984d6e118b59024a4f60c47af7c3a3aa401c900482c250c31244af35a827062dc342e

data/LICENSE.txt

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,142 @@
+# kube_deploy_tools (kdt)
+
+`kube_deploy_tools` (kdt) is a tool to simplify kubernetes manifest generation
+and deployment. In short, it is able to:
+
+* ***generate*** Kubernetes manifests from flexible [ERB] templates.
+  Templating contexts have access to a `config` Hash of options.
+  Multiple versions of the same manifests can be defined by creating
+  separate *artifacts* and *flavors* which modify `config`.
+* ***push*** Docker images tagged with the prefix `local-registry/`
+  to your configured image registry/ies. kdt will retag images
+  appropriately for the destination and push in parallel.
+* ***publish*** a manifest of all generated manifests, docker images and
+  tags for archival and eventual expiration of all artifacts related
+  to a single build.
+* ***deploy*** manifests referencing your built and pushed images out to
+  production.
+
+kdt is written in Ruby, but can be used with any project that
+deploys to Kubernetes. It can be seen as a lightweight alternative to more
+popular products like [Helm].
+
+Each of the use cases described above is defined as a separate subcommand of
+the parent `kdt` command. The tools are singularly configured by a
+`deploy.yaml` document checked-in to the root of your repository. While all of
+these components are used today at [@LiveRamp](https://github.com/LiveRamp) for
+a complete production lifecycle, they are also designed to be used
+individually.
+
+[Helm]: https://helm.sh
+
+# Getting Started
+
+## Install
+
+Include the `gem 'kube_deploy_tools', '~> 3'` in your project via a Gemfile
+or gemspec.
+
+## Configure
+
+Once kdt is installed, you will need to configure it. This is done by adding
+a new file named `deploy.yaml` at the root of your project. A minimal
+`deploy.yaml` for deploying to [Google Container Registry] is shown below:
+
+```yaml
+version: 2                        # version of kdt to be used
+default_flags:
+  pull_policy: IfNotPresent       # define default k-v pairs to be made available in ERB's `config` to all artifacts and flavors
+artifacts:                        # define groups of manifests as named artifacts for `kdt generate`
+  - name: prod
+    image_registry: gcp
+    flags: {}                     # define extra k-v pairs for ERB `config` during `kdt generate` for a specific artifact
+flavors:
+  default:                        # define extra k-v pairs for ERB `config` during `kdt generate` for a specific flavor
+    important_config: '42'        # appears in `config` for the prod/default flavor, but nowhere else
+artifact_registries:              # define destination for `kdt publish`
+image_registries:                 # define image registries for `kdt push`
+  - name: gcp                     # `kdt push` will deploy to Google Container Registry
+    driver: gcp
+    prefix: gcr.io/my-gcr-project
+```
+
+You can check out a [complete description] of the `deploy.yaml` schema.
+
+Next, create a `kubernetes/deployment.yaml.erb` file as follows:
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: my-first-kdt-app
+  labels:
+    app: my-first-kdt-app
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: my-first-kdt-app
+  template:
+    metadata:
+      labels:
+        app: my-first-kdt-app
+    spec:
+      containers:
+        - name: my-app
+          image: <%= config['image_registry'] %>/my-app:<%= config['tag'] %>
+          imagePullPolicy: <%= config['pull_policy'] %>
+    env:
+      - name: IMPORTANT_CONFIG
+        value: <%= config['important_config'] %>
+```
+
+Observe the use of ERB tags to fill in various values from the `config` Hash. The `config` hash
+is generated from a combination of artifact `flags`, `flavors`, `default_flags`, and the settings
+from `image_registries`. `tag` is autogenerated from your Git SCM workspace.
+
+Now, run `bundle exec kdt generate` and observe
+`build/kubernetes/prod_default/deployment.yaml` is created with all template
+variables filled in.
+
+To explore further,
+* Build a docker image tagged `local-registry/my-app`, then run `kdt push my-app`.
+* Run `kdt deploy -f build/kubernetes/prod_default --context my-kube-context` to send your generated
+  manifests to a Kubernetes API server.
+
+[complete description]: XXX
+
+# FAQ
+
+* ***Q***: Will KDT help me build my Docker images?
+* ***A***: No. The recommended usage is to build your docker images ahead of time and pre-tag them as local-registry/name-here.
+  Then running `kdt push name-here` will automatically retag your images with your target registry and send them off.
+
+# Changes
+
+For breaking changes, new features, and new fixes, see
+[CHANGELOG.md](CHANGELOG.md).
+
+# Contribute
+
+```bash
+# Install ruby w/ Homebrew
+brew install ruby
+
+# Or install ruby w/ rbenv
+brew install rbenv ruby-build
+rbenv install 2.3.0
+rbenv global 2.3.0
+
+# Install gem
+gem install bundler
+```
+
+```bash
+bundle install --with development
+
+# Run tests
+bundle exec rake test
+
+# Exec a binary in bin/
+bundle exec kdt generate
+```

data/bin/deploy

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+# Utility for applying Kubernetes manifests.
+
+require 'tmpdir'
+
+require 'kube_deploy_tools/formatted_logger'
+require 'kube_deploy_tools/kubectl'
+require 'kube_deploy_tools/shellrunner'
+require 'kube_deploy_tools/deploy'
+require 'kube_deploy_tools/deploy/options'
+require 'kube_deploy_tools/deploy_config_file'
+require 'kube_deploy_tools/artifact_registry'
+
+def options
+  @options ||= KubeDeployTools::Deploy::Optparser.new.parse(ARGV)
+end
+
+KubeDeployTools::Logger.logger = KubeDeployTools::FormattedLogger.build
+KubeDeployTools::Shellrunner.shellrunner = KubeDeployTools::Shellrunner.new
+context = options.context || KubeDeployTools.kube_context(target: options.target, environment: options.environment)
+namespace = KubeDeployTools::Deploy::kube_namespace(context: context, kubeconfig: options.kubeconfig)
+KubeDeployTools::Logger.logger = KubeDeployTools::FormattedLogger.build(context: context, namespace: namespace)
+kubectl = KubeDeployTools::Kubectl.new(
+  context: options.context,
+  kubeconfig: options.kubeconfig
+)
+
+config = KubeDeployTools::DeployConfigFile.new('deploy.yaml')
+artifact_registry = config.artifact_registries[config.artifact_registry].driver
+
+Dir.mktmpdir do |tmpdir|
+  if options.from_files
+    deploy_artifact_path = options.from_files
+  else
+    if options.build_number == 'latest'
+      options.build_number = artifact_registry.get_latest_build_number(options.project)
+    end
+
+    deploy_artifact_path = artifact_registry.download(
+      project: options.project,
+      build_number: options.build_number,
+      flavor: options.flavor,
+      name: options.artifact,
+      pre_apply_hook: options.pre_apply_hook,
+      output_dir: tmpdir
+    )
+  end
+
+  deploy = KubeDeployTools::Deploy.new(
+    kubectl: kubectl,
+    namespace: namespace,
+    input_path: deploy_artifact_path,
+    glob_files: options.glob_files,
+    max_retries: options.max_retries,
+    retry_delay: options.retry_delay
+  )
+  deploy.run(
+    dry_run: options.dry_run,
+  )
+end

data/bin/generate

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+#
+# Run from the root of a repository. |deploy.json| is expected to exist there.
+# Generates all deploys based on permutations defined in deploy.yml combined
+# with cluster configuration from kube_deploy_tools.
+
+require 'kube_deploy_tools/formatted_logger'
+require 'kube_deploy_tools/shellrunner'
+require 'kube_deploy_tools/generate'
+require 'kube_deploy_tools/generate/options'
+
+def options
+  parser = KubeDeployTools::Generate::Optparser.new
+  parser.parse(ARGV)
+end
+
+KubeDeployTools::Logger.logger = KubeDeployTools::FormattedLogger.build
+KubeDeployTools::Shellrunner.shellrunner = KubeDeployTools::Shellrunner.new
+
+app = KubeDeployTools::Generate.new(
+  options.manifest_file,
+  options.input_path,
+  options.output_path,
+  file_filters: options.file_filters,
+  print_flags_only: options.print_flags_only,
+  literals: options.literals,
+)
+app.generate

data/bin/kdt

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'kube_deploy_tools/kdt'
+
+kdt = KubeDeployTools::Kdt.new(__dir__, ARGV)
+
+def show_help?
+  return true if ARGV.empty?
+  return true if ARGV.size == 1 && %w(--help help).include?(ARGV.first.strip)
+  false
+end
+
+if show_help?
+  kdt.display_bins
+else
+  kdt.execute!
+end

data/bin/make_configmap

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+
+require 'kube_deploy_tools/formatted_logger'
+require 'kube_deploy_tools/make_configmap'
+require 'kube_deploy_tools/make_configmap/options'
+
+def options
+  opts = KubeDeployTools::Options.new
+  ops = opts.options
+  ops
+end
+
+KubeDeployTools::Logger.logger = KubeDeployTools::FormattedLogger.build
+KubeDeployTools::Logger.warn "This subcommand will be disappearing in kdt v3.0."
+
+ARGV << '--help' if ARGV.empty?
+make_configmap = KubeDeployTools::ConfigMap.new(options[:name], options[:from_file], options[:namespace], options[:labels])
+puts YAML::dump(make_configmap.target_hash)