hetzner-k3s 0.5.5 → 0.5.8

data/lib/hetzner/k3s/configuration.rb

@@ -0,0 +1,454 @@
+# frozen_string_literal: true
+
+module Hetzner
+  class Configuration
+    GITHUB_DELIM_LINKS = ','.freeze
+    GITHUB_LINK_REGEX = /<([^>]+)>; rel=\"([^\"]+)\"/
+
+    attr_reader :hetzner_client
+
+    def initialize(options:)
+      @options = options
+      @errors = []
+
+      validate_configuration_file
+    end
+
+    def validate(action:)
+      validate_token
+
+      if valid_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
+      end
+
+      errors.flatten!
+
+      return if errors.empty?
+
+      puts 'Some information in the configuration file requires your attention:'
+
+      errors.each do |error|
+        puts " - #{error}"
+      end
+
+      exit 1
+    end
+
+    def self.available_releases
+      @available_releases ||= begin
+        releases = []
+
+        response, page_releases = fetch_releases('https://api.github.com/repos/k3s-io/k3s/tags?per_page=100')
+        releases = page_releases
+        link_header = response.headers['link']
+
+        while !link_header.nil?
+          next_page_url = extract_next_github_page_url(link_header)
+
+          break if next_page_url.nil?
+
+          response, page_releases = fetch_releases(next_page_url)
+
+          releases += page_releases
+
+          link_header = response.headers['link']
+        end
+
+        releases.sort
+      end
+    rescue StandardError
+      if defined?errors
+        errors << 'Cannot fetch the releases with Hetzner API, please try again later'
+      else
+        puts 'Cannot fetch the releases with Hetzner API, please try again later'
+      end
+    end
+
+    def hetzner_token
+      return @token unless @token.nil?
+
+      @token = ENV.fetch('HCLOUD_TOKEN', configuration['hetzner_token'])
+    end
+
+    def [](key)
+      configuration[key]
+    end
+
+    def fetch(key, default)
+      configuration.fetch(key, default)
+    end
+
+    def raw
+      configuration
+    end
+
+    private
+
+    attr_reader :configuration, :errors, :options
+
+    def self.fetch_releases(url)
+      response = HTTP.get(url)
+      [response, JSON.parse(response.body).map { |hash| hash['name'] }]
+    end
+
+    def self.extract_next_github_page_url(link_header)
+      link_header.split(GITHUB_DELIM_LINKS).each do |link|
+        GITHUB_LINK_REGEX.match(link.strip) do |match|
+          url_part, meta_part = match[1], match[2]
+          next if !url_part || !meta_part
+          return url_part if meta_part == "next"
+        end
+      end
+
+      nil
+    end
+
+    def self.assign_url_part(meta_part, url_part)
+      case meta_part
+      when "next"
+        url_part
+      end
+    end
+
+    def validate_create
+      validate_public_ssh_key
+      validate_private_ssh_key
+      validate_ssh_allowed_networks
+      validate_masters_location
+      validate_k3s_version
+      validate_masters
+      validate_worker_node_pools
+      validate_verify_host_key
+      validate_additional_packages
+      validate_post_create_commands
+      validate_kube_api_server_args
+      validate_kube_scheduler_args
+      validate_kube_controller_manager_args
+      validate_kube_cloud_controller_manager_args
+      validate_kubelet_args
+      validate_kube_proxy_args
+    end
+
+    def validate_upgrade
+      validate_kubeconfig_path_must_exist
+      validate_new_k3s_version
+    end
+
+    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
+
+      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_private_ssh_key
+      private_ssh_key_path = configuration['private_ssh_key_path']
+
+      return unless private_ssh_key_path
+
+      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_ssh_allowed_networks
+      networks ||= configuration['ssh_allowed_networks']
+
+      if networks.nil? || networks.empty?
+        errors << 'At least one network/IP range must be specified for SSH access'
+        return
+      end
+
+      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 invalid_ranges.empty?
+        invalid_ranges.each do |_network|
+          errors << 'Please use the CIDR notation for the networks to avoid ambiguity'
+        end
+      end
+
+      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_masters_location
+      return if valid_location?(configuration['location'])
+
+      errors << 'Invalid location for master nodes - valid locations: nbg1 (Nuremberg, Germany), fsn1 (Falkenstein, Germany), hel1 (Helsinki, Finland) or ash (Ashburn, Virginia, USA)'
+    end
+
+    def validate_k3s_version
+      k3s_version = configuration['k3s_version']
+      errors << 'Invalid k3s version' unless Hetzner::Configuration.available_releases.include? k3s_version
+    end
+
+    def validate_masters
+      masters_pool = nil
+
+      begin
+        masters_pool = configuration['masters']
+      rescue StandardError
+        errors << 'Invalid masters configuration'
+        return
+      end
+
+      if masters_pool.nil?
+        errors << 'Invalid masters configuration'
+        return
+      end
+
+      validate_instance_group masters_pool, workers: false
+    end
+
+    def validate_worker_node_pools
+      worker_node_pools = configuration['worker_node_pools'] || []
+
+      unless worker_node_pools.size.positive? || schedule_workloads_on_masters?
+        errors << 'Invalid node pools configuration'
+        return
+      end
+
+      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
+
+    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
+
+    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_post_create_commands
+      post_create_commands = configuration['post_create_commands']
+      errors << 'Invalid post create commands configuration - it should be an array' if post_create_commands && !post_create_commands.is_a?(Array)
+    end
+
+    def validate_kube_api_server_args
+      kube_api_server_args = configuration['kube_api_server_args']
+      return unless kube_api_server_args
+
+      errors << 'kube_api_server_args must be an array of arguments' unless kube_api_server_args.is_a? Array
+    end
+
+    def validate_kube_scheduler_args
+      kube_scheduler_args = configuration['kube_scheduler_args']
+      return unless kube_scheduler_args
+
+      errors << 'kube_scheduler_args must be an array of arguments' unless kube_scheduler_args.is_a? Array
+    end
+
+    def validate_kube_controller_manager_args
+      kube_controller_manager_args = configuration['kube_controller_manager_args']
+      return unless kube_controller_manager_args
+
+      errors << 'kube_controller_manager_args must be an array of arguments' unless kube_controller_manager_args.is_a? Array
+    end
+
+    def validate_kube_cloud_controller_manager_args
+      kube_cloud_controller_manager_args = configuration['kube_cloud_controller_manager_args']
+      return unless kube_cloud_controller_manager_args
+
+      errors << 'kube_cloud_controller_manager_args must be an array of arguments' unless kube_cloud_controller_manager_args.is_a? Array
+    end
+
+    def validate_kubelet_args
+      kubelet_args = configuration['kubelet_args']
+      return unless kubelet_args
+
+      errors << 'kubelet_args must be an array of arguments' unless kubelet_args.is_a? Array
+    end
+
+    def validate_kube_proxy_args
+      kube_proxy_args = configuration['kube_proxy_args']
+      return unless kube_proxy_args
+
+      errors << 'kube_proxy_args must be an array of arguments' unless kube_proxy_args.is_a? Array
+    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
+
+    def validate_token
+      errors << 'Invalid Hetzner Cloud token' unless valid_token?
+    end
+
+    def validate_kubeconfig_path
+      path = File.expand_path(configuration['kubeconfig_path'])
+      errors << 'kubeconfig path cannot be a directory' and return if File.directory? path
+
+      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_kubeconfig_path_must_exist
+      path = File.expand_path configuration['kubeconfig_path']
+      errors << 'kubeconfig path is invalid' and return unless File.exist? path
+
+      errors << 'kubeconfig path cannot be a directory' if File.directory? path
+    rescue StandardError
+      errors << 'Invalid kubeconfig path'
+    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/
+
+      return if configuration['cluster_name'] =~ /\A[a-z]+.*([a-z]|\d)+\z/
+
+      errors << 'Ensure that the cluster name starts and ends with a normal letter'
+    end
+
+    def validate_new_k3s_version
+      new_k3s_version = options[:new_k3s_version]
+      errors << 'The new k3s version is invalid' unless Hetzner::Configuration.available_releases.include? new_k3s_version
+    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 != 'unauthorized'
+      rescue StandardError
+        @valid = false
+      end
+    end
+
+    def validate_instance_group(instance_group, workers: true)
+      instance_group_errors = []
+
+      instance_group_type = workers ? "Worker mode pool '#{instance_group['name']}'" : 'Masters pool'
+
+      instance_group_errors << "#{instance_group_type} has an invalid name" unless !workers || instance_group['name'] =~ /\A([A-Za-z0-9\-_]+)\Z/
+
+      instance_group_errors << "#{instance_group_type} is in an invalid format" unless instance_group.is_a? Hash
+
+      instance_group_errors << "#{instance_group_type} has an invalid instance type" unless !valid_token? || server_types.include?(instance_group['instance_type'])
+
+      if workers
+        location = instance_group.fetch('location', configuration['location'])
+        instance_group_errors << "#{instance_group_type} has an invalid location - valid locations: nbg1 (Nuremberg, Germany), fsn1 (Falkenstein, Germany), hel1 (Helsinki, Finland) or ash (Ashburn, Virginia, USA)" unless valid_location?(location)
+
+        in_network_zone = configuration['location'] == 'ash' ? location == 'ash' : location != 'ash'
+        instance_group_errors << "#{instance_group_type} must be in the same network zone as the masters. If the masters are located in Ashburn, all the node pools must be located in Ashburn too, otherwise none of the node pools should be located in Ashburn." unless in_network_zone
+      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 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
+
+      errors << instance_group_errors
+    end
+
+    def valid_location?(location)
+      return if locations.empty? && !valid_token?
+
+      locations.include? location
+    end
+
+    def locations
+      return [] unless valid_token?
+
+      @locations ||= hetzner_client.get('/locations')['locations'].map { |location| location['name'] }
+    rescue StandardError
+      @errors << 'Cannot fetch locations with Hetzner API, please try again later'
+      []
+    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
+
+    def server_types
+      return [] unless valid_token?
+
+      @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
+  end
+end

data/lib/hetzner/k3s/version.rb

@@ -2,6 +2,6 @@
 
 module Hetzner
   module K3s
-    VERSION = '0.5.5'
+    VERSION = '0.5.8'
   end
 end

data/lib/hetzner/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Utils
   CMD_FILE_PATH = '/tmp/cli.cmd'
 
@@ -32,6 +34,7 @@ module Utils
       at_exit do
         process&.send_signal('SIGTERM')
       rescue Errno::ESRCH, Interrupt
+        # ignore
       end
 
       Subprocess.check_call(['bash', '-c', CMD_FILE_PATH], env:) do |p|
@@ -55,13 +58,13 @@ module Utils
       puts "Waiting for server #{server_name} to be up..."
 
       loop do
-        result = ssh(server, 'echo UP')
-        break if result == 'UP'
+        result = ssh(server, 'cat /etc/ready')
+        break if result == 'true'
       end
 
       puts "...server #{server_name} is now up."
     end
-  rescue Errno::ENETUNREACH, Errno::EHOSTUNREACH, Timeout::Error, IOError
+  rescue Errno::ENETUNREACH, Errno::EHOSTUNREACH, Timeout::Error, IOError, Errno::ECONNRESET
     retries += 1
     retry if retries <= 15
   end
@@ -78,7 +81,7 @@ module Utils
 
     Net::SSH.start(public_ip, 'root', params) do |session|
       session.exec!(command) do |_channel, _stream, data|
-        output << data
+        output = "#{output}#{data}"
         puts data if print_output
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hetzner-k3s
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.8
 platform: ruby
 authors:
 - Vito Botta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -161,6 +161,7 @@ files:
 - lib/hetzner/infra/ssh_key.rb
 - lib/hetzner/k3s/cli.rb
 - lib/hetzner/k3s/cluster.rb
+- lib/hetzner/k3s/configuration.rb
 - lib/hetzner/k3s/version.rb
 - lib/hetzner/utils.rb
 homepage: https://github.com/vitobotta/hetzner-k3s
@@ -179,14 +180,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.1.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A CLI to create a Kubernetes cluster in Hetzner Cloud very quickly using