hetzner-k3s 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6c87ae355b79344110f8b822668072438b9b496b602177b3d6528e56a75aea8
-  data.tar.gz: 9be4a8945d32c22f4810389b9330707177749d8c18d6416d73a6bbbdef4ff3a9
+  metadata.gz: 4f45064341000a4cf3a3ec6aef60c2b26eb95758e3c0e1d16c87740b8e549834
+  data.tar.gz: 0ec683973e5c27811c8f9a2d82804ce3721d9a93137c46d15087f8e06a9fe4b2
 SHA512:
-  metadata.gz: 7c852a9f0b9b4e3dd80f5c33007f39d4191a9588874cac0d03904c15f185686757e45793525a0bf2b87787fe4d8de3969318797300e40aad4811cb74c883628f
-  data.tar.gz: 321d20a09b451ef355095268cf0da68ebefd88a43c3b7261293923b346b5ee5641ee55214cda1a8b53aaf44fa8fedb178303b1e9dd9d7de5856332c135546628
+  metadata.gz: 7ac95d48d017c7997c3e20b7dd3d5160bf5188a4bff9144efc382606bf2d83462221287b8ba9c16ff62b5f3687486f310f042add4c50f06228e0f2da4afb63db
+  data.tar.gz: bd2caff255115cdd82582b5c143249ca92983d4232ab77ba03fe5d4719fc812dfb3af7b8617fc6adaa0c9093ef66c0b6f1cdbdee5f60c25e5f2f819fc6fa8f0b

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    hetzner-k3s (0.1.0)
+    hetzner-k3s (0.3.3)
+      bcrypt_pbkdf
+      ed25519
       http
       k8s-ruby
       net-ssh
@@ -13,6 +15,7 @@ GEM
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    bcrypt_pbkdf (1.1.0)
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     domain_name (0.5.20190701)
@@ -43,6 +46,7 @@ GEM
       dry-equalizer (~> 0.2)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 0.4, >= 0.4.2)
+    ed25519 (1.2.4)
     excon (0.85.0)
     ffi (1.15.3)
     ffi-compiler (1.0.1)

data/README.md

@@ -44,6 +44,7 @@ cluster_name: test
 kubeconfig_path: "./kubeconfig"
 k3s_version: v1.21.3+k3s1
 ssh_key_path: "~/.ssh/id_rsa.pub"
+verify_host_key: false
 location: nbg1
 masters:
   instance_type: cpx21
@@ -74,6 +75,8 @@ curl \
 ```
 
 
+Note: the option `verify_host_key` is by default set to `false` to disable host key verification. This is because sometimes when creating new servers, Hetzner may assign IP addresses that were previously used by other servers you owned in the past. Therefore the host key verification would fail. If you set this option to `true` and this happens, the tool won't be able to continue creating the cluster until you resolve the issue with one of the suggestions it will give you.
+
 Finally, to create the cluster run:
 
 ```bash
@@ -208,6 +211,26 @@ The other annotations should be self explanatory. You can find a list of the ava
 
 Once the cluster is ready you can create persistent volumes out of the box with the default storage class `hcloud-volumes`, since the Hetzner CSI driver is installed automatically. This will use Hetzner's block storage (based on Ceph so it's replicated and highly available) for your persistent volumes. Note that the minimum size of a volume is 10Gi. If you specify a smaller size for a volume, the volume will be created with a capacity of 10Gi anyway.
 
+
+## changelog
+
+- 0.3.3
+  - Add some gems required on Linux
+
+- 0.3.2
+  - Configure DNS to use Cloudflare's resolver instead of Hetzner's, since Hetzner's resolvers are not always reliable
+
+- 0.3.1
+  - Allow enabling/disabling the host key verification
+
+- 0.3.0
+  - Handle case when an SSH key with the given fingerprint already exists in the Hetzner project
+  - Handle a timeout of 5 seconds for requests to the Hetzner API
+  - Retry waiting for server to be up when timeouts/host-unreachable errors occur
+  - Ignore known_hosts entry to prevent errors when recreating servers with IPs that have been used previously
+
+- 0.2.0
+  - Allow mixing servers of different series Intel/AMD
 ## Contributing and support
 
 Please create a PR if you want to propose any changes, or open an issue if you are having trouble with the tool - I will do my best to help if I can.
@@ -218,4 +241,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the hetzner-k3s project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vitobotta/k3s/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the hetzner-k3s project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vitobotta/hetzner-k3s/blob/main/CODE_OF_CONDUCT.md).

data/cluster_config.yaml.example

@@ -4,6 +4,7 @@ cluster_name: test
 kubeconfig_path: "../kubeconfig"
 k3s_version: v1.21.3+k3s1
 ssh_key_path: "~/.ssh/id_rsa.pub"
+verify_host_key: false
 location: nbg1
 masters:
   instance_type: cpx21

data/hetzner-k3s.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "net-ssh"
   spec.add_dependency "k8s-ruby"
   spec.add_dependency "sshkey"
+  spec.add_dependency "ed25519"
+  spec.add_dependency "bcrypt_pbkdf"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/hetzner/infra/client.rb

@@ -9,15 +9,21 @@ module Hetzner
     end
 
     def get(path)
-      JSON.parse HTTP.headers(headers).get(BASE_URI + path).body
+      make_request do
+        JSON.parse HTTP.headers(headers).get(BASE_URI + path).body
+      end
     end
 
     def post(path, data)
-      HTTP.headers(headers).post(BASE_URI + path, json: data)
+      make_request do
+        HTTP.headers(headers).post(BASE_URI + path, json: data)
+      end
     end
 
     def delete(path, id)
-      HTTP.headers(headers).delete(BASE_URI + path + "/" + id.to_s)
+      make_request do
+        HTTP.headers(headers).delete(BASE_URI + path + "/" + id.to_s)
+      end
     end
 
     private
@@ -28,5 +34,13 @@ module Hetzner
           "Content-Type": "application/json"
         }
       end
+
+      def make_request &block
+        Timeout::timeout(5) do
+          block.call
+        end
+      rescue Timeout::Error
+        retry
+      end
   end
 end

data/lib/hetzner/infra/load_balancer.rb

@@ -26,12 +26,12 @@ module Hetzner
       JSON.parse(response)["load_balancer"]["id"]
     end
 
-    def delete
+    def delete(ha:)
       if load_balancer = find_load_balancer
-        puts "Deleting API load balancer..."
+        puts "Deleting API load balancer..." unless ha
         hetzner_client.delete("/load_balancers", load_balancer["id"])
-        puts "...API load balancer deleted."
-      else
+        puts "...API load balancer deleted." unless ha
+      elsif ha
         puts "API load balancer no longer exists, skipping."
       end
 

data/lib/hetzner/infra/server.rb

@@ -74,7 +74,12 @@ module Hetzner
             - sed -i 's/[#]*PermitRootLogin yes/PermitRootLogin prohibit-password/g' /etc/ssh/sshd_config
             - sed -i 's/[#]*PasswordAuthentication yes/PasswordAuthentication no/g' /etc/ssh/sshd_config
             - systemctl restart sshd
-        EOS
+            - systemctl stop systemd-resolved
+            - systemctl disable systemd-resolved
+            - rm /etc/resolv.conf
+            - echo "nameserver 1.1.1.1" > /etc/resolv.conf
+            - echo "nameserver 1.0.0.1" >> /etc/resolv.conf
+            EOS
       end
 
   end

data/lib/hetzner/infra/ssh_key.rb

@@ -26,11 +26,17 @@ module Hetzner
       JSON.parse(response)["ssh_key"]["id"]
     end
 
-    def delete
+    def delete(ssh_key_path:)
+      @ssh_key_path = ssh_key_path
+
       if ssh_key = find_ssh_key
-        puts "Deleting ssh_key..."
-        hetzner_client.delete("/ssh_keys", ssh_key["id"])
-        puts "...ssh_key deleted."
+        if ssh_key["name"] == cluster_name
+          puts "Deleting ssh_key..."
+          hetzner_client.delete("/ssh_keys", ssh_key["id"])
+          puts "...ssh_key deleted."
+        else
+          puts "The SSH key existed before creating the cluster, so I won't delete it."
+        end
       else
         puts "SSH key no longer exists, skipping."
       end
@@ -42,15 +48,33 @@ module Hetzner
 
       attr_reader :hetzner_client, :cluster_name, :ssh_key_path
 
+      def public_key
+        @public_key ||= File.read(ssh_key_path).chop
+      end
+
       def ssh_key_config
         {
           name: cluster_name,
-          public_key: File.read(ssh_key_path)
+          public_key: public_key
         }
       end
 
+      def fingerprint
+        @fingerprint ||= ::SSHKey.fingerprint(public_key)
+      end
+
       def find_ssh_key
-        hetzner_client.get("/ssh_keys")["ssh_keys"].detect{ |ssh_key| ssh_key["name"] == cluster_name }
+        key = hetzner_client.get("/ssh_keys")["ssh_keys"].detect do |ssh_key|
+          ssh_key["fingerprint"] == fingerprint
+        end
+
+        unless key
+          key = hetzner_client.get("/ssh_keys")["ssh_keys"].detect do |ssh_key|
+            ssh_key["name"] == cluster_name
+          end
+        end
+
+        key
       end
 
   end

data/lib/hetzner/k3s/cli.rb

@@ -80,6 +80,7 @@ module Hetzner
             validate_k3s_version
             validate_masters
             validate_worker_node_pools
+            validate_verify_host_key
           when :delete
             validate_kubeconfig_path_must_exist
           when :upgrade
@@ -292,6 +293,12 @@ module Hetzner
           errors << "Cannot connect to the Kubernetes cluster"
           false
         end
+
+
+        def validate_verify_host_key
+          return unless [true, false].include?(configuration.fetch("ssh_key_path", false))
+          errors << "Please set the verify_host_key option to either true or false"
+        end
     end
   end
 end

data/lib/hetzner/k3s/cluster.rb

@@ -29,6 +29,7 @@ class Cluster
     @masters_config = configuration.dig("masters")
     @worker_node_pools = configuration.dig("worker_node_pools")
     @location = configuration.dig("location")
+    @verify_host_key = configuration.fetch("verify_host_key", false)
     @servers = []
 
     create_resources
@@ -45,6 +46,7 @@ class Cluster
   def delete(configuration:)
     @cluster_name = configuration.dig("cluster_name")
     @kubeconfig_path = File.expand_path(configuration.dig("kubeconfig_path"))
+    @ssh_key_path = File.expand_path(configuration.dig("ssh_key_path"))
 
     delete_resources
   end
@@ -67,7 +69,7 @@ class Cluster
                 :masters_config, :worker_node_pools,
                 :location, :ssh_key_path, :kubernetes_client,
                 :hetzner_token, :tls_sans, :new_k3s_version, :configuration,
-                :config_file
+                :config_file, :verify_host_key
 
 
     def latest_k3s_version
@@ -137,17 +139,18 @@ class Cluster
         end
       end
 
-      threads.each(&:join)
+      threads.each(&:join) unless threads.empty?
 
       puts
       threads = servers.map do |server|
         Thread.new { wait_for_ssh server }
       end
 
-      threads.each(&:join)
+      threads.each(&:join) unless threads.empty?
     end
 
     def delete_resources
+      # Deleting nodes defined according to Kubernetes first
       begin
         Timeout::timeout(5) do
           servers = kubernetes_client.api("v1").resource("nodes").list
@@ -158,12 +161,23 @@ class Cluster
             end
           end
 
-          threads.each(&:join)
+          threads.each(&:join) unless threads.empty?
         end
-      rescue Timeout::Error
+      rescue Timeout::Error, Excon::Error::Socket
         puts "Unable to fetch nodes from Kubernetes API. Is the cluster online?"
       end
 
+      # Deleting nodes defined in the config file just in case there are leftovers i.e. nodes that
+      # were not part of the cluster for some reason
+
+      threads = all_servers.map do |server|
+        Thread.new do
+          Hetzner::Server.new(hetzner_client: hetzner_client, cluster_name: cluster_name).delete(server_name: server["name"])
+        end
+      end
+
+      threads.each(&:join) unless threads.empty?
+
       puts
 
       sleep 5 # give time for the servers to actually be deleted
@@ -181,12 +195,12 @@ class Cluster
       Hetzner::SSHKey.new(
         hetzner_client: hetzner_client,
         cluster_name: cluster_name
-      ).delete
+      ).delete(ssh_key_path: ssh_key_path)
 
       Hetzner::LoadBalancer.new(
         hetzner_client: hetzner_client,
         cluster_name: cluster_name
-      ).delete
+      ).delete(ha: (masters.size > 1))
 
     end
 
@@ -279,7 +293,7 @@ class Cluster
           end
         end
 
-        threads.each(&:join)
+        threads.each(&:join) unless threads.empty?
       end
 
       threads = workers.map do |worker|
@@ -294,7 +308,7 @@ class Cluster
         end
       end
 
-      threads.each(&:join)
+      threads.each(&:join) unless threads.empty?
     end
 
     def deploy_cloud_controller_manager
@@ -431,17 +445,19 @@ class Cluster
     end
 
     def wait_for_ssh(server)
-      server_name = server["name"]
+      Timeout::timeout(5) do
+        server_name = server["name"]
 
-      puts "Waiting for server #{server_name} to be up..."
+        puts "Waiting for server #{server_name} to be up..."
 
-      loop do
-        result = ssh(server, "echo UP")
-        break if result == "UP"
-      end
+        loop do
+          result = ssh(server, "echo UP")
+          break if result == "UP"
+        end
 
-      puts "...server #{server_name} is now up."
-    rescue Errno::ENETUNREACH
+        puts "...server #{server_name} is now up."
+      end
+    rescue Errno::ENETUNREACH, Errno::EHOSTUNREACH, Timeout::Error
       retry
     end
 
@@ -449,20 +465,23 @@ class Cluster
       public_ip = server.dig("public_net", "ipv4", "ip")
       output = ""
 
-      Net::SSH.start(public_ip, "root") do |session|
+      Net::SSH.start(public_ip, "root", verify_host_key: (verify_host_key ? :always : :never)) do |session|
         session.exec!(command) do |channel, stream, data|
           output << data
           puts data if print_output
         end
       end
-
       output.chop
-    rescue Net::SSH::ConnectionTimeout
-      retry
     rescue Net::SSH::Disconnect => e
       retry unless e.message =~ /Too many authentication failures/
-    rescue Errno::ECONNREFUSED
+    rescue Net::SSH::ConnectionTimeout, Errno::ECONNREFUSED, Errno::ENETUNREACH, Errno::EHOSTUNREACH
       retry
+    rescue Net::SSH::HostKeyMismatch
+      puts
+      puts "Cannot continue: Unable to SSH into server with IP #{public_ip} because the existing fingerprint in the known_hosts file does not match that of the actual host key."
+      puts "This is due to a security check but can also happen when creating a new server that gets assigned the same IP address as another server you've owned in the past."
+      puts "If are sure no security is being violated here and you're just creating new servers, you can eiher remove the relevant lines from your known_hosts (see IPs from the cloud console) or disable host key verification by setting the option 'verify_host_key' to false in the configuration file for the cluster."
+      exit 1
     end
 
     def kubernetes_client

data/lib/hetzner/k3s/version.rb

@@ -1,5 +1,5 @@
 module Hetzner
   module K3s
-    VERSION = "0.2.0"
+    VERSION = "0.3.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hetzner-k3s
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Vito Botta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-08 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A CLI to create a Kubernetes cluster in Hetzner Cloud very quickly using
   k3s.
 email: