From 014793df825edc123cceb6f6585b1074b4c6c373 Mon Sep 17 00:00:00 2001 From: Mikael Johansson Date: Fri, 20 Sep 2024 12:49:44 +0200 Subject: [PATCH] Update docs --- README.md | 82 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 49 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index cf38354..d3ce262 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ 1. `git clone https://github.com/mikejoh/rke2diff.git` 2. `cd rke2diff` -3. `make build` -4. `make install` (assumes that `~/.local/bin` is used) +3. `make build` (places the compiled binary in `./build/` +4. `make install` (copies the compiled binary to `~/.local/bin`) ### Download and run @@ -31,37 +31,53 @@ tar xzvf rke2diff_0.1.3_linux_amd64.tar.gz ## Usage -Example: ``` -rke2diff -rke2 v1.28.9+rke2r1 -rke2 v1.29.5+rke2r1 +rke2diff -h +Usage of ./build/rke2diff: + -per-page int + Skip release candidate releases. (default 100) + -pick + Interactive release picker. + -releases + Show all releases. + -rke2 value + RKE2 version to compare, can be set multiple times. + -skip-rc + Skip release candidate releases. (default true) + -version + Print the version number. +``` -┌──────────────────────────────────┬─────────────────────────────┬─────────────────────────────┐ -│ NAME │ V1.28.9+RKE2R1 (2024-04-29) │ V1.29.5+RKE2R1 (2024-05-22) │ -├──────────────────────────────────┼─────────────────────────────┼─────────────────────────────┤ -│ Containerd │ v1.7.11-k3s2 │ v1.7.11-k3s2 │ -│ CoreDNS │ v1.11.1 │ v1.11.1 │ -│ Etcd │ v3.5.9-k3s1 │ v3.5.9-k3s1 │ -│ Helm-controller │ v0.15.9 │ v0.15.9 │ -│ Ingress-Nginx │ nginx-1.9.6-hardened1 ❌ │ nginx-1.9.6-hardened1 ❌ │ -│ Kubernetes │ v1.28.9 │ v1.29.5 🚀 │ -│ Metrics-server │ v0.7.1 │ v0.7.1 │ -│ Runc │ v1.1.12 │ v1.1. ❌ │ -│ harvester-cloud-provider │ 0.2.300 │ 0.2.300 │ -│ harvester-csi-driver │ 0.1.1700 │ 0.1.1700 │ -│ rancher-vsphere-cpi │ 1.7.001 │ 1.7.001 │ -│ rancher-vsphere-csi │ 3.1.2-rancher400 │ 3.1.2-rancher400 │ -│ rke2-calico │ v3.27.300 │ v3.27.300 │ -│ rke2-calico-crd │ v3.27.002 │ v3.27.002 │ -│ rke2-canal │ v3.27.3-build2024042301 │ v3.27.3-build2024042301 │ -│ rke2-cilium │ 1.15.400 │ 1.15.500 🚀 │ -│ rke2-coredns │ 1.29.002 │ 1.29.002 │ -│ rke2-ingress-nginx │ 4.9.100 │ 4.9.100 │ -│ rke2-metrics-server │ 3.12.002 │ 3.12.002 │ -│ rke2-snapshot-controller │ 1.7.202 │ 1.7.202 │ -│ rke2-snapshot-controller-crd │ 1.7.202 │ 1.7.202 │ -│ rke2-snapshot-validation-webhook │ 1.7.302 │ 1.7.302 │ -├──────────────────────────────────┼─────────────────────────────┼─────────────────────────────┤ -│ ❌ = VERSION STRING INVALID │ │ │ -│ 🚀 = BUMPED │ │ │ -└──────────────────────────────────┴─────────────────────────────┴─────────────────────────────┘ +Compare to version of RKE2: +``` +rke2diff -rke2 v1.28.11+rke2r1 -rke2 v1.31.0+rke2r1 +┌──────────────────────────────────┬──────────────────────────────┬─────────────────────────────┐ +│ NAME │ V1.28.11+RKE2R1 (2024-07-01) │ V1.31.0+RKE2R1 (2024-09-04) │ +├──────────────────────────────────┼──────────────────────────────┼─────────────────────────────┤ +│ containerd │ v1.7.17-k3s1 │ v1.7.20-k3s1 🚀 │ +│ coredns │ v1.11.1 │ v1.11.1 │ +│ etcd │ v3.5.13-k3s1 │ v3.5.13-k3s1 │ +│ helm-controller │ v0.15.10 │ v0.16.3 🚀 │ +│ ingress-nginx │ v1.10.1-hardened1 │ v1.10.4-hardened2 🚀 │ +│ kubernetes │ v1.28.11 │ v1.31.0 🚀 │ +│ metrics-server │ v0.7.1 │ v0.7.1 │ +│ runc │ v1.1.12 │ v1.1.13 🚀 │ +│ harvester-cloud-provider │ 0.2.400 │ 0.2.600 🚀 │ +│ harvester-csi-driver │ 0.1.1700 │ 0.1.1800 🚀 │ +│ rancher-vsphere-cpi │ 1.7.001 │ 1.9.000 🚀 │ +│ rancher-vsphere-csi │ 3.1.2-rancher400 │ 3.3.1-rancher100 🚀 │ +│ rke2-calico │ v3.27.300 │ v3.28.100 🚀 │ +│ rke2-calico-crd │ v3.27.002 │ v3.28.100 🚀 │ +│ rke2-canal │ v3.28.0-build2024062503 │ v3.28.1-build2024082701 🚀 │ +│ rke2-cilium │ 1.15.500 │ 1.16.101 🚀 │ +│ rke2-coredns │ 1.29.002 │ 1.29.004 🚀 │ +│ rke2-ingress-nginx │ 4.10.101 │ 4.10.401 🚀 │ +│ rke2-metrics-server │ 3.12.002 │ 3.12.002 │ +│ rke2-snapshot-controller │ 1.7.202 │ 1.7.202 │ +│ rke2-snapshot-controller-crd │ 1.7.202 │ 1.7.202 │ +│ rke2-snapshot-validation-webhook │ 1.7.302 │ 1.7.302 │ +├──────────────────────────────────┼──────────────────────────────┼─────────────────────────────┤ +│ ❌ = VERSION STRING INVALID │ │ │ +│ 🚀 = BUMPED │ │ │ +└──────────────────────────────────┴──────────────────────────────┴─────────────────────────────┘ ```