hetzner-k3s 0.4.4 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 153385c9fce84159b90d6b77bed3e3afebd3cb0739fbd6de1e4cc91e5f1e130f
-  data.tar.gz: '08a51842b854c2a438012c6fde115520e32fb782524a3ddd4048a772db8aeaa3'
+  metadata.gz: 894c97e8725c519b223e42c190f0432bcf1808c50f6f5c636bc4db06a41ed4e2
+  data.tar.gz: efd986dd375e93b6ed9f84e1b1bc2742f4d7146f7db76987eb0a02df29b544ee
 SHA512:
-  metadata.gz: 9d6ac1e71d783a6b01d77863e30fae972c0983cda9e85dfcaac5fda8da0ea7a33565404aaa8efdd0594185f31c85ebc91cf92cdfe06fd9b92422aaf8c158feee
-  data.tar.gz: 4f93a9eb6635d2c757dfbc1205023e563bfbb564ca0b0f9b839ea4b722f9fc2d7db7978ce4ab7da70d2ce23fd3559a301342f3b222522ac4df0554a9f66317bd
+  metadata.gz: df042a8f3da37960b0058f2c3d88a6bfafe0b1e7c4f49eeedfe840b08dcc23c7b922e1ccca893f81caf35084770fbdad261be2d2ce50ac5aebe7c0fae88cfa82
+  data.tar.gz: 877feedfbe211d1b2c75ce532fa6299888e570c1425cc6168cb882e8064dff9ec1d42d572c8f80f958d21acf48e7d828466f515d540c4239d9ae12b02751f505

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hetzner-k3s (0.4.3)
+    hetzner-k3s (0.4.7)
       bcrypt_pbkdf
       ed25519
       http
@@ -20,12 +20,12 @@ GEM
     diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    dry-configurable (0.12.1)
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
-    dry-container (0.8.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-configurable (~> 0.13, >= 0.13.0)
     dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
@@ -47,8 +47,8 @@ GEM
       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)
+    excon (0.88.0)
+    ffi (1.15.4)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -99,7 +99,7 @@ GEM
     to_regexp (0.2.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.7)
+    unf_ext (0.0.8)
     yajl-ruby (1.4.1)
     yaml-safe_load_stream (0.1.1)
 

data/README.md

@@ -38,7 +38,7 @@ This will install the `hetzner-k3s` executable in your PATH.
 Alternatively, if you don't want to set up a Ruby runtime but have Docker installed, you can use a container. Run the following from inside the directory where you have the config file for the cluster (described in the next section):
 
 ```bash
-docker run --rm -it -v ${PWD}:/cluster -v ${HOME}/.ssh:/tmp/.ssh vitobotta/hetzner-k3s:v0.4.4 create-cluster --config-file /cluster/test.yaml
+docker run --rm -it -v ${PWD}:/cluster -v ${HOME}/.ssh:/tmp/.ssh vitobotta/hetzner-k3s:v0.4.7 create-cluster --config-file /cluster/test.yaml
 ```
 
 Replace `test.yaml` with the name of your config file.
@@ -97,8 +97,20 @@ curl \
 	'https://api.hetzner.cloud/v1/server_types'
 ```
 
+By default, the image in use is Ubuntu 20.04, but you can specify an image to use with the `image` config option. This makes it also possible
+to use a snapshot that you have already created from and existing server (for example to preinstall some tools). If you want to use a custom
+snapshot you'll need to specify the **ID** of the snapshot/image, not the description you gave when you created the template server. To find
+the ID of your custom image/snapshot, run:
 
-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.
+```bash
+curl \
+	-H "Authorization: Bearer $API_TOKEN" \
+	'https://api.hetzner.cloud/v1/images'
+```
+
+Note that if you use a custom image, the creation of the servers may take longer than when using the default image. 
+
+Also 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:
 
@@ -242,6 +254,20 @@ I recommend that you create a separate Hetzner project for each cluster, because
 
 ## changelog
 
+- 0.4.8
+  - Increase timeout with API requests to 30 seconds
+  - Limit number of retries for API requests to 3
+  - Ensure all version tags are listed for k3s (thanks @janosmiko)
+
+- 0.4.7
+  - Made it possible to specify a custom image/snapshot for the servers
+
+- 0.4.6
+  - Added a check to abort gracefully when for some reason one or more servers are not created, for example due to temporary problems with the Hetzner API.
+
+- 0.4.5
+  - Fix network creation (bug introduced in the previous version)
+
 - 0.4.4
   - Add support for the new Ashburn, Virginia (USA) location
   - Automatically use a placement group so that the instances are all created on different physical hosts for high availability

data/bin/build.sh

@@ -6,9 +6,9 @@ set -e
 
 IMAGE="vitobotta/hetzner-k3s"
 
-docker build -t ${IMAGE}:v0.4.4 \
+docker build -t ${IMAGE}:v0.4.8 \
   --platform=linux/amd64 \
-  --cache-from ${IMAGE}:v0.4.3 \
+  --cache-from ${IMAGE}:v0.4.7 \
   --build-arg BUILDKIT_INLINE_CACHE=1 .
 
-docker push vitobotta/hetzner-k3s:v0.4.4
+docker push vitobotta/hetzner-k3s:v0.4.8

data/cluster_config.yaml.example

@@ -1,11 +1,15 @@
 ---
-hetzner_token: blah
+hetzner_token: <your token>
 cluster_name: test
-kubeconfig_path: "../kubeconfig"
+kubeconfig_path: "./kubeconfig"
 k3s_version: v1.21.3+k3s1
-ssh_key_path: "~/.ssh/id_rsa.pub"
+public_ssh_key_path: "~/.ssh/id_rsa.pub"
+private_ssh_key_path: "~/.ssh/id_rsa"
+ssh_allowed_networks:
+  - 0.0.0.0/0
 verify_host_key: false
 location: nbg1
+schedule_workloads_on_masters: false
 masters:
   instance_type: cpx21
   instance_count: 3
@@ -14,5 +18,5 @@ worker_node_pools:
   instance_type: cpx21
   instance_count: 4
 - name: big
-  instance_type: cp321
+  instance_type: cpx31
   instance_count: 2

data/lib/hetzner/infra/client.rb

@@ -36,11 +36,13 @@ module Hetzner
       end
 
       def make_request &block
-        Timeout::timeout(5) do
+        retries ||= 0
+
+        Timeout::timeout(30) do
           block.call
         end
       rescue Timeout::Error
-        retry
+        retry if (retries += 1) < 3
       end
   end
 end

data/lib/hetzner/infra/network.rb

@@ -48,7 +48,7 @@ module Hetzner
           subnets: [
             {
               ip_range: "10.0.0.0/16",
-              network_zone: (location ? "us-east" : "eu-central"),
+              network_zone: (location == "ash" ? "us-east" : "eu-central"),
               type: "cloud"
             }
           ]

data/lib/hetzner/infra/server.rb

@@ -5,7 +5,7 @@ module Hetzner
       @cluster_name = cluster_name
     end
 
-    def create(location:, instance_type:, instance_id:, firewall_id:, network_id:, ssh_key_id:, placement_group_id:)
+    def create(location:, instance_type:, instance_id:, firewall_id:, network_id:, ssh_key_id:, placement_group_id:, image:)
       puts
 
       server_name = "#{cluster_name}-#{instance_type}-#{instance_id}"
@@ -21,7 +21,7 @@ module Hetzner
       server_config = {
         name: server_name,
         location: location,
-        image: "ubuntu-20.04",
+        image: image,
         firewalls: [
           { firewall: firewall_id }
         ],
@@ -40,12 +40,22 @@ module Hetzner
         placement_group: placement_group_id
       }
 
-      response = hetzner_client.post("/servers", server_config).body
+      response = hetzner_client.post("/servers", server_config)
+      response_body = response.body
+
+      server = JSON.parse(response_body)["server"]
+
+      unless server
+        puts "Error creating server #{server_name}. Response details below:"
+        puts
+        p response
+        return
+      end
 
       puts "...server #{server_name} created."
       puts
 
-      JSON.parse(response)["server"]
+      server
     end
 
     def delete(server_name:)

data/lib/hetzner/k3s/cli.rb

@@ -198,7 +198,7 @@ module Hetzner
 
         def find_available_releases
           @available_releases ||= begin
-            response = HTTP.get("https://api.github.com/repos/k3s-io/k3s/tags").body
+            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

data/lib/hetzner/k3s/cluster.rb

@@ -120,7 +120,8 @@ class Cluster
           firewall_id: firewall_id,
           network_id: network_id,
           ssh_key_id: ssh_key_id,
-          placement_group_id: placement_group_id
+          placement_group_id: placement_group_id,
+          image: image
         }
       end
 
@@ -144,7 +145,8 @@ class Cluster
             firewall_id: firewall_id,
             network_id: network_id,
             ssh_key_id: ssh_key_id,
-            placement_group_id: placement_group_id
+            placement_group_id: placement_group_id,
+            image: image
           }
         end
       end
@@ -157,6 +159,10 @@ class Cluster
 
       threads.each(&:join) unless threads.empty?
 
+      while servers.size != server_configs.size
+        sleep 1
+      end
+
       puts
       threads = servers.map do |server|
         Thread.new { wait_for_ssh server }
@@ -230,28 +236,28 @@ class Cluster
       taint = schedule_workloads_on_masters? ? " " : " --node-taint CriticalAddonsOnly=true:NoExecute "
 
       <<~EOF
-      curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION="#{k3s_version}" K3S_TOKEN="#{k3s_token}" INSTALL_K3S_EXEC="server \
-        --disable-cloud-controller \
-        --disable servicelb \
-        --disable traefik \
-        --disable local-storage \
-        --disable metrics-server \
-        --write-kubeconfig-mode=644 \
-        --node-name="$(hostname -f)" \
-        --cluster-cidr=10.244.0.0/16 \
-        --etcd-expose-metrics=true \
-        --kube-controller-manager-arg="address=0.0.0.0" \
-        --kube-controller-manager-arg="bind-address=0.0.0.0" \
-        --kube-proxy-arg="metrics-bind-address=0.0.0.0" \
-        --kube-scheduler-arg="address=0.0.0.0" \
-        --kube-scheduler-arg="bind-address=0.0.0.0" \
-        #{taint} \
-        --kubelet-arg="cloud-provider=external" \
-        --advertise-address=$(hostname -I | awk '{print $2}') \
-        --node-ip=$(hostname -I | awk '{print $2}') \
-        --node-external-ip=$(hostname -I | awk '{print $1}') \
-        --flannel-iface=#{flannel_interface} \
-        #{server} #{tls_sans}" sh -
+        curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION="#{k3s_version}" K3S_TOKEN="#{k3s_token}" INSTALL_K3S_EXEC="server \
+          --disable-cloud-controller \
+          --disable servicelb \
+          --disable traefik \
+          --disable local-storage \
+          --disable metrics-server \
+          --write-kubeconfig-mode=644 \
+          --node-name="$(hostname -f)" \
+          --cluster-cidr=10.244.0.0/16 \
+          --etcd-expose-metrics=true \
+          --kube-controller-manager-arg="address=0.0.0.0" \
+          --kube-controller-manager-arg="bind-address=0.0.0.0" \
+          --kube-proxy-arg="metrics-bind-address=0.0.0.0" \
+          --kube-scheduler-arg="address=0.0.0.0" \
+          --kube-scheduler-arg="bind-address=0.0.0.0" \
+          #{taint} \
+          --kubelet-arg="cloud-provider=external" \
+          --advertise-address=$(hostname -I | awk '{print $2}') \
+          --node-ip=$(hostname -I | awk '{print $2}') \
+          --node-external-ip=$(hostname -I | awk '{print $1}') \
+          --flannel-iface=#{flannel_interface} \
+          #{server} #{tls_sans}" sh -
       EOF
     end
 
@@ -259,12 +265,12 @@ class Cluster
       flannel_interface = find_flannel_interface(worker)
 
       <<~EOF
-      curl -sfL https://get.k3s.io | K3S_TOKEN="#{k3s_token}" INSTALL_K3S_VERSION="#{k3s_version}" K3S_URL=https://#{first_master_private_ip}:6443 INSTALL_K3S_EXEC="agent \
-        --node-name="$(hostname -f)" \
-        --kubelet-arg="cloud-provider=external" \
-        --node-ip=$(hostname -I | awk '{print $2}') \
-        --node-external-ip=$(hostname -I | awk '{print $1}') \
-        --flannel-iface=#{flannel_interface}" sh -
+        curl -sfL https://get.k3s.io | K3S_TOKEN="#{k3s_token}" INSTALL_K3S_VERSION="#{k3s_version}" K3S_URL=https://#{first_master_private_ip}:6443 INSTALL_K3S_EXEC="agent \
+          --node-name="$(hostname -f)" \
+          --kubelet-arg="cloud-provider=external" \
+          --node-ip=$(hostname -I | awk '{print $2}') \
+          --node-external-ip=$(hostname -I | awk '{print $1}') \
+          --flannel-iface=#{flannel_interface}" sh -
       EOF
     end
 
@@ -651,4 +657,8 @@ class Cluster
       schedule_workloads_on_masters ? !!schedule_workloads_on_masters : false
     end
 
+    def image
+      configuration.dig("image") || "ubuntu-20.04"
+    end
+
 end

data/lib/hetzner/k3s/version.rb

@@ -1,5 +1,5 @@
 module Hetzner
   module K3s
-    VERSION = "0.4.4"
+    VERSION = "0.4.8"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hetzner-k3s
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.8
 platform: ruby
 authors:
 - Vito Botta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor