hetzner-k3s 0.5.0 → 0.5.1

data/lib/hetzner/k3s/cli.rb

@@ -1,13 +1,14 @@
-require "thor"
-require "http"
-require "sshkey"
+# frozen_string_literal: true
+
+require 'thor'
+require 'http'
+require 'sshkey'
 require 'ipaddr'
 require 'open-uri'
-require "yaml"
-
-require_relative "cluster"
-require_relative "version"
+require 'yaml'
 
+require_relative 'cluster'
+require_relative 'version'
 
 module Hetzner
   module K3s
@@ -16,354 +17,364 @@ module Hetzner
         true
       end
 
-      desc "version", "Print the version"
+      def initialize(*args)
+        @errors = []
+        @used_server_types = []
+
+        super
+      end
+
+      desc 'version', 'Print the version'
       def version
         puts Hetzner::K3s::VERSION
       end
 
-      desc "create-cluster", "Create a k3s cluster in Hetzner Cloud"
+      desc 'create-cluster', 'Create a k3s cluster in Hetzner Cloud'
       option :config_file, required: true
-
       def create_cluster
-        validate_config_file :create
-        Cluster.new(hetzner_client: hetzner_client, hetzner_token: find_hetzner_token).create configuration: configuration
+        validate_configuration :create
+        Cluster.new(hetzner_client:, hetzner_token:).create configuration:
       end
 
-      desc "delete-cluster", "Delete an existing k3s cluster in Hetzner Cloud"
+      desc 'delete-cluster', 'Delete an existing k3s cluster in Hetzner Cloud'
       option :config_file, required: true
-
       def delete_cluster
-        validate_config_file :delete
-        Cluster.new(hetzner_client: hetzner_client, hetzner_token: find_hetzner_token).delete configuration: configuration
+        validate_configuration :delete
+        Cluster.new(hetzner_client:, hetzner_token:).delete configuration:
       end
 
-      desc "upgrade-cluster", "Upgrade an existing k3s cluster in Hetzner Cloud to a new version"
+      desc 'upgrade-cluster', 'Upgrade an existing k3s cluster in Hetzner Cloud to a new version'
       option :config_file, required: true
       option :new_k3s_version, required: true
-      option :force, default: "false"
-
+      option :force, default: 'false'
       def upgrade_cluster
-        validate_config_file :upgrade
-        Cluster.new(hetzner_client: hetzner_client, hetzner_token: find_hetzner_token).upgrade configuration: configuration, new_k3s_version: options[:new_k3s_version], config_file: options[:config_file]
+        validate_configuration :upgrade
+
+        Cluster.new(hetzner_client:, hetzner_token:)
+               .upgrade(configuration:, new_k3s_version: options[:new_k3s_version], config_file: options[:config_file])
       end
 
-      desc "releases", "List available k3s releases"
+      desc 'releases', 'List available k3s releases'
       def releases
-        find_available_releases.each do |release|
+        available_releases.each do |release|
           puts release
         end
       end
 
       private
 
-        attr_reader :configuration, :hetzner_client, :k3s_version
-        attr_accessor :errors, :used_server_types
-
-        def validate_config_file(action)
-          config_file_path = options[:config_file]
-
-          if File.exists?(config_file_path)
-            begin
-              @configuration = YAML.load_file(options[:config_file])
-              unless configuration.is_a? Hash
-                raise "Configuration is invalid"
-                exit 1
-              end
-            rescue => e
-              puts "Please ensure that the config file is a correct YAML manifest."
-              exit 1
-            end
-          else
-            puts "Please specify a correct path for the config file."
-            exit 1
-          end
+      attr_reader :configuration, :hetzner_client, :k3s_version
+      attr_accessor :errors, :used_server_types
+
+      def validate_configuration(action)
+        validate_configuration_file
+        validate_token
+        validate_cluster_name
+        validate_kubeconfig_path
+
+        case action
+        when :create
+          validate_create
+        when :delete
+          validate_kubeconfig_path_must_exist
+        when :upgrade
+          validate_upgrade
+        end
 
-          @errors = []
-          @used_server_types = []
-
-          validate_token
-          validate_cluster_name
-          validate_kubeconfig_path
-
-          case action
-          when :create
-            validate_public_ssh_key
-            validate_private_ssh_key
-            validate_ssh_allowed_networks
-            validate_location
-            validate_k3s_version
-            validate_masters
-            validate_worker_node_pools
-            validate_verify_host_key
-            validate_additional_packages
-          when :delete
-            validate_kubeconfig_path_must_exist
-          when :upgrade
-            validate_kubeconfig_path_must_exist
-            validate_new_k3s_version
-          end
+        errors.flatten!
 
-          errors.flatten!
+        return if errors.empty?
 
-          unless errors.empty?
-            puts "Some information in the configuration file requires your attention:"
-            errors.each do |error|
-              puts " - #{error}"
-            end
+        puts 'Some information in the configuration file requires your attention:'
 
-            exit 1
-          end
+        errors.each do |error|
+          puts " - #{error}"
         end
 
-        def valid_token?
-          return @valid unless @valid.nil?
+        exit 1
+      end
 
-          begin
-            token = find_hetzner_token
-            @hetzner_client = Hetzner::Client.new(token: token)
-            response = hetzner_client.get("/locations")
-            error_code = response.dig("error", "code")
-            @valid = if error_code and error_code.size > 0
-              false
-            else
-              true
-            end
-          rescue
-            @valid = false
-          end
+      def valid_token?
+        return @valid unless @valid.nil?
+
+        begin
+          token = hetzner_token
+          @hetzner_client = Hetzner::Client.new(token:)
+          response = hetzner_client.get('/locations')
+          error_code = response.dig('error', 'code')
+          @valid = error_code&.size != 0
+        rescue StandardError
+          @valid = false
         end
+      end
 
-        def validate_token
-          errors << "Invalid Hetzner Cloud token" unless valid_token?
-        end
+      def validate_token
+        errors << 'Invalid Hetzner Cloud token' unless valid_token?
+      end
 
-        def validate_cluster_name
-          errors << "Cluster name is an invalid format (only lowercase letters, digits and dashes are allowed)" unless configuration["cluster_name"] =~ /\A[a-z\d-]+\z/
-          errors << "Ensure that the cluster name starts with a normal letter" unless configuration["cluster_name"] =~ /\A[a-z]+.*\z/
-        end
+      def validate_cluster_name
+        errors << 'Cluster name is an invalid format (only lowercase letters, digits and dashes are allowed)' unless configuration['cluster_name'] =~ /\A[a-z\d-]+\z/
 
-        def validate_kubeconfig_path
-          path = File.expand_path(configuration.dig("kubeconfig_path"))
-          errors << "kubeconfig path cannot be a directory" and return if File.directory? path
+        return if configuration['cluster_name'] =~ /\A[a-z]+.*\z/
 
-          directory = File.dirname(path)
-          errors << "Directory #{directory} doesn't exist" unless File.exists? directory
-        rescue
-          errors << "Invalid path for the kubeconfig"
-        end
+        errors << 'Ensure that the cluster name starts with a normal letter'
+      end
 
-        def validate_public_ssh_key
-          path = File.expand_path(configuration.dig("public_ssh_key_path"))
-          errors << "Invalid Public SSH key path" and return unless File.exists? path
+      def validate_kubeconfig_path
+        path = File.expand_path(configuration['kubeconfig_path'])
+        errors << 'kubeconfig path cannot be a directory' and return if File.directory? path
 
-          key = File.read(path)
-          errors << "Public SSH key is invalid" unless ::SSHKey.valid_ssh_public_key?(key)
-        rescue
-          errors << "Invalid Public SSH key path"
-        end
+        directory = File.dirname(path)
+        errors << "Directory #{directory} doesn't exist" unless File.exist? directory
+      rescue StandardError
+        errors << 'Invalid path for the kubeconfig'
+      end
 
-        def validate_private_ssh_key
-          return unless (private_ssh_key_path = configuration.dig("private_ssh_key_path"))
+      def validate_public_ssh_key
+        path = File.expand_path(configuration['public_ssh_key_path'])
+        errors << 'Invalid Public SSH key path' and return unless File.exist? path
 
-          path = File.expand_path(private_ssh_key_path)
-          errors << "Invalid Private SSH key path" and return unless File.exists?(path)
-        rescue
-          errors << "Invalid Private SSH key path"
-        end
+        key = File.read(path)
+        errors << 'Public SSH key is invalid' unless ::SSHKey.valid_ssh_public_key?(key)
+      rescue StandardError
+        errors << 'Invalid Public SSH key path'
+      end
 
-        def validate_kubeconfig_path_must_exist
-          path = File.expand_path configuration.dig("kubeconfig_path")
-          errors << "kubeconfig path is invalid" and return unless File.exists? path
-          errors << "kubeconfig path cannot be a directory" if File.directory? path
-        rescue
-          errors << "Invalid kubeconfig path"
-        end
+      def validate_private_ssh_key
+        private_ssh_key_path = configuration['private_ssh_key_path']
 
-        def server_types
-          return [] unless valid_token?
-          @server_types ||= hetzner_client.get("/server_types")["server_types"].map{ |server_type| server_type["name"] }
-        rescue
-          @errors << "Cannot fetch server types with Hetzner API, please try again later"
-          false
-        end
+        return unless private_ssh_key_path
 
-        def locations
-          return [] unless valid_token?
-          @locations ||= hetzner_client.get("/locations")["locations"].map{ |location| location["name"] }
-        rescue
-          @errors << "Cannot fetch locations with Hetzner API, please try again later"
-          []
-        end
+        path = File.expand_path(private_ssh_key_path)
+        errors << 'Invalid Private SSH key path' and return unless File.exist?(path)
+      rescue StandardError
+        errors << 'Invalid Private SSH key path'
+      end
 
-        def validate_location
-          return if locations.empty? && !valid_token?
-          errors << "Invalid location - available locations: nbg1 (Nuremberg, Germany), fsn1 (Falkenstein, Germany), hel1 (Helsinki, Finland) or ash (Ashburn, Virginia, USA)" unless locations.include? configuration.dig("location")
-        end
+      def validate_kubeconfig_path_must_exist
+        path = File.expand_path configuration['kubeconfig_path']
+        errors << 'kubeconfig path is invalid' and return unless File.exist? path
 
-        def find_available_releases
-          @available_releases ||= begin
-            response = HTTP.get("https://api.github.com/repos/k3s-io/k3s/tags?per_page=999").body
-            JSON.parse(response).map { |hash| hash["name"] }
-          end
-        rescue
-          errors << "Cannot fetch the releases with Hetzner API, please try again later"
-        end
+        errors << 'kubeconfig path cannot be a directory' if File.directory? path
+      rescue StandardError
+        errors << 'Invalid kubeconfig path'
+      end
 
-        def validate_k3s_version
-          k3s_version = configuration.dig("k3s_version")
-          available_releases = find_available_releases
-          errors << "Invalid k3s version" unless available_releases.include? k3s_version
-        end
+      def server_types
+        return [] unless valid_token?
 
-        def validate_new_k3s_version
-          new_k3s_version = options[:new_k3s_version]
-          available_releases = find_available_releases
-          errors << "The new k3s version is invalid" unless available_releases.include? new_k3s_version
-        end
+        @server_types ||= hetzner_client.get('/server_types')['server_types'].map { |server_type| server_type['name'] }
+      rescue StandardError
+        @errors << 'Cannot fetch server types with Hetzner API, please try again later'
+        false
+      end
 
-        def validate_masters
-          masters_pool = nil
+      def locations
+        return [] unless valid_token?
 
-          begin
-            masters_pool = configuration.dig("masters")
-          rescue
-            errors << "Invalid masters configuration"
-            return
-          end
+        @locations ||= hetzner_client.get('/locations')['locations'].map { |location| location['name'] }
+      rescue StandardError
+        @errors << 'Cannot fetch locations with Hetzner API, please try again later'
+        []
+      end
 
-          if masters_pool.nil?
-            errors << "Invalid masters configuration"
-            return
-          end
+      def validate_location
+        return if locations.empty? && !valid_token?
+        return if locations.include? configuration['location']
 
-          validate_instance_group masters_pool, workers: false
+        errors << 'Invalid location - available locations: nbg1 (Nuremberg, Germany), fsn1 (Falkenstein, Germany), hel1 (Helsinki, Finland) or ash (Ashburn, Virginia, USA)'
+      end
+
+      def available_releases
+        @available_releases ||= begin
+          response = HTTP.get('https://api.github.com/repos/k3s-io/k3s/tags?per_page=999').body
+          JSON.parse(response).map { |hash| hash['name'] }
         end
+      rescue StandardError
+        errors << 'Cannot fetch the releases with Hetzner API, please try again later'
+      end
 
-        def validate_worker_node_pools
-          worker_node_pools = nil
+      def validate_k3s_version
+        k3s_version = configuration['k3s_version']
+        errors << 'Invalid k3s version' unless available_releases.include? k3s_version
+      end
 
-          begin
-            worker_node_pools = configuration.dig("worker_node_pools")
-          rescue
-            unless schedule_workloads_on_masters?
-              errors << "Invalid node pools configuration"
-              return
-            end
-          end
+      def validate_new_k3s_version
+        new_k3s_version = options[:new_k3s_version]
+        errors << 'The new k3s version is invalid' unless available_releases.include? new_k3s_version
+      end
 
-          if worker_node_pools.nil? && schedule_workloads_on_masters?
-            return
-          end
+      def validate_masters
+        masters_pool = nil
 
-          if !worker_node_pools.is_a? Array
-            errors << "Invalid node pools configuration"
-          elsif worker_node_pools.size == 0
-            unless schedule_workloads_on_masters?
-              errors << "At least one node pool is required in order to schedule workloads"
-            end
-          elsif worker_node_pools.map{ |worker_node_pool| worker_node_pool["name"]}.uniq.size != worker_node_pools.size
-            errors << "Each node pool must have an unique name"
-          elsif server_types
-            worker_node_pools.each do |worker_node_pool|
-              validate_instance_group worker_node_pool
-            end
-          end
+        begin
+          masters_pool = configuration['masters']
+        rescue StandardError
+          errors << 'Invalid masters configuration'
+          return
         end
 
-        def schedule_workloads_on_masters?
-          schedule_workloads_on_masters = configuration.dig("schedule_workloads_on_masters")
-          schedule_workloads_on_masters ? !!schedule_workloads_on_masters : false
+        if masters_pool.nil?
+          errors << 'Invalid masters configuration'
+          return
         end
 
-        def validate_instance_group(instance_group, workers: true)
-          instance_group_errors = []
+        validate_instance_group masters_pool, workers: false
+      end
 
-          instance_group_type = workers ? "Worker mode pool #{instance_group["name"]}" : "Masters pool"
+      def validate_worker_node_pools
+        worker_node_pools = configuration['worker_node_pools'] || []
 
-          unless !workers || instance_group["name"] =~ /\A([A-Za-z0-9\-\_]+)\Z/
-            instance_group_errors << "#{instance_group_type} has an invalid name"
-          end
+        unless worker_node_pools.size.positive? || schedule_workloads_on_masters?
+          errors << 'Invalid node pools configuration'
+          return
+        end
 
-          unless instance_group.is_a? Hash
-            instance_group_errors << "#{instance_group_type} is in an invalid format"
+        return if worker_node_pools.size.zero? && schedule_workloads_on_masters?
+
+        if !worker_node_pools.is_a? Array
+          errors << 'Invalid node pools configuration'
+        elsif worker_node_pools.size.zero?
+          errors << 'At least one node pool is required in order to schedule workloads' unless schedule_workloads_on_masters?
+        elsif worker_node_pools.map { |worker_node_pool| worker_node_pool['name'] }.uniq.size != worker_node_pools.size
+          errors << 'Each node pool must have an unique name'
+        elsif server_types
+          worker_node_pools.each do |worker_node_pool|
+            validate_instance_group worker_node_pool
           end
+        end
+      end
 
-          unless !valid_token? or server_types.include?(instance_group["instance_type"])
-            instance_group_errors << "#{instance_group_type} has an invalid instance type"
-          end
+      def schedule_workloads_on_masters?
+        schedule_workloads_on_masters = configuration['schedule_workloads_on_masters']
+        schedule_workloads_on_masters ? !!schedule_workloads_on_masters : false
+      end
 
-          if instance_group["instance_count"].is_a? Integer
-            if instance_group["instance_count"] < 1
-              instance_group_errors << "#{instance_group_type} must have at least one node"
-            elsif !workers
-              instance_group_errors << "Masters count must equal to 1 for non-HA clusters or an odd number (recommended 3) for an HA cluster" unless instance_group["instance_count"].odd?
-            end
-          else
-            instance_group_errors << "#{instance_group_type} has an invalid instance count"
-          end
+      def validate_instance_group(instance_group, workers: true)
+        instance_group_errors = []
 
-          used_server_types << instance_group["instance_type"]
+        instance_group_type = workers ? "Worker mode pool '#{instance_group['name']}'" : 'Masters pool'
 
-          errors << instance_group_errors
-        end
+        instance_group_errors << "#{instance_group_type} has an invalid name" unless !workers || instance_group['name'] =~ /\A([A-Za-z0-9\-_]+)\Z/
 
-        def validate_verify_host_key
-          return unless [true, false].include?(configuration.fetch("public_ssh_key_path", false))
-          errors << "Please set the verify_host_key option to either true or false"
-        end
+        instance_group_errors << "#{instance_group_type} is in an invalid format" unless instance_group.is_a? Hash
 
-        def find_hetzner_token
-          @token = ENV["HCLOUD_TOKEN"]
-          return @token if @token
-          @token = configuration.dig("hetzner_token")
+        instance_group_errors << "#{instance_group_type} has an invalid instance type" unless !valid_token? || server_types.include?(instance_group['instance_type'])
+
+        if instance_group['instance_count'].is_a? Integer
+          if instance_group['instance_count'] < 1
+            instance_group_errors << "#{instance_group_type} must have at least one node"
+          elsif instance_group['instance_count'] > 10
+            instance_group_errors << "#{instance_group_type} cannot have more than 10 nodes due to a limitation with the Hetzner placement groups. You can add more node pools if you need more nodes."
+          elsif !workers
+            instance_group_errors << 'Masters count must equal to 1 for non-HA clusters or an odd number (recommended 3) for an HA cluster' unless instance_group['instance_count'].odd?
+          end
+        else
+          instance_group_errors << "#{instance_group_type} has an invalid instance count"
         end
 
-        def validate_ssh_allowed_networks
-          networks ||= configuration.dig("ssh_allowed_networks")
+        used_server_types << instance_group['instance_type']
 
-          if networks.nil? or networks.empty?
-            errors << "At least one network/IP range must be specified for SSH access"
-            return
-          end
+        errors << instance_group_errors
+      end
 
-          invalid_networks = networks.reject do |network|
-            IPAddr.new(network) rescue false
-          end
+      def validate_verify_host_key
+        return unless [true, false].include?(configuration.fetch('public_ssh_key_path', false))
 
-          unless invalid_networks.empty?
-            invalid_networks.each do |network|
-              errors << "The network #{network} is an invalid range"
-            end
-          end
+        errors << 'Please set the verify_host_key option to either true or false'
+      end
 
-          invalid_ranges = networks.reject do |network|
-            network.include? "/"
-          end
+      def hetzner_token
+        @token = ENV['HCLOUD_TOKEN']
+        return @token if @token
 
-          unless invalid_ranges.empty?
-            invalid_ranges.each do |network|
-              errors << "Please use the CIDR notation for the networks to avoid ambiguity"
-            end
-          end
+        @token = configuration['hetzner_token']
+      end
 
-          return unless invalid_networks.empty?
+      def validate_ssh_allowed_networks
+        networks ||= configuration['ssh_allowed_networks']
 
-          current_ip = URI.open('http://whatismyip.akamai.com').read
+        if networks.nil? || networks.empty?
+          errors << 'At least one network/IP range must be specified for SSH access'
+          return
+        end
 
-          current_ip_networks = networks.detect do |network|
-            IPAddr.new(network).include?(current_ip) rescue false
+        invalid_networks = networks.reject do |network|
+          IPAddr.new(network)
+        rescue StandardError
+          false
+        end
+
+        unless invalid_networks.empty?
+          invalid_networks.each do |network|
+            errors << "The network #{network} is an invalid range"
           end
+        end
+
+        invalid_ranges = networks.reject do |network|
+          network.include? '/'
+        end
 
-          unless current_ip_networks
-            errors << "Your current IP #{current_ip} is not included into any of the networks you've specified, so we won't be able to SSH into the nodes"
+        unless invalid_ranges.empty?
+          invalid_ranges.each do |_network|
+            errors << 'Please use the CIDR notation for the networks to avoid ambiguity'
           end
         end
 
-        def validate_additional_packages
-          additional_packages = configuration.dig("additional_packages")
-          errors << "Invalid additional packages configuration - it should be an array" if additional_packages && !additional_packages.is_a?(Array)
+        return unless invalid_networks.empty?
+
+        current_ip = URI.open('http://whatismyip.akamai.com').read
+
+        current_ip_networks = networks.detect do |network|
+          IPAddr.new(network).include?(current_ip)
+        rescue StandardError
+          false
         end
 
+        errors << "Your current IP #{current_ip} is not included into any of the networks you've specified, so we won't be able to SSH into the nodes" unless current_ip_networks
+      end
+
+      def validate_additional_packages
+        additional_packages = configuration['additional_packages']
+        errors << 'Invalid additional packages configuration - it should be an array' if additional_packages && !additional_packages.is_a?(Array)
+      end
+
+      def validate_create
+        validate_public_ssh_key
+        validate_private_ssh_key
+        validate_ssh_allowed_networks
+        validate_location
+        validate_k3s_version
+        validate_masters
+        validate_worker_node_pools
+        validate_verify_host_key
+        validate_additional_packages
+      end
+
+      def validate_upgrade
+        validate_kubeconfig_path_must_exist
+        validate_new_k3s_version
+      end
+
+      def validate_configuration_file
+        config_file_path = options[:config_file]
+
+        if File.exist?(config_file_path)
+          begin
+            @configuration = YAML.load_file(options[:config_file])
+            unless configuration.is_a? Hash
+              puts 'Configuration is invalid'
+              exit 1
+            end
+          rescue StandardError
+            puts 'Please ensure that the config file is a correct YAML manifest.'
+            exit 1
+          end
+        else
+          puts 'Please specify a correct path for the config file.'
+          exit 1
+        end
+      end
     end
   end
 end