hippo-cli 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d9636ec9f0d56f6cd5633d73bee77605fb30383c3bd5d793c6245db0720b30a
-  data.tar.gz: d1dbc5b162c243d4cc1806e8d15ce5e7f59a7ad631d0ac75986e1003afcc5380
+  metadata.gz: 862958b0818bb34f9956e83e82738d1b59b2d4fba32c8bde858b9793129b0c9c
+  data.tar.gz: 9f3fd4e9587b882cb6588058b94efa85c8049bb31869b013c3a13f81edca5525
 SHA512:
-  metadata.gz: 65da298f8f79ba3b5bf954e67283d8aa5340b0f02276c1c85110f7fcdba305dc64a8aee0075196a1bdf807476d9282ae3211174ad21c6d2708286b44784b87bc
-  data.tar.gz: 9ec88a924598b71181da03ea899adec5472633d97eee8cae6c57bf30e8cf833df93458177ba096937aa7f2f834ac0b06f70051a041fae80af5fc661c0a0fa1ea
+  metadata.gz: f04805d52992d14804d21671dfbc59e1ea85dc28a3d490f135353f3cf6ba94830c1f01a0f5b1f16e3e8cabf2cd433a03e883ded0f7227f727abaa6ecf9d35f83
+  data.tar.gz: 6aed2eaa5a88fd0f9b99eaeca58de8f208eb72825bee8a7c4ef78068092ecf3e3a901ae0b9784e05a78d7785091d22ac1e4ac523897ca1f696eaeaf39da6eedb

data/cli/apply_config.rb

@@ -8,10 +8,9 @@ command :'apply-config' do
   end
 
   action do |context|
-    require 'hippo/cli_steps'
-    steps = Hippo::CLISteps.setup(context)
-    steps.apply_namespace
-    steps.apply_config
-    steps.apply_secrets
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+    cli.apply_namespace
+    cli.apply_config
   end
 end

data/cli/apply_services.rb

@@ -8,8 +8,8 @@ command :'apply-services' do
   end
 
   action do |context|
-    require 'hippo/cli_steps'
-    steps = Hippo::CLISteps.setup(context)
-    steps.apply_services
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+    cli.apply_services
   end
 end

data/cli/console.rb

@@ -16,16 +16,16 @@ command :console do
   end
 
   action do |context|
-    require 'hippo/cli_steps'
-    cli = Hippo::CLISteps.setup(context)
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
 
-    if cli.recipe.console.nil?
+    if cli.manifest.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}")
+    deployment_name = context.options[:deployment] || cli.manifest.console['deployment']
+    command = context.options[:command] || cli.manifest.console['command'] || 'bash'
+    exec cli.stage.kubectl("exec -it deployment/#{deployment_name} -- #{command}").join(' ')
   end
 end

data/cli/deploy.rb

@@ -11,35 +11,24 @@ command :deploy do
     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
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+    cli.verify_image_existence
 
-    steps.apply_namespace
-    steps.apply_config
-    steps.apply_secrets
+    cli.apply_namespace
+    cli.apply_config
 
     unless context.options[:jobs] == false
-      if steps.run_deploy_jobs == false
+      if cli.run_deploy_jobs == false
         raise Hippo::Error, 'Not all jobs completed successfully. Cannot continue with deployment.'
       end
     end
 
-    steps.apply_services
-    steps.deploy
+    unless cli.deploy
+      puts 'Deployment did not complete successfully. Not continuing any further.'
+      exit 2
+    end
+    cli.apply_services
   end
 end

data/cli/install.rb

@@ -7,38 +7,37 @@ command :install do
     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
 
+  option '--no-jobs', 'Do not run the deploy jobs' do |_value, options|
+    options[:jobs] = 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
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+    cli.verify_image_existence
+
+    cli.apply_namespace
+    cli.apply_config
 
-    steps.apply_namespace
-    steps.apply_config
-    steps.apply_secrets
+    unless context.options[:jobs] == false
+      if cli.run_install_jobs == false
+        raise Hippo::Error, 'Not all jobs completed successfully. Cannot continue with installation.'
+      end
+    end
 
-    if steps.run_install_jobs == false
-      raise Hippo::Error, 'Not all installation jobs completed successfully. Cannot continue to deploy.'
+    if options[:deploy] == false
+      puts 'Not deploying because --no-deploy was specified'
+      exit 0
     end
 
-    unless context.options[:deploy] == false
-      steps.apply_services
-      steps.deploy
+    unless cli.deploy
+      puts 'Deployment did not complete successfully. Not continuing any further.'
+      exit 2
     end
+    cli.apply_services
   end
 end

data/cli/kubectl.rb

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

data/cli/secrets_edit.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+command :'secrets:edit' do
+  desc 'Create/edit an encrypted secrets file'
+
+  action do |context|
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+
+    secret_name = context.args[0]
+    raise Hippo::Error, 'You must provide a secret name' if secret_name.nil?
+
+    manager = cli.stage.secret_manager
+    unless manager.key_available?
+      puts "\e[31mNo key has been published for this stage yet.\e[0m"
+      puts "Use `hippo #{cli.stage.name} secrets:key --generate` to generate one."
+      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/secrets_key.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+command :'secrets:key' do
+  desc 'Display/generate details about the secret encryption key'
+
+  action do |context|
+    require 'hippo/cli'
+    cli = Hippo::CLI.setup(context)
+    sm = cli.stage.secret_manager
+    if sm.key_available?
+      puts 'Secret encryption key is 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} secrets:key --generate"
+      puts
+    end
+  end
+end

data/lib/hippo.rb

@@ -1,7 +1,26 @@
 # frozen_string_literal: true
 
 module Hippo
+  # The path where the user configuration file is stored
+  CONFIG_PATH = File.join(ENV['HOME'], '.hippo', 'config.yaml')
+
+  # Return the root to the gem
+  #
+  # @return [String]
   def self.root
     File.expand_path('../', __dir__)
   end
+
+  # User the user configuration for Hippo
+  #
+  # @return [Hash]
+  def self.config
+    @config ||= begin
+      if File.file?(CONFIG_PATH)
+        YAML.load_file(CONFIG_PATH)
+      else
+        {}
+      end
+    end
+  end
 end

data/lib/hippo/cli.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'hippo/manifest'
+require 'hippo/deployment_monitor'
+
+module Hippo
+  class CLI
+    attr_reader :manifest
+    attr_reader :stage
+
+    # Initialize a new CLI instance
+    #
+    # @param manifest [Hippo::Manifest]
+    # @param stage [Hippo::Stage]
+    # @return [Hippo::CLI]
+    def initialize(manifest, stage)
+      @manifest = manifest
+      @stage = stage
+    end
+
+    # Verify image existence
+    #
+    # @return [void]
+    def verify_image_existence
+      missing = 0
+      @manifest.images.each do |_, image|
+        commit = image.commit_ref_for_branch(@stage.branch)
+        if image.exists_for_commit?(commit)
+          puts "Image for #{image.name} exists for #{image.url} (with tag #{commit})"
+        else
+          missing += 1
+          puts "No #{image.name} image at #{image.url} (with tag #{commit})"
+        end
+      end
+
+      if missing > 0
+        raise Error, "#{missing} #{missing == 1 ? 'image was' : 'images were'} not available. Cannot continue."
+      end
+    end
+
+    # Apply the namespace configuration
+    #
+    # @return [void]
+    def apply_namespace
+      od = Hippo::ObjectDefinition.new(
+        {
+          'kind' => 'Namespace',
+          'apiVersion' => 'v1',
+          'metadata' => { 'name' => @stage.namespace, 'labels' => { 'name' => @stage.namespace } }
+        },
+        @stage
+      )
+      apply([od], 'namespace')
+    end
+
+    # Apply all configuration and secrets
+    #
+    # @return [void]
+    def apply_config
+      apply(@stage.configs, 'configuration')
+
+      if @stage.secret_manager.key_available?
+        secrets = @stage.secret_manager.secrets.map(&:applyable_yaml).flatten
+        apply(secrets, 'secret')
+      else
+        puts 'Not applying secrets because no key is available to decrypt them.'
+      end
+    end
+
+    # Apply all services, ingresses and policies
+    #
+    # @return [void]
+    def apply_services
+      apply(@stage.services, 'service')
+    end
+
+    # Run all deploy jobs
+    #
+    # @return [void]
+    def run_deploy_jobs
+      run_jobs('deploy')
+    end
+
+    # Run all install jobs
+    #
+    # @return [void]
+    def run_install_jobs
+      run_jobs('install')
+    end
+
+    # Run a full deployment
+    #
+    # @return [void]
+    def deploy
+      deployment_id = SecureRandom.hex(6)
+      deployments = @stage.deployments
+      if deployments.empty?
+        puts 'There are no deployment objects defined.'
+        return true
+      end
+
+      puts "Using deployment ID: #{deployment_id}"
+
+      deployments.each do |deployment|
+        deployment.insert_deployment_id!(deployment_id)
+      end
+
+      apply(deployments, 'deployment')
+      puts 'Waiting for all deployments to roll out...'
+
+      monitor = DeploymentMonitor.new(@stage, deployment_id)
+      monitor.on_success do |poll|
+        if poll.replica_sets.size == 1
+          puts "\e[32mDeployment rolled out successfully\e[0m"
+        else
+          puts "\e[32mAll #{poll.replica_sets.size} deployments all rolled out successfully\e[0m"
+        end
+      end
+
+      monitor.on_wait do |poll|
+        puts "Waiting for #{poll.pending.size} #{poll.pending.size == 1 ? 'deployment' : 'deployments'} (#{poll.pending_names.join(', ')})"
+      end
+
+      monitor.on_failure do |poll|
+        puts "\e[31mLooks like things aren't going to plan with some deployments.\e[0m"
+        puts 'You can review potential issues using the commads below:'
+
+        poll.pending.each do |rs|
+          puts
+          name = rs.name.split('-').first
+          puts "  hippo #{@stage.name} kubectl -- describe deployment \e[35m#{name}\e[0m"
+          puts "  hippo #{@stage.name} kubectl -- logs deployment/\e[35m#{name}\e[0m --all-containers"
+        end
+        puts
+      end
+
+      monitor.wait
+    end
+
+    private
+
+    def apply(objects, type)
+      puts "Applying #{objects.size} #{type} #{objects.size == 1 ? 'object' : 'objects'}"
+      @stage.apply(objects)
+    end
+
+    def run_jobs(type)
+      puts "Running #{type} jobs"
+      jobs = @stage.jobs(type)
+      if jobs.empty?
+        puts "There are no #{type} jobs to run"
+        return true
+      end
+
+      jobs.each do |job|
+        @stage.delete('job', job.name)
+      end
+
+      applied_jobs = apply(jobs, 'deploy job')
+
+      timeout, jobs = @stage.wait_for_jobs(applied_jobs.keys)
+      success_jobs = []
+      failed_jobs = []
+      jobs.each do |job|
+        if job['status']['succeeded']
+          success_jobs << job
+        else
+          failed_jobs << job
+        end
+      end
+
+      if success_jobs.size == jobs.size
+        puts 'All jobs completed successfully'
+        puts 'You can review the logs for these by running the commands below'
+        puts
+        result = true
+      else
+        puts "\e[31mNot all install jobs completed successfully.\e[0m"
+        puts 'You should review the logs for these using the commands below'
+        puts
+        result = false
+      end
+
+      jobs.each do |job|
+        icon = if job['status']['succeeded']
+                 '✅'
+               else
+                 '❌'
+               end
+        puts "  #{icon}  " + @stage.kubectl("logs job/#{job.name}").join(' ')
+      end
+      puts
+      result
+    end
+
+    class << self
+      def setup(context)
+        manifest = Hippo::Manifest.load_from_file(context.options[:hippofile] || './Hippofile')
+
+        stage = manifest.stages[CURRENT_STAGE]
+        if stage.nil?
+          raise Error, "Invalid stage name `#{CURRENT_STAGE}`. Check this has been defined in in your stages directory with a matching name?"
+        end
+
+        new(manifest, stage)
+      end
+    end
+  end
+end