hippo-cli 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 862958b0818bb34f9956e83e82738d1b59b2d4fba32c8bde858b9793129b0c9c
-  data.tar.gz: 9f3fd4e9587b882cb6588058b94efa85c8049bb31869b013c3a13f81edca5525
+  metadata.gz: 96a621d666288ef2ec40ae5384c0a2ba823f011cd2384db2d0eee53d2dbf6fc1
+  data.tar.gz: 05cf19519259186bd789f02d996b580ba76a7b7e9f598b308c2705c636d25e6c
 SHA512:
-  metadata.gz: f04805d52992d14804d21671dfbc59e1ea85dc28a3d490f135353f3cf6ba94830c1f01a0f5b1f16e3e8cabf2cd433a03e883ded0f7227f727abaa6ecf9d35f83
-  data.tar.gz: 6aed2eaa5a88fd0f9b99eaeca58de8f208eb72825bee8a7c4ef78068092ecf3e3a901ae0b9784e05a78d7785091d22ac1e4ac523897ca1f696eaeaf39da6eedb
+  metadata.gz: 911cfb6bdbbcf16ef73a5dc1d36bd53aa06dc7f94e9f53a9cc0aa964400a266cc25583d97651684ebf3394f340f780520bfb7af0e189a656dd48d2338beed7fb
+  data.tar.gz: 466ec97e4b4a4a1dcdd223f18be57fbeddb72aea29aacc1d64fc2b728ca807ec0865619024773b49613ac19aa14dcfea275bcdd9a3cdfa6395ea1dc601b67855

data/bin/hippo

@@ -8,18 +8,18 @@ require 'hippo/error'
 require 'hippo/version'
 require 'swamp/cli'
 
-COMMANDS_WITHOUT_STAGE = %w[help init].freeze
+COMMANDS_WITHOUT_STAGE = %w[help init version stages].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
+  stage = args[0]
+  command = args[1]
 
   if COMMANDS_WITHOUT_STAGE.include?(stage) || (command.nil? && stage.nil?)
-    cli.dispatch([stage || 'help'])
+    cli.dispatch(args.empty? ? ['help'] : args)
   elsif command.nil?
     puts 'usage: hippo [STAGE] [COMMAND] {options}'
     puts '(Be sure to specify the stage name before the command)'

data/cli/apply_config.rb

@@ -10,6 +10,7 @@ command :'apply-config' do
   action do |context|
     require 'hippo/cli'
     cli = Hippo::CLI.setup(context)
+    cli.preflight
     cli.apply_namespace
     cli.apply_config
   end

data/cli/apply_services.rb

@@ -10,6 +10,7 @@ command :'apply-services' do
   action do |context|
     require 'hippo/cli'
     cli = Hippo::CLI.setup(context)
+    cli.preflight
     cli.apply_services
   end
 end

data/cli/console.rb

@@ -23,6 +23,8 @@ command :console do
       raise Error, 'No console configuration has been provided in Hippofile'
     end
 
+    cli.preflight
+
     time = Time.now.to_i
     deployment_name = context.options[:deployment] || cli.manifest.console['deployment']
     command = context.options[:command] || cli.manifest.console['command'] || 'bash'

data/cli/create.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+command :create do
+  desc 'Create a new stage'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '-n', '--namespace [NAMESPACE]', 'The namespace for the new stage' do |value, options|
+    options[:namespace] = value
+  end
+
+  option '-c', '--context [CONTEXT]', 'The context for the new stage' do |value, options|
+    options[:context] = value
+  end
+
+  option '--force', 'Override existing stage configuration' do |_value, options|
+    options[:force] = true
+  end
+
+  action do |context|
+    require 'hippo/manifest'
+    manifest = Hippo::Manifest.load_from_file(context.options[:hippofile] || './Hippofile')
+
+    stage_name = CURRENT_STAGE
+    stage_path = File.join(manifest.root, 'stages', "#{stage_name}.yaml")
+
+    if !context.options[:force] && File.file?(stage_path)
+      puts "\e[31mA stage named '#{stage_name}' already exists. Use --force to overwrite configuration.\e[0m"
+      exit 1
+    end
+
+    require 'hippo/util'
+
+    namespace = context.options[:namespace]
+    if namespace.nil?
+      namespace = Hippo::Util.ask('Enter a namespace for this stage', default: "#{manifest.name}-#{stage_name}")
+    end
+
+    context_name = context.options[:context]
+    if context_name.nil?
+      context_name = Hippo::Util.ask('Enter a kubectl context for this stage', default: Hippo.current_kubectl_context)
+    end
+
+    yaml = {}
+    yaml['name'] = stage_name
+    yaml['namespace'] = namespace
+    yaml['context'] = context_name
+
+    require 'hippo/bootstrap_parser'
+    yaml['config'] = Hippo::BootstrapParser.parse(manifest.bootstrap['config'])
+
+    require 'hippo/stage'
+    stage = Hippo::Stage.new(manifest, yaml)
+
+    require 'hippo/cli'
+    cli = Hippo::CLI.new(manifest, stage)
+    cli.apply_namespace
+
+    if stage.secret_manager.key_available?
+      puts 'Encryption key already exists for this namespace.'
+    else
+      puts "Creating new encryption key in #{stage.namespace} namespace"
+      stage.secret_manager.create_key
+    end
+
+    FileUtils.mkdir_p(File.dirname(stage_path))
+    File.open(stage_path, 'w') { |f| f.write(yaml.to_yaml.sub(/\A---\n/m, '')) }
+    puts "Written new stage file to stages/#{stage.name}.yaml"
+
+    secrets = Hippo::BootstrapParser.parse(manifest.bootstrap['secrets'])
+    stage.secret_manager.write_file(secrets.to_yaml)
+    puts "Written encrypted secrets into secrets/#{stage.name}.yaml"
+
+    puts
+    puts "\e[32mStage '#{stage.name}' has been created successfully.\e[0m"
+    puts
+    puts 'You can now add any appropriate configuration needed into the'
+    puts 'stage file and into the encrypted secrets file if needed.'
+    puts
+  end
+end

data/cli/deploy.rb

@@ -14,6 +14,8 @@ command :deploy do
   action do |context|
     require 'hippo/cli'
     cli = Hippo::CLI.setup(context)
+    cli.preflight
+
     cli.verify_image_existence
 
     cli.apply_namespace

data/cli/init.rb

@@ -13,7 +13,7 @@ command :init do
     end
 
     root = File.expand_path(path)
-    template_root = File.join(File.expand_path('../', __dir__), 'template')
+    template_root = File.join(Hippo.root, 'template')
 
     raise Hippo::Error, "File already exists at #{root}" if File.exist?(root)
 

data/cli/install.rb

@@ -18,6 +18,8 @@ command :install do
   action do |context|
     require 'hippo/cli'
     cli = Hippo::CLI.setup(context)
+    cli.preflight
+
     cli.verify_image_existence
 
     cli.apply_namespace
@@ -29,7 +31,7 @@ command :install do
       end
     end
 
-    if options[:deploy] == false
+    if context.options[:deploy] == false
       puts 'Not deploying because --no-deploy was specified'
       exit 0
     end

data/cli/key.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+command :key do
+  desc 'Display/generate details about the secret encryption key'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '-g', '--generate', 'Generate a new key' do |_value, options|
+    options[:generate] = true
+  end
+  action do |context|
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+    cli.preflight
+
+    sm = cli.stage.secret_manager
+    if sm.key_available?
+      puts 'Secret encryption key is stored in secret/hippo-secret-key.'
+    else
+      if context.options[:generate]
+        sm.create_key
+        puts 'Secret encryption key has been generated and stored in secret/hippo-secret-key.'
+      else
+        puts 'Secret encryption key has not been generated yet.'
+        puts 'Generate a new using:'
+        puts
+        puts "     hippo #{cli.stage.name} key --generate"
+        puts
+      end
+    end
+  end
+end

data/cli/kubectl.rb

@@ -10,6 +10,8 @@ command :kubectl do
   action do |context|
     require 'hippo/cli'
     cli = Hippo::CLI.setup(context)
+    cli.preflight
+
     ARGV.shift(2)
     ARGV.delete('--')
     exec cli.stage.kubectl(*ARGV).join(' ')

data/cli/logs.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+command :logs do
+  desc 'Display logs for a particular pod'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '-p', '--pod [POD]', 'The name of the pod' do |value, options|
+    options[:pod] = value
+  end
+
+  option '-f', '--follow', 'Follow the log stream' do |_value, options|
+    options[:follow] = true
+  end
+
+  action do |context|
+    require 'hippo/cli'
+    require 'hippo/util'
+
+    cli = Hippo::CLI.setup(context)
+    cli.preflight
+
+    pod = context.options[:pod]
+    if pod.nil?
+      # Get all pod names that are running
+      stdout, stderr, status = Open3.capture3(*cli.stage.kubectl('get', 'pods'))
+      pod_names = []
+      stdout.split("\n").each_with_index do |line, index|
+        if index.zero?
+          puts "      #{line}"
+        else
+          puts "\e[33m#{index.to_s.rjust(3)})\e[0m  #{line}"
+          pod_names << line.split(/\s+/, 2).first
+        end
+      end
+
+      raise Error, 'There are no pods running' if pod_names.empty?
+
+      until pod
+        pod_id = Hippo::Util.ask('Choose a pod to view logs').to_i
+        next if pod_id.zero? || pod_id.negative?
+
+        pod = pod_names[pod_id.to_i - 1]
+      end
+    end
+
+    args = []
+    args << '--all-containers'
+    args << '-f' if context.options[:follow]
+
+    command = cli.stage.kubectl('logs', pod, *args)
+    exec *command
+  end
+end

data/cli/objects.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+command :objects do
+  desc 'Display all objects that will be exported'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '-t', '--type [TYPE]', 'Limit which type of object to return (one of config, deployments or services)' do |value, options|
+    options[:type] = value
+  end
+
+  option '--to-apply', 'Show objects as they would be applied to Kubernetes' do |_value, options|
+    options[:to_apply] = true
+  end
+
+  action do |context|
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+    cli.preflight
+
+    method = if context.options[:to_apply]
+               :yaml_to_apply
+             else
+               :yaml
+             end
+
+    groups = []
+    if context.options[:type].nil? || context.options[:type] == 'config'
+      groups << cli.stage.configs.map(&method)
+    end
+
+    if context.options[:type].nil? || context.options[:type] == 'deployments'
+      groups << cli.stage.deployments.map(&method)
+    end
+
+    if context.options[:type].nil? || context.options[:type] == 'services'
+      groups << cli.stage.services.map(&method)
+    end
+
+    groups.each do |group|
+      group.each do |object|
+        puts object
+          .gsub(/^kind\: (.*)$/) { "kind: \e[36m#{Regexp.last_match(1)}\e[0m" }
+          .gsub(/^---$/) { "\e[33m#{'=' * 80}\e[0m" }
+      end
+    end
+  end
+end

data/cli/package_install.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+command :'package:install' do
+  desc 'Install a named helm package'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '-p', '--package [NAME]', 'The name of the package to install' do |value, options|
+    options[:package] = value
+  end
+
+  action do |context|
+    require 'hippo/package'
+    package, cli = Hippo::Package.setup_from_cli_context(context)
+    cli.preflight
+
+    if package.installed?
+      puts "#{package.name} is already installed. You probably want to use helm:upgrade instead."
+    else
+      cli.apply_namespace
+      cli.apply_config
+
+      puts "Installing #{package.name} with Helm..."
+      package.install
+      puts "#{package.name} installed successfully"
+    end
+  end
+end

data/cli/package_list.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+command :'package:list' do
+  desc 'List all available packages with status'
+
+  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'
+    cli = Hippo::CLI.setup(context)
+    cli.preflight
+
+    if cli.stage.packages.empty?
+      puts 'There are no configured packages'
+      exit 0
+    end
+
+    puts 'Getting package details...'
+
+    packages = []
+    cli.stage.packages.values.sort_by(&:name).each do |package|
+      packages << { name: package.name, installed: package.installed?, package: package.package }
+    end
+
+    packages.each do |package|
+      STDOUT.print package[:name].ljust(20)
+      STDOUT.print package[:package].ljust(30)
+      STDOUT.print '[ '
+      if package[:installed]
+        STDOUT.print "\e[32m Installed \e[0m"
+      else
+        STDOUT.print "\e[31mNot present\e[0m"
+      end
+      STDOUT.print ' ]'
+      puts
+    end
+  end
+end

data/cli/package_notes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+command :'package:notes' do
+  desc 'Show notes about an installed Helm package'
+
+  option '-h', '--hippofile [RECIPE]', 'The path to the Hippofile (defaults: ./Hippofile)' do |value, options|
+    options[:hippofile] = value.to_s
+  end
+
+  option '-p', '--package [NAME]', 'The name of the package to install' do |value, options|
+    options[:package] = value
+  end
+
+  action do |context|
+    require 'hippo/package'
+    package, cli = Hippo::Package.setup_from_cli_context(context)
+    cli.preflight
+
+    raise Error, "#{package.name} not installed" unless package.installed?
+
+    puts package.notes
+  end
+end