hippo-cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 432cb14031538080436b685d9bffb44890296eb4ee2e001f47112d0a60cf10ae
+  data.tar.gz: 155f1cfd1ef594b9ad3e863bb40c3ca89df2bbbb77a5b3657ea6abd4dd324d39
+SHA512:
+  metadata.gz: dbf149c3462eaf4b7b2fcba7afe450d3a60c472a671ba117a991db9db2ae7b94d3f72c2e2f708cc2d316f1dcadb00e5a60e637bdf3d9dc27af724e5f7595da33
+  data.tar.gz: ce1c8ab412478c7d4dc13a3d975d2734c2ad60a75dfd43e60b95fec1c9493a232036056977e395ee6da021a871fef51c7827419eb11395e6c296475a537601ce

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+p3�<x�H񏦀y�::��Ej�>��*@�x'=�����WeW�n~�T�<�t�s��䯔�c��[����S�^|�7�~s@��X���`���,D��W��>�n�
+4m�-S�nFr��F�]<���u��`R���y�$���D�q�K��}�aY��%D��3k�|�3}�~���*���ѐC%�K<��<cq��d��j�RFB�T�J
+%|�2�ɰ��	E��E�-g,ں ��B4���s��

data/bin/hippo

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'hippo'
+require 'hippo/error'
+require 'hippo/version'
+require 'swamp/cli'
+
+COMMANDS_WITHOUT_STAGE = %w[help init].freeze
+
+begin
+  cli = Swamp::CLI.new(:hippo, version: Hippo::VERSION)
+  cli.load_from_directory(File.expand_path('../cli', __dir__))
+
+  args = ARGV.dup
+  stage = args.shift
+  command = args.shift
+
+  if COMMANDS_WITHOUT_STAGE.include?(stage) || (command.nil? && stage.nil?)
+    cli.dispatch([stage || 'help'])
+  elsif command.nil?
+    puts 'usage: hippo [STAGE] [COMMAND] {options}'
+    puts '(Be sure to specify the stage name before the command)'
+    exit 2
+  else
+    CURRENT_STAGE = stage
+    cli.dispatch([command] + args)
+  end
+rescue Swamp::Error, Hippo::Error => e
+  warn "\e[31mError: #{e.message}\e[0m"
+  exit 2
+rescue Interrupt
+  exit 3
+end

data/cli/apply_config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+command :'apply-config' do
+  desc 'Apply configuration'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    steps = Hippo::CLISteps.setup(context)
+    steps.apply_namespace
+    steps.apply_config
+    steps.apply_secrets
+  end
+end

data/cli/apply_services.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+command :'apply-services' do
+  desc 'Apply service configuration'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    steps = Hippo::CLISteps.setup(context)
+    steps.apply_services
+  end
+end

data/cli/build.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+command :build do
+  desc 'Build an image for the given stage'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    steps = Hippo::CLISteps.setup(context)
+    steps.prepare_repository
+    steps.build
+  end
+end

data/cli/console.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+command :console do
+  desc 'Open a console based on the configuration'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '-d', '--deployment [NAME]', 'The name of the deployment to use' do |value, options|
+    options[:deployment] = value.to_s
+  end
+
+  option '-c', '--command [NAME]', 'The command to run' do |value, options|
+    options[:command] = value.to_s
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    cli = Hippo::CLISteps.setup(context)
+
+    if cli.recipe.console.nil?
+      raise Error, 'No console configuration has been provided in Hippofile'
+    end
+
+    time = Time.now.to_i
+    deployment_name = context.options[:deployment] || cli.recipe.console['deployment']
+    command = context.options[:command] || cli.recipe.console['command'] || 'bash'
+    exec cli.stage.kubectl("exec -it deployment/#{deployment_name} -- #{command}")
+  end
+end

data/cli/deploy.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+command :deploy do
+  desc 'Deploy the application to Kubernetes (including image build/push)'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '--no-jobs', 'Do not run the deploy jobs' do |_value, options|
+    options[:jobs] = false
+  end
+
+  option '--no-build', 'Do not build the images' do |_value, options|
+    options[:build] = false
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    steps = Hippo::CLISteps.setup(context)
+    if context.options[:build] == false
+      commit = steps.recipe.repository.commit_for_branch(steps.stage.branch)
+      puts 'Not building an image and just hoping one exists for current commit.'
+      puts "Using #{commit.objectish} from #{steps.stage.branch}"
+      steps.prepare_repository(fetch: false)
+    else
+      steps.prepare_repository
+      steps.build
+      steps.publish
+    end
+
+    steps.apply_namespace
+    steps.apply_config
+    steps.apply_secrets
+
+    unless context.options[:jobs] == false
+      if steps.run_deploy_jobs == false
+        raise Hippo::Error, 'Not all jobs completed successfully. Cannot continue with deployment.'
+      end
+    end
+
+    steps.apply_services
+    steps.deploy
+  end
+end

data/cli/edit-secret.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+command :'edit-secret' do
+  desc 'Create/edit an encrypted secrets file'
+
+  option '--create-key', 'Create a new encryption key if missing' do |_value, options|
+    options[:create_key] = true
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    steps = Hippo::CLISteps.setup(context)
+
+    secret_name = context.args[0]
+    raise Hippo::Error, 'You must provide a secret name' if secret_name.nil?
+
+    require 'hippo/secret_manager'
+    manager = Hippo::SecretManager.new(steps.recipe, steps.stage)
+    if !manager.key_available? && context.options[:create_key]
+      manager.create_key
+    elsif !manager.key_available?
+      puts "\e[31mNo key has been published for this stage yet. You can create"
+      puts "a key automatically by adding --create-key to this command.\e[0m"
+      exit 2
+    elsif context.options[:create_key]
+      puts "\e[31mThe --create-key option can only be provided when a key has not already"
+      puts "been generated. Remove the key from the Kubernetes API to regenerate.\e[0m"
+      exit 2
+    end
+
+    secret = manager.secret(secret_name)
+    if secret.exists?
+      secret.edit
+    else
+      puts "No secret exists at #{secret.path}. Would you like to create one?"
+      response = STDIN.gets.strip.downcase.strip
+      if %w[y yes please].include?(response)
+        secret.create
+        secret.edit
+      else
+        puts 'Not a problem. You can make it later.'
+      end
+    end
+  end
+end

data/cli/help.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+command :help do
+  desc 'Display this help text'
+  action do |context|
+    puts "\e[35mWelcome to Hippo v#{Hippo::VERSION}\e[0m"
+    puts 'For documentation see https://adam.ac/hippo.'
+    puts
+
+    puts 'The following commands are supported:'
+    puts
+    context.cli.commands.sort_by { |k, _v| k.to_s }.each do |_, command|
+      if command.description
+        puts "  \e[36m#{command.name.to_s.ljust(18, ' ')}\e[0m #{command.description}"
+      end
+    end
+    puts
+    puts 'For details for the options available for each command, use the --help option.'
+    puts "For example 'hippo build --help'."
+  end
+end

data/cli/init.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+command :init do
+  desc 'Initialize a new application to use Hippo'
+
+  action do |context|
+    require 'fileutils'
+
+    path = context.args[0]
+
+    if path.nil?
+      raise Error, 'You must pass the name of the directory you wish to create your Hippo manifest'
+    end
+
+    root = File.expand_path(path)
+    template_root = File.join(File.expand_path('../', __dir__), 'template')
+
+    raise Hippo::Error, "File already exists at #{root}" if File.exist?(root)
+
+    FileUtils.mkdir_p(path)
+    FileUtils.cp_r(File.join(template_root, '.'), root)
+
+    puts "Initialized Hippo manifest in #{root}"
+  end
+end

data/cli/install.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+command :install do
+  desc 'Run installation jobs for the application'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '--no-build', 'Do not build the images' do |_value, options|
+    options[:build] = false
+  end
+
+  option '--no-deploy', 'Do not deploy after install' do |_value, options|
+    options[:deploy] = false
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    steps = Hippo::CLISteps.setup(context)
+    if context.options[:build] == false
+      commit = steps.recipe.repository.commit_for_branch(steps.stage.branch)
+      puts 'Not building an image and just hoping one exists for current commit.'
+      steps.prepare_repository(fetch: false)
+    else
+      steps.prepare_repository
+      steps.build
+      steps.publish
+    end
+
+    steps.apply_namespace
+    steps.apply_config
+    steps.apply_secrets
+
+    if steps.run_install_jobs == false
+      raise Hippo::Error, 'Not all installation jobs completed successfully. Cannot continue to deploy.'
+    end
+
+    unless context.options[:deploy] == false
+      steps.apply_services
+      steps.deploy
+    end
+  end
+end

data/cli/kubectl.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+command :kubectl do
+  desc 'Execute kubectl commands with the correct namespace for the stage'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    cli = Hippo::CLISteps.setup(context)
+    ARGV.shift
+    exec cli.stage.kubectl(*ARGV)
+  end
+end

data/cli/objects.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+command :objects do
+  desc 'Build and publish an image for the given stage'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '--types [TYPES]', 'The types of objects you wish to see' do |value, options|
+    options[:types] = value.split(/,/)
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    steps = Hippo::CLISteps.setup(context)
+    commit = steps.prepare_repository(fetch: false)
+
+    if context.options[:types].nil? || context.options[:types].include?('all')
+      types = Hippo::Kubernetes::OBJECT_DIRECTORY_NAMES
+    else
+      types = context.options[:types]
+    end
+
+    objects = []
+    types.each do |type|
+      next unless Hippo::Kubernetes::OBJECT_DIRECTORY_NAMES.include?(type)
+
+      objects |= steps.recipe.kubernetes.objects(type, steps.stage, commit)
+    end
+
+    puts objects.map { |o| o.hash.to_yaml }
+  end
+end

data/cli/publish.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+command :publish do
+  desc 'Build and publish an image for the given stage'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    steps = Hippo::CLISteps.setup(context)
+    steps.prepare_repository
+    steps.build
+    steps.publish
+  end
+end

data/cli/secrets.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+command :secrets do
+  desc 'View all secrets'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    cli = Hippo::CLISteps.setup(context)
+
+    require 'hippo/secret_manager'
+    manager = Hippo::SecretManager.new(cli.recipe, cli.stage)
+    unless manager.key_available?
+      puts "\e[31mNo key has been published for this stage yet.\e[0m"
+      exit 2
+    end
+
+    puts manager.secrets.map(&:to_editable_yaml)
+  end
+end

data/cli/status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+command :status do
+  desc 'Print status information from Kubernetes'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  action do |context|
+    require 'hippo/cli_steps'
+    cli = Hippo::CLISteps.setup(context)
+    exec cli.stage.kubectl('get pods,deployments,job,statefulset,pvc,svc,ingress')
+  end
+end

data/lib/hippo/build_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Hippo
+  class BuildSpec
+    attr_reader :name
+
+    def initialize(recipe, name, options)
+      @recipe = recipe
+      @name = name
+      @options = options
+    end
+
+    def dockerfile
+      @options['dockerfile'] || 'Dockerfile'
+    end
+
+    def image_name
+      @options['image-name']
+    end
+
+    def image_name_for_commit(commit_ref)
+      "#{image_name}:#{commit_ref}"
+    end
+
+    def template_vars
+      {
+        'dockerfile' => dockerfile,
+        'image-name' => image_name
+      }
+    end
+  end
+end