Skip to content

Commit c97fac6

Browse files
mikejohmikejoh
authored
Update docs (#11)
1 parent 6b399cc commit c97fac6

File tree

1 file changed

+49
-33
lines changed

1 file changed

+49
-33
lines changed

‎README.md

+49-33
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111

1212
1. `git clone https://github.com/mikejoh/rke2diff.git`
1313
2. `cd rke2diff`
14-
3. `make build`
15-
4. `make install` (assumes that `~/.local/bin` is used)
14+
3. `make build` (places the compiled binary in `./build/`
15+
4. `make install` (copies the compiled binary to `~/.local/bin`)
1616

1717
### Download and run
1818

@@ -31,37 +31,53 @@ tar xzvf rke2diff_0.1.3_linux_amd64.tar.gz
3131

3232
## Usage
3333

34-
Example:
3534
```
36-
rke2diff -rke2 v1.28.9+rke2r1 -rke2 v1.29.5+rke2r1
35+
rke2diff -h
36+
Usage of ./build/rke2diff:
37+
-per-page int
38+
Skip release candidate releases. (default 100)
39+
-pick
40+
Interactive release picker.
41+
-releases
42+
Show all releases.
43+
-rke2 value
44+
RKE2 version to compare, can be set multiple times.
45+
-skip-rc
46+
Skip release candidate releases. (default true)
47+
-version
48+
Print the version number.
49+
```
3750

38-
┌──────────────────────────────────┬─────────────────────────────┬─────────────────────────────┐
39-
│ NAME │ V1.28.9+RKE2R1 (2024-04-29) │ V1.29.5+RKE2R1 (2024-05-22) │
40-
├──────────────────────────────────┼─────────────────────────────┼─────────────────────────────┤
41-
│ Containerd │ v1.7.11-k3s2 │ v1.7.11-k3s2 │
42-
│ CoreDNS │ v1.11.1 │ v1.11.1 │
43-
│ Etcd │ v3.5.9-k3s1 │ v3.5.9-k3s1 │
44-
│ Helm-controller │ v0.15.9 │ v0.15.9 │
45-
│ Ingress-Nginx │ nginx-1.9.6-hardened1 ❌ │ nginx-1.9.6-hardened1 ❌ │
46-
│ Kubernetes │ v1.28.9 │ v1.29.5 🚀 │
47-
│ Metrics-server │ v0.7.1 │ v0.7.1 │
48-
│ Runc │ v1.1.12 │ v1.1. ❌ │
49-
│ harvester-cloud-provider │ 0.2.300 │ 0.2.300 │
50-
│ harvester-csi-driver │ 0.1.1700 │ 0.1.1700 │
51-
│ rancher-vsphere-cpi │ 1.7.001 │ 1.7.001 │
52-
│ rancher-vsphere-csi │ 3.1.2-rancher400 │ 3.1.2-rancher400 │
53-
│ rke2-calico │ v3.27.300 │ v3.27.300 │
54-
│ rke2-calico-crd │ v3.27.002 │ v3.27.002 │
55-
│ rke2-canal │ v3.27.3-build2024042301 │ v3.27.3-build2024042301 │
56-
│ rke2-cilium │ 1.15.400 │ 1.15.500 🚀 │
57-
│ rke2-coredns │ 1.29.002 │ 1.29.002 │
58-
│ rke2-ingress-nginx │ 4.9.100 │ 4.9.100 │
59-
│ rke2-metrics-server │ 3.12.002 │ 3.12.002 │
60-
│ rke2-snapshot-controller │ 1.7.202 │ 1.7.202 │
61-
│ rke2-snapshot-controller-crd │ 1.7.202 │ 1.7.202 │
62-
│ rke2-snapshot-validation-webhook │ 1.7.302 │ 1.7.302 │
63-
├──────────────────────────────────┼─────────────────────────────┼─────────────────────────────┤
64-
│ ❌ = VERSION STRING INVALID │ │ │
65-
│ 🚀 = BUMPED │ │ │
66-
└──────────────────────────────────┴─────────────────────────────┴─────────────────────────────┘
51+
Compare to version of RKE2:
52+
```
53+
rke2diff -rke2 v1.28.11+rke2r1 -rke2 v1.31.0+rke2r1
54+
┌──────────────────────────────────┬──────────────────────────────┬─────────────────────────────┐
55+
│ NAME │ V1.28.11+RKE2R1 (2024-07-01) │ V1.31.0+RKE2R1 (2024-09-04) │
56+
├──────────────────────────────────┼──────────────────────────────┼─────────────────────────────┤
57+
│ containerd │ v1.7.17-k3s1 │ v1.7.20-k3s1 🚀 │
58+
│ coredns │ v1.11.1 │ v1.11.1 │
59+
│ etcd │ v3.5.13-k3s1 │ v3.5.13-k3s1 │
60+
│ helm-controller │ v0.15.10 │ v0.16.3 🚀 │
61+
│ ingress-nginx │ v1.10.1-hardened1 │ v1.10.4-hardened2 🚀 │
62+
│ kubernetes │ v1.28.11 │ v1.31.0 🚀 │
63+
│ metrics-server │ v0.7.1 │ v0.7.1 │
64+
│ runc │ v1.1.12 │ v1.1.13 🚀 │
65+
│ harvester-cloud-provider │ 0.2.400 │ 0.2.600 🚀 │
66+
│ harvester-csi-driver │ 0.1.1700 │ 0.1.1800 🚀 │
67+
│ rancher-vsphere-cpi │ 1.7.001 │ 1.9.000 🚀 │
68+
│ rancher-vsphere-csi │ 3.1.2-rancher400 │ 3.3.1-rancher100 🚀 │
69+
│ rke2-calico │ v3.27.300 │ v3.28.100 🚀 │
70+
│ rke2-calico-crd │ v3.27.002 │ v3.28.100 🚀 │
71+
│ rke2-canal │ v3.28.0-build2024062503 │ v3.28.1-build2024082701 🚀 │
72+
│ rke2-cilium │ 1.15.500 │ 1.16.101 🚀 │
73+
│ rke2-coredns │ 1.29.002 │ 1.29.004 🚀 │
74+
│ rke2-ingress-nginx │ 4.10.101 │ 4.10.401 🚀 │
75+
│ rke2-metrics-server │ 3.12.002 │ 3.12.002 │
76+
│ rke2-snapshot-controller │ 1.7.202 │ 1.7.202 │
77+
│ rke2-snapshot-controller-crd │ 1.7.202 │ 1.7.202 │
78+
│ rke2-snapshot-validation-webhook │ 1.7.302 │ 1.7.302 │
79+
├──────────────────────────────────┼──────────────────────────────┼─────────────────────────────┤
80+
│ ❌ = VERSION STRING INVALID │ │ │
81+
│ 🚀 = BUMPED │ │ │
82+
└──────────────────────────────────┴──────────────────────────────┴─────────────────────────────┘
6783
```

0 commit comments

Comments
 (0)