Skip to content

Commit 8a60319

Browse files
authored
Minor doc fixes (#5)
* fmt * Highlight no SSH access requirement in PKE Emphasize that PKE does not require SSH access or modifications to Proxmox VE nodes. * polish for release
1 parent 08302b9 commit 8a60319

File tree

6 files changed

+58
-51
lines changed

6 files changed

+58
-51
lines changed

docs/quick-start.md

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -95,25 +95,18 @@ stringData:
9595
PROXMOX_STORAGE_POOL: "local" #this should be fine for the most users
9696
PACKER_FLAGS: >-
9797
--var memory=4096
98-
--var kubernetes_rpm_version=1.33.1
99-
--var kubernetes_semver=v1.33.1
100-
--var kubernetes_series=v1.33
101-
--var kubernetes_deb_version=1.33.1-1.1
98+
--var kubernetes_rpm_version=1.34.2
99+
--var kubernetes_semver=v1.34.2
100+
--var kubernetes_series=v1.34
101+
--var kubernetes_deb_version=1.34.2-1.1
102102
```
103103
Configure needed values and save the File.
104104
105-
Example on how to use ubuntu server
106-
```yaml
107-
--var iso_url=https://releases.ubuntu.com/noble/ubuntu-24.04.3-live-server-amd64.iso
108-
--var iso_checksum=c3514bf0056180d09376462a7a1b4f213c1d6e8ea67fae5c25099c6fd3d8274b
109-
```
110-
111105
If the builder complains about the storage for lvm-thin add this to the packer flags.
112106
```yaml
113107
--var disk_format=raw
114108
```
115109

116-
117110
Now we need also a Job which creates the Image. A Job is a Kubernetes Pod which is only executed once with a finite life - until the Job successfully complete. It uses Image-Builder Docker-Image with the required configuration to build Kubernetes Proxmox VM-Templates.
118111
```yaml
119112
# job.yaml
@@ -133,7 +126,7 @@ spec:
133126
restartPolicy: OnFailure
134127
containers:
135128
- name: image-builder
136-
image: registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.45
129+
image: registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.47
137130
envFrom:
138131
- secretRef:
139132
name: proxmox-image-build-config
@@ -302,7 +295,7 @@ spec:
302295
project: default
303296
source:
304297
repoURL: https://github.com/Caprox-eu/Proxmox-Kubernetes-Engine.git
305-
targetRevision: main
298+
targetRevision: 08302b9a1e3d3699b2a716ac9e07bc53e9aeabeb
306299
path: manifests/clusterclass-cilium-with-shared-ippool/base
307300
syncPolicy:
308301
syncOptions:
@@ -346,13 +339,13 @@ Then with the caprox-engine.
346339
```bash
347340
sudo k3s kubectl apply -f app-proxmox-kubernetes-engine.yaml
348341
```
349-
Wait until the App is Heathly and synced.
342+
This App will later go Healthy after we finsihed the first cluster creation.
350343
```bash
351344
sudo k3s kubectl get apps -A
352345
NAME SYNC STATUS HEALTH STATUS
353346
cluster-api-operator-cert-manager Synced Healthy
354347
cluster-api-operator-main Synced Healthy
355-
proxmox-kubernetes-engine Synced Healthy
348+
proxmox-kubernetes-engine Synced Progressing
356349
...
357350
```
358351
Nice! Now we need to configure cluster-api to our specific environment.
@@ -471,7 +464,7 @@ spec:
471464
# These IPs will be used for the Kubernetes nodes
472465
# Also configure your network prefix and gateway accordingly
473466
addresses:
474-
- 192.168.2.150-192.168.2.199
467+
- 192.168.2.100-192.168.2.149
475468
gateway: 192.168.2.1
476469
prefix: 24
477470
```
@@ -493,7 +486,7 @@ kind: Cluster
493486
metadata:
494487
labels:
495488
# mandatory for functional cluster
496-
caprox.eu/cni: cilium-v1.17.4
489+
caprox.eu/cni: cilium-v1.18.4
497490
caprox.eu/ccm: "true"
498491
caprox.eu/inject-proxmox-credentials: "true"
499492
# optional
@@ -504,7 +497,7 @@ metadata:
504497
spec:
505498
topology:
506499
class: proxmox-clusterclass-cilium-v0.1.0
507-
version: 1.33.1
500+
version: 1.34.2
508501
controlPlane:
509502
replicas: 1
510503
workers:
@@ -515,12 +508,9 @@ spec:
515508
variables:
516509
- name: cloneSpec
517510
value:
518-
sshAuthorizedKeys:
519-
- "ssh-ed25519 replace-with-your-ssh-key-and-ssh-to-node-ip-as root"
520511
vmTemplate:
521512
sourceNode: node01
522-
templateID: 114
523-
513+
templateID: 114
524514
#Example of if you want to modify node resources
525515
#machineSpec:
526516
# controlPlane:
@@ -537,7 +527,7 @@ spec:
537527
# sizeGb: 80
538528
- name: controlPlaneEndpoint
539529
value:
540-
host: 192.168.2.201
530+
host: 192.168.2.200
541531
```
542532
543533
The fields you **must** change are:
@@ -564,7 +554,7 @@ The fields you **can** change are:
564554
* **`metadata.name`**:
565555
* This is the name of your Kubernetes cluster.
566556

567-
For more configuration options, including memory and CPU settings for your VMs, refer to the available **variables** [here](https://github.com/3deep5me/kubernetes-gitops/blob/cluster-api-action/k3s-mgmt-proxmox/manifest/capmox-setup/cilium-clusterclass-with-shared-ippool/base/variables/clonespec.yaml).
557+
For more configuration options, including memory and CPU settings for your VMs, refer to the available **variables** [here](https://github.com/Caprox-eu/Proxmox-Kubernetes-Engine/blob/main/manifests/clusterclass-cilium-with-shared-ippool/base/variables/clonespec.yaml).
568558

569559
After you've set the required fields, remember to save the file.
570560

manifests/clusterclass-cilium-with-shared-ippool/your-config/clusters/cluster-example.yaml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,20 @@ spec:
2929
vmTemplate:
3030
sourceNode: node01
3131
templateID: 101
32+
#Example of if you want to modify node resources
33+
#machineSpec:
34+
# controlPlane:
35+
# numCores: 2
36+
# numSockets: 1
37+
# memoryMiB: 4096
38+
# workerNode:
39+
# numCores: 6
40+
# numSockets: 1
41+
# memoryMiB: 6144
42+
# disks:
43+
# bootVolume:
44+
# disk: scsi0
45+
# sizeGb: 80
3246
- name: controlPlaneEndpoint
3347
value:
34-
host: 192.168.2.205
48+
host: 192.168.2.210

readme.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ Cluster API currently boasts over 30 infrastructure providers, with Proxmox bein
3737
In my opinion, they are a perfect match for a modern, open-source, Kubernetes-based private cloud.
3838

3939
## Roadmap
40-
[ ] Web-UI with [cyclops](https://github.com/cyclops-ui/cyclops)
40+
- [ ] Web-UI with [cyclops](https://github.com/cyclops-ui/cyclops)
41+
- [ ] Migrate to v1beta2 cluster-api
4142

4243
## Also in this Area
4344
- [Cozystack PaaS-hosted](https://cozystack.io/docs/operations/configuration/bundles/#paas-hosted): Convert your Kubernetes cluster into a full cloud experience
Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,30 @@ spec:
2525
- containerPort: 80
2626
volumeMounts:
2727
- mountPath: "/usr/share/nginx/html"
28-
name: nginx-persistent-storage
28+
name: nginx-persistent-storage
29+
---
30+
apiVersion: v1
31+
kind: PersistentVolumeClaim
32+
metadata:
33+
name: nginx-pvc
34+
spec:
35+
accessModes:
36+
- ReadWriteOnce
37+
resources:
38+
requests:
39+
storage: 1Gi
40+
---
41+
apiVersion: v1
42+
kind: Service
43+
metadata:
44+
labels:
45+
run: nginx
46+
name: nginx
47+
spec:
48+
ports:
49+
- port: 80
50+
protocol: TCP
51+
targetPort: 80
52+
selector:
53+
app: nginx
54+
type: LoadBalancer

tests/pvc.yaml

Lines changed: 0 additions & 10 deletions
This file was deleted.

tests/svc.yaml

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)