hetzner-k3s 0.6.1 → 0.6.2.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d68b2062d774dff1a7b6e3b0eefad65b1a964c24ee9e1a2f6437967cfc5c07af
-  data.tar.gz: 382dd4a5eddaa0cd15882fc683ac6b4e0222de77273510cae7665289e871df93
+  metadata.gz: a97992a61bdf146f57c09744881d926bde5c808b6a82bd330ff244c4e27e3f8e
+  data.tar.gz: b03fbb20e031b39169aab50875581eeebc9ccd038587687b0df603e6bde81d6e
 SHA512:
-  metadata.gz: 1d2f5c8b1795044bbad2404a20a2f5a9c2036f05a5e3dd3caa85a15f52d713267bd4072be616303401945b829c9f86b72eecfb2fe31a19e14a2f6269814a3199
-  data.tar.gz: 8b694f74768bd39e77c06be466475a87b7ba3ebb293a1166af9705c3202167633fe03dd84a17556fe96c2369d855048468f335a909f33a2ed2586b8bf9efe44d
+  metadata.gz: 8f9f1267f70b726032d950f77304525e23d8fbc64104786eb90d14f2f961f5e41305b73703489b73e0363b67b58031a2f28d60f50a6a93d2c40070fe8ec9ea09
+  data.tar.gz: 96bd346cdc5a14f7794d23d2e043612b70b1d329a883c25a6eef09e926cf549a37725b8878dfb85ee71a5cea870739da9f7d21d3a21fa2077ba2e78f7c99007a

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    hetzner-k3s (0.6.0.pre14)
+    hetzner-k3s (0.6.2.pre1)
       bcrypt_pbkdf
       childprocess
       ed25519
       httparty
-      net-ssh
+      net-ssh (= 6.0.2)
       sshkey
       thor
 
@@ -25,7 +25,7 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
-    net-ssh (7.0.1)
+    net-ssh (6.0.2)
     parallel (1.20.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)

data/README.md

@@ -1,6 +1,20 @@
 # Create production grade Kubernetes clusters in Hetzner Cloud in a couple of minutes or less
 
-This is a CLI tool - based on a Ruby gem - to quickly create and manage Kubernetes clusters in [Hetzner Cloud](https://www.hetzner.com/cloud) using the lightweight Kubernetes distribution [k3s](https://k3s.io/) from [Rancher](https://rancher.com/).
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/vitobotta/hetzner-k3s)
+![GitHub Release Date](https://img.shields.io/github/release-date/vitobotta/hetzner-k3s)
+![GitHub last commit](https://img.shields.io/github/last-commit/vitobotta/hetzner-k3s)
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/vitobotta/hetzner-k3s/Create%20Release)
+![GitHub issues](https://img.shields.io/github/issues-raw/vitobotta/hetzner-k3s)
+![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/vitobotta/hetzner-k3s)
+![GitHub](https://img.shields.io/github/license/vitobotta/hetzner-k3s)
+![GitHub Discussions](https://img.shields.io/github/discussions/vitobotta/hetzner-k3s)
+![GitHub top language](https://img.shields.io/github/languages/top/vitobotta/hetzner-k3s)
+
+![GitHub forks](https://img.shields.io/github/forks/vitobotta/hetzner-k3s?style=social)
+![GitHub Repo stars](https://img.shields.io/github/stars/vitobotta/hetzner-k3s?style=social)
+## What is this?
+
+This is a CLI tool to quickly create and manage Kubernetes clusters in [Hetzner Cloud](https://www.hetzner.com/cloud) using the lightweight Kubernetes distribution [k3s](https://k3s.io/) from [Rancher](https://rancher.com/).
 
 Hetzner Cloud is an awesome cloud provider which offers a truly great service with the best performance/cost ratio in the market. With Hetzner's Cloud Controller Manager and CSI driver you can provision load balancers and persistent volumes very easily.
 
@@ -8,7 +22,7 @@ k3s is my favorite Kubernetes distribution now because it uses much less memory
 
 Using this tool, creating a highly available k3s cluster with 3 masters for the control plane and 3 worker nodes takes about **a couple of minutes** only. This includes
 
-- creating the infra resources (servers, private network, firewall, load balancer for the API server for HA clusters)
+- creating the infrastructure resources (servers, private network, firewall, load balancer for the API server for HA clusters)
 - deploying k3s to the nodes
 - installing the [Hetzner Cloud Controller Manager](https://github.com/hetznercloud/hcloud-cloud-controller-manager) to provision load balancers right away
 - installing the [Hetzner CSI Driver](https://github.com/hetznercloud/csi-driver) to provision persistent volumes using Hetzner's block storage
@@ -18,19 +32,36 @@ See roadmap [here](https://github.com/vitobotta/hetzner-k3s/projects/1) for the
 
 Also see this [wiki page](https://github.com/vitobotta/hetzner-k3s/wiki/Tutorial:---Setting-up-a-cluster) for a tutorial on how to set up a cluster with the most common setup to get you started.
 
-## Requirements
+___
+## Who am I?
+
+I'm a Senior Backend Engineer and DevOps based in Finland and working for event management platform [Brella](https://www.brella.io/).
+
+I also write a [technical blog](https://vitobotta.com/) on programming, DevOps and related technologies.
+
+___
+## Prerequisites
 
 All that is needed to use this tool is
 
 - an Hetzner Cloud account
-- an Hetzner Cloud token: for this you need to create a project from the cloud console, and then an API token with **both read and write permissions** (sidebar > Security > API Tokens); you will see the token only once, so ensure you take note of it somewhere safe
-- a recent Ruby runtime installed (see [this page](https://www.ruby-lang.org/en/documentation/installation/) for instructions if you are not familiar with Ruby). I am also going to try and create single binaries for this tool that will include the Ruby runtime, for easier installation.
+- an Hetzner Cloud token: for this you need to create a project from the cloud console, and then an API token with **both read and write permissions** (sidebar > Security > API Tokens); you will see the token only once, so be sure to take note of it somewhere safe
+- a recent Ruby runtime installed if you install the tool as Ruby gem (see [this page](https://www.ruby-lang.org/en/documentation/installation/) for instructions if you are not familiar with Ruby). I recommend you use the standalone binaries either downloaded directly or installed with Homebrew though, since it's easier and you don't have to set up Ruby.
+
+___
+## Getting Started - Installation
 
-## Installation
+Before using the tool, be sure to have kubectl installed as it's required to install some software in the cluster to provision load balancers/persistent volumes and perform k3s upgrades.
 
-Before using the tool, be sure to have installed kubectl as it's required to install some software in the cluster to provision load balancers/persistent volumes and perform k3s upgrades.
+### macOS
+
+#### With Homebrew
+
+```bash
+brew install vitobotta/tap/hetzner-k3s
+```
 
-### macOS (Intel)
+#### Binary installation (Intel)
 
 ```bash
 wget https://github.com/vitobotta/hetzner-k3s/releases/download/v0.6.1/hetzner-k3s-mac-amd64
@@ -38,7 +69,7 @@ chmod +x hetzner-k3s-mac-x64
 sudo mv hetzner-k3s-mac-x64 /usr/local/bin/hetzner-k3s
 ```
 
-### macOS (Apple Silicon/M1/ARM)
+#### Binary installation (Apple Silicon/M1)
 
 ```bash
 wget https://github.com/vitobotta/hetzner-k3s/releases/download/v0.6.1/hetzner-k3s-mac-arm64
@@ -52,11 +83,13 @@ NOTE: currently the ARM version still requires [Rosetta](https://support.apple.c
 
 ```bash
 wget https://github.com/vitobotta/hetzner-k3s/releases/download/v0.6.1/hetzner-k3s-linux-x86_64
-chmod +x hetzner-k3s-linux-x64
-sudo mv hetzner-k3s-linux-x64 /usr/local/bin/hetzner-k3s
+chmod +x hetzner-k3s-linux-x86_64
+sudo mv hetzner-k3s-linux-x86_64 /usr/local/bin/hetzner-k3s
 ```
 
-### As Ruby gem executable
+### macOS, Linux, Windows
+
+#### As Ruby gem executable
 
 Once you have the Ruby runtime up and running (2.7.1 required), you just need to install the gem:
 
@@ -66,7 +99,7 @@ gem install hetzner-k3s
 
 This will install the `hetzner-k3s` executable in your PATH.
 
-### With Docker
+#### With Docker
 
 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):
 
@@ -81,6 +114,8 @@ docker run --rm -it \
 
 Replace `test.yaml` with the name of your config file.
 
+___
+
 ## Creating a cluster
 
 The tool requires a simple configuration file in order to create/upgrade/delete clusters, in the YAML format like in the example below:
@@ -137,10 +172,9 @@ enable_encryption: true
 # - arg1
 # - ...
 # existing_network: <specify if you want to use an existing network, otherwise one will be created for this cluster>
-
 ```
 
-It should hopefully be self explanatory; you can run `hetzner-k3s releases` to see a list of the available releases from the most recent to the oldest available.
+It should hopefully be self explanatory; you can run `hetzner-k3s releases` to see a list of the available k3s releases.
 
 If you are using Docker, then set `kubeconfig_path` to `/cluster/kubeconfig` so that the kubeconfig is created in the same directory where your config file is. Also set the config file path to `/cluster/<filename>`.
 
@@ -149,7 +183,6 @@ If you don't want to specify the Hetzner token in the config file (for example i
 **Important**: The tool assignes the label `cluster` to each server it creates, with the cluster name you specify in the config file, as the value. So please ensure you don't create unrelated servers in the same project having
 the label `cluster=<cluster name>`, because otherwise they will be deleted if you delete the cluster. I recommend you create a separate Hetzner project for each cluster, see note at the end of this README for more details.
 
-
 If you set `masters.instance_count` to 1 then the tool will create a non highly available control plane; for production clusters you may want to set it to a number greater than 1. This number must be odd to avoid split brain issues with etcd and the recommended number is 3.
 
 You can specify any number of worker node pools for example to have mixed nodes with different specs for different workloads.
@@ -188,7 +221,7 @@ Finally, to create the cluster run:
 hetzner-k3s create-cluster --config-file cluster_config.yaml
 ```
 
-This will take a couple of minutes or less depending on the number of masters and worker nodes.
+This will take a few minutes depending on the number of masters and worker nodes.
 
 If you are creating an HA cluster and see the following in the output you can safely ignore it - it happens when additional masters are joining the first one:
 
@@ -229,6 +262,7 @@ In a future relese I will add some automation for the cleanup.
 
 It's easy to convert a non-HA with a single master cluster to HA with multiple masters. Just change the masters instance count and re-run the create command. This will create a load balancer for the API server and update the kubeconfig so that all the API requests go through the load balancer.
 
+___
 ## Upgrading to a new version of k3s
 
 If it's the first time you upgrade the cluster, all you need to do to upgrade it to a newer version of k3s is run the following command:
@@ -277,7 +311,7 @@ A final note about upgrades is that if for some reason the upgrade gets stuck af
 ```bash
 kubectl label node <master1> <master2> <master2> plan.upgrade.cattle.io/k3s-server=upgraded
 ```
-
+___
 ## Upgrading the OS on nodes
 
 - consider adding a temporary node during the process if you don't have enough spare capacity in the cluster
@@ -287,6 +321,7 @@ kubectl label node <master1> <master2> <master2> plan.upgrade.cattle.io/k3s-serv
 - uncordon
 - proceed with the next node
 
+___
 ## Deleting a cluster
 
 To delete a cluster, running
@@ -297,7 +332,11 @@ hetzner-k3s delete-cluster --config-file cluster_config.yaml
 
 This will delete all the resources in the Hetzner Cloud project for the cluster being deleted.
 
+## Troubleshooting
+
+See [this page](https://github.com/vitobotta/hetzner-k3s/wiki/Troubleshooting) for solutions to common issues.
 
+___
 ## Additional info
 
 ### Load balancers
@@ -323,16 +362,15 @@ The annotation `load-balancer.hetzner.cloud/use-private-ip: "true"` ensures that
 
 The other annotations should be self explanatory. You can find a list of the available annotations [here](https://pkg.go.dev/github.com/hetznercloud/hcloud-cloud-controller-manager/internal/annotation).
 
-## Persistent volumes
+### Persistent volumes
 
 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.
 
-
-## Keeping a project per cluster
+### Keeping a project per cluster
 
 I recommend that you create a separate Hetzner project for each cluster, because otherwise multiple clusters will attempt to create overlapping routes. I will make the pod cidr configurable in the future to avoid this, but I still recommend keeping clusters separated from each other. This way, if you want to delete a cluster with all the resources created for it, you can just delete the project.
 
-
+___
 ## 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.
@@ -341,10 +379,12 @@ Contributors:
 
 - [TitanFighter](https://github.com/TitanFighter) for [this awesome tutorial](https://github.com/vitobotta/hetzner-k3s/wiki/Tutorial:---Setting-up-a-cluster)
 
+___
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+___
 ## 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/hetzner-k3s/blob/main/CODE_OF_CONDUCT.md).

data/cluster_config.yaml.example

@@ -7,6 +7,8 @@ public_ssh_key_path: "~/.ssh/id_rsa.pub"
 private_ssh_key_path: "~/.ssh/id_rsa"
 ssh_allowed_networks:
   - 0.0.0.0/0
+api_allowed_networks:
+  - 0.0.0.0/0
 verify_host_key: false
 location: nbg1
 schedule_workloads_on_masters: false
@@ -20,3 +22,30 @@ worker_node_pools:
 - name: big
   instance_type: cpx31
   instance_count: 2
+additional_packages:
+- somepackage
+post_create_commands:
+- apt update
+- apt upgrade -y
+- apt autoremove -y
+- shutdown -r now
+enable_encryption: true
+# kube_api_server_args:
+# - arg1
+# - ...
+# kube_scheduler_args:
+# - arg1
+# - ...
+# kube_controller_manager_args:
+# - arg1
+# - ...
+# kube_cloud_controller_manager_args:
+# - arg1
+# - ...
+# kubelet_args:
+# - arg1
+# - ...
+# kube_proxy_args:
+# - arg1
+# - ...
+# existing_network: <specify if you want to use an existing network, otherwise one will be created for this cluster>

data/hetzner-k3s.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'childprocess'
   spec.add_dependency 'ed25519'
   spec.add_dependency 'httparty'
-  spec.add_dependency 'net-ssh'
+  spec.add_dependency 'net-ssh', '= 6.0.2'
   spec.add_dependency 'sshkey'
   spec.add_dependency 'thor'
   spec.add_development_dependency 'rubocop'

data/lib/hetzner/k3s/version.rb

@@ -2,6 +2,6 @@
 
 module Hetzner
   module K3s
-    VERSION = '0.6.1'
+    VERSION = '0.6.2.pre1'
   end
 end

data/lib/hetzner/utils.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-Net::SSH::Transport::Algorithms::ALGORITHMS.values.each { |algs| algs.reject! { |a| a =~ /^ecd(sa|h)-sha2/ } }
-Net::SSH::KnownHosts::SUPPORTED_TYPE.reject! { |t| t =~ /^ecd(sa|h)-sha2/ }
-
 require 'childprocess'
 
 module Utils
@@ -92,9 +89,6 @@ module Utils
   #   p [e.class, e.message]
   #   retries += 1
   #   retry unless retries > 15 || e.message =~ /Bad file descriptor/
-  rescue Timeout::Error, IOError, Errno::EBADF
-    retries += 1
-    retry unless retries > 15
   rescue Net::SSH::Disconnect => e
     retries += 1
     retry unless retries > 15 || e.message =~ /Too many authentication failures/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hetzner-k3s
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2.pre1
 platform: ruby
 authors:
 - Vito Botta
@@ -70,16 +70,16 @@ dependencies:
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.2
 - !ruby/object:Gem::Dependency
   name: sshkey
   requirement: !ruby/object:Gem::Requirement
@@ -177,9 +177,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: