docs: add image builder envrionment variable warning #173
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65278
requested review from
avorima,
lubedacht,
pborn-ionos,
mcbenjemaa and
wikkyk
as code owners
65278
force-pushed
the
52_image_builder_environment_vars
branch
from
187c9f3 to
4c3bd83
Compare
wikkyk
reviewed
Apr 11, 2024
docs/Troubleshooting.md
Outdated
| 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. | ||
| [Proxmox's API Token Documentation](https://pve.proxmox.com/wiki/Proxmox_VE_API#api_tokens) is closer to CAPMOX's way of implementing authentication, |
There was a problem hiding this comment.
I would flip this sentence around, Proxmox API is the upstream standard. Capmox is closer to the upstream than Image Builder is.
Suggested change
| [Proxmox's API Token Documentation](https://pve.proxmox.com/wiki/Proxmox_VE_API#api_tokens) is closer to CAPMOX's way of implementing authentication, | |
| The CAPMOX way of implementing authentication is closer to the [Proxmox API Token Documentation](https://pve.proxmox.com/wiki/Proxmox_VE_API#api_tokens), |
|
e2e unnecessary for docs PRs |
65278
force-pushed
the
52_image_builder_environment_vars
branch
from
4c3bd83 to
406205d
Compare
|
wikkyk
force-pushed
the
52_image_builder_environment_vars
branch
from
406205d to
7ee87e3
Compare
wikkyk
approved these changes
Apr 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
ref: #52
Description of changes:
Documentation on environment variable differences in CAPMOX and Proxmox Image Builder VE.
Testing performed:
None at all.