Skip to content

Commit

Permalink
docs: add image builder envrionment variable warning
Browse files Browse the repository at this point in the history
  • Loading branch information
65278 authored and wikkyk committed Apr 16, 2024
1 parent e60da87 commit 7ee87e3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
9 changes: 9 additions & 0 deletions docs/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ If your capi-controller is too new, you can pass a `--core cluster-api:v1.6.1` d
Calico unfortunately does not test connectivity when it choses a node ip to use for IPVS communication.
This can be altered manually. More on this topic in [Calicos documentation](https://docs.tigera.io/calico/latest/networking/ipam/ip-autodetection#autodetection-methods).


## Machine deletion deadlock
Sometimes machines do not delete because some resource needs to be reconciled before
deletion can happen, but these resources can not reconcile (for example nodes may not drain).
Expand All @@ -79,3 +80,11 @@ To fix deletion deadlocks in such cases:
- Delete the `machine`

After these steps, VMs may linger in proxmox. Carefully remove those.

## Imagebuilder Environment Variables
[Proxmox VE Image Builder](https://image-builder.sigs.k8s.io/capi/providers/proxmox) and CAPMOX differ in their use of environment variables.
Trying to use CAPMOX's variables will lead to [image building failure](https://github.com/ionos-cloud/cluster-api-provider-proxmox/issues/52).
The image builder uses `PROXMOX_USERNAME` as the token name and `PROXMOX_TOKEN` as the token's secret, whereas CAPMOX uses `PROXMOX_TOKEN` as
the token name and `PROXMOX_SECRET` as the token's secret UUID.
The CAPMOX way of implementing authentication is closer to the [Proxmox API Token Documentation](https://pve.proxmox.com/wiki/Proxmox_VE_API#api_tokens),
therefore this pitfall will likely keep on existing.
3 changes: 2 additions & 1 deletion docs/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ In order to deploy a K8s cluster with CAPMOX, you require the following:
* Proxmox VE template in order to be able to create a cluster.

* You can build VM template using [image-builder](https://github.com/kubernetes-sigs/image-builder)
* **we recommend using** [the Proxmox VE builder](https://image-builder.sigs.k8s.io/capi/providers/proxmox)
* **we recommend using** [the Proxmox VE builder](https://image-builder.sigs.k8s.io/capi/providers/proxmox).
See our [troubleshooting docs](Troubleshooting.md#imagebuilder-environment-variables) for more information.
* OR by [Building Raw Images](https://image-builder.sigs.k8s.io/capi/providers/proxmox)

* clusterctl, which you can download it from Cluster API (CAPI) [releases](https://github.com/kubernetes-sigs/cluster-api/releases) on GitHub.
Expand Down

0 comments on commit 7ee87e3

Please sign in to comment.