hetzner-k3s 0.4.7 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e4c46ae74be52152443a9fab3b7b7dd00fa5e7cae5dffb99457b522646103ba
-  data.tar.gz: e2495e717211c2351c2e203bd2741d3079e84729c305e8c6ad7434c24cf3d989
+  metadata.gz: c236d440e3e99f656c62b8ced99ac899199e435ca41e9675c4adeb326a87c5d8
+  data.tar.gz: fd8da58d3c4cc3b54018c1ff261f8606391e8f524b974660fc5984fcd10397f7
 SHA512:
-  metadata.gz: c82cd916cdde9cec408d0681dc7d46902309bd1246424c8267ed2164345aef54e8e6eca8730c668b146245129450e1daabe97a698e2aca165e7f2a63cb9e5b0d
-  data.tar.gz: 857abb763f92c64a65eeb2d484528708060db50aa121d7ccad847a5f6cbc2fec3c8d9a3873e8568ba2f03ea76ab53b529bc50267271d235b369d69e67d6c4f5a
+  metadata.gz: 8ebe7779e0f79ec500c1e0d230212cd568ef62e94a3dd2d936214f03f48baf8fc937a683b7bf4478b66a3dc0a7b02ee001a6fe3e542ad401f0add4ee27a68b03
+  data.tar.gz: dae117d8d1e3babf392814baf372009d1558113673a4968b7526a0a4e3a06b8eea034edaa11452047286721efc2a37af3e8214f2dbeafde73d864493feae5626

data/.rubocop.yml

@@ -0,0 +1,121 @@
+Gemspec/DateAssignment: # new in 1.10
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/ParameterLists:
+  Max: 10
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - exe/hetzner-k3s

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/Dockerfile

@@ -1,7 +1,10 @@
-FROM ruby:2.7.4-alpine
+FROM ruby:3.1.0-alpine
 
 RUN apk update --no-cache \
-  && apk add build-base git openssh-client
+  && apk add build-base git openssh-client curl bash
+
+RUN curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" \
+  && install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
 
 COPY . .
 

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in k3s.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    hetzner-k3s (0.4.5)
+    hetzner-k3s (0.5.0)
       bcrypt_pbkdf
       ed25519
       http
-      k8s-ruby
       net-ssh
       sshkey
+      subprocess
       thor
 
 GEM
@@ -15,44 +15,16 @@ GEM
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     bcrypt_pbkdf (1.1.0)
-    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    dry-configurable (0.13.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.6)
-    dry-container (0.9.0)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.13, >= 0.13.0)
-    dry-core (0.7.1)
-      concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    dry-inflector (0.2.1)
-    dry-logic (0.6.1)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-struct (0.5.1)
-      dry-core (~> 0.4, >= 0.4.3)
-      dry-equalizer (~> 0.2)
-      dry-types (~> 0.13)
-      ice_nine (~> 0.11)
-    dry-types (0.13.4)
-      concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      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)
+    ed25519 (1.3.0)
+    ffi (1.15.5)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    hashdiff (1.0.1)
     http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
@@ -63,24 +35,15 @@ GEM
     http-form_data (2.3.0)
     http-parser (1.2.3)
       ffi-compiler (>= 1.0, < 2.0)
-    ice_nine (0.11.2)
-    jsonpath (0.9.9)
-      multi_json
-      to_regexp (~> 0.2.1)
-    k8s-ruby (0.10.5)
-      dry-struct (~> 0.5.0)
-      dry-types (~> 0.13.0)
-      excon (~> 0.71)
-      hashdiff (~> 1.0.0)
-      jsonpath (~> 0.9.5)
-      recursive-open-struct (~> 1.1.0)
-      yajl-ruby (~> 1.4.0)
-      yaml-safe_load_stream (~> 0.1)
-    multi_json (1.15.0)
     net-ssh (6.1.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
     public_suffix (4.0.6)
+    rainbow (3.1.1)
     rake (12.3.3)
-    recursive-open-struct (1.1.3)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -94,14 +57,25 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
     sshkey (2.0.0)
-    thor (1.1.0)
-    to_regexp (0.2.1)
+    subprocess (1.5.5)
+    thor (1.2.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8)
-    yajl-ruby (1.4.1)
-    yaml-safe_load_stream (0.1.1)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -110,6 +84,7 @@ DEPENDENCIES
   hetzner-k3s!
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
 
 BUNDLED WITH
-   2.1.4
+   2.3.4

data/README.md

@@ -25,7 +25,7 @@ All that is needed to use this tool is
 
 ## Installation
 
-Once you have the Ruby runtime up and running (2.7.2 or newer in the 2.7 series is recommended at this stage), you just need to install the gem:
+Once you have the Ruby runtime up and running (2.7.2 or newer), you just need to install the gem:
 
 ```bash
 gem install hetzner-k3s
@@ -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.7 create-cluster --config-file /cluster/test.yaml
+docker run --rm -it -v ${PWD}:/cluster -v ${HOME}/.ssh:/tmp/.ssh vitobotta/hetzner-k3s:v0.5.1 create-cluster --config-file /cluster/test.yaml
 ```
 
 Replace `test.yaml` with the name of your config file.
@@ -70,11 +70,14 @@ worker_node_pools:
 - name: big
   instance_type: cpx31
   instance_count: 2
+additional_packages:
+- somepackage
+enable_ipsec_encryption: true
 ```
 
 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.
 
-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.
+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>`.
 
 If you don't want to specify the Hetzner token in the config file (for example if you want to use the tool with CI), then you can use the `HCLOUD_TOKEN` environment variable instead, which has predecence.
 
@@ -108,7 +111,7 @@ curl \
 	'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. 
+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.
 
@@ -211,7 +214,7 @@ kubectl label node <master1> <master2> <master2> plan.upgrade.cattle.io/k3s-serv
 To delete a cluster, running
 
 ```bash
-hetzner-k3s delete-cluster --config-file cluster_config.yam
+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.
@@ -254,6 +257,24 @@ I recommend that you create a separate Hetzner project for each cluster, because
 
 ## changelog
 
+- 0.5.1
+  - Each node pool gets its own placement group. This is to minimize issues due to the max 10 nodes limitation for a single node group. A validation has also been added to limit pools to 10 nodes each because of this.
+
+- 0.5.0
+  - Allow installing additional packages when creating the servers
+  - Allow enabling ipsec encryption
+
+- 0.4.9
+  - Ensure the program always exits with exit code 1 if the config file fails validation
+  - Upgrade System Upgrade Controller to 0.8.1
+  - Remove dependency on unmaintained gem k8s-ruby
+  - Make the gem compatible with Ruby 3.1.0
+
+- 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
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/build.sh

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

data/bin/{console → console.sh}

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "k3s"
+require 'bundler/setup'
+require 'k3s'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "k3s"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

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/hetzner-k3s.gemspec

@@ -1,37 +1,41 @@
+# frozen_string_literal: true
+
 require_relative 'lib/hetzner/k3s/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "hetzner-k3s"
+  spec.name          = 'hetzner-k3s'
   spec.version       = Hetzner::K3s::VERSION
-  spec.authors       = ["Vito Botta"]
-  spec.email         = ["vito@botta.me"]
+  spec.authors       = ['Vito Botta']
+  spec.email         = ['vito@botta.me']
 
-  spec.summary       = %q{A CLI to create a Kubernetes cluster in Hetzner Cloud very quickly using k3s.}
-  spec.description   = %q{A CLI to create a Kubernetes cluster in Hetzner Cloud very quickly using k3s.}
-  spec.homepage      = "https://github.com/vitobotta/hetzner-k3s"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'A CLI to create a Kubernetes cluster in Hetzner Cloud very quickly using k3s.'
+  spec.description   = 'A CLI to create a Kubernetes cluster in Hetzner Cloud very quickly using k3s.'
+  spec.homepage      = 'https://github.com/vitobotta/hetzner-k3s'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.1.0')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/vitobotta/hetzner-k3s"
-  spec.metadata["changelog_uri"] = "https://github.com/vitobotta/hetzner-k3s"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/vitobotta/hetzner-k3s'
+  spec.metadata['changelog_uri'] = 'https://github.com/vitobotta/hetzner-k3s'
 
-  spec.add_dependency "thor"
-  spec.add_dependency "http"
-  spec.add_dependency "net-ssh"
-  spec.add_dependency "k8s-ruby"
-  spec.add_dependency "sshkey"
-  spec.add_dependency "ed25519"
-  spec.add_dependency "bcrypt_pbkdf"
+  spec.add_dependency 'bcrypt_pbkdf'
+  spec.add_dependency 'ed25519'
+  spec.add_dependency 'http'
+  spec.add_dependency 'net-ssh'
+  spec.add_dependency 'sshkey'
+  spec.add_dependency 'subprocess'
+  spec.add_dependency 'thor'
+  spec.add_development_dependency 'rubocop'
 
   # 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.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/hetzner/infra/client.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Hetzner
   class Client
-    BASE_URI = "https://api.hetzner.cloud/v1"
+    BASE_URI = 'https://api.hetzner.cloud/v1'
 
     attr_reader :token
 
@@ -22,25 +24,27 @@ module Hetzner
 
     def delete(path, id)
       make_request do
-        HTTP.headers(headers).delete(BASE_URI + path + "/" + id.to_s)
+        HTTP.headers(headers).delete("#{BASE_URI}#{path}/#{id}")
       end
     end
 
     private
 
-      def headers
-        {
-          "Authorization": "Bearer #{@token}",
-          "Content-Type": "application/json"
-        }
-      end
+    def headers
+      {
+        Authorization: "Bearer #{@token}",
+        'Content-Type': 'application/json'
+      }
+    end
 
-      def make_request &block
-        Timeout::timeout(5) do
-          block.call
-        end
-      rescue Timeout::Error
-        retry
+    def make_request(&block)
+      retries ||= 0
+
+      Timeout.timeout(30) do
+        block.call
       end
+    rescue Timeout::Error
+      retry if (retries += 1) < 3
+    end
   end
 end