Skip to content

Conversation

@3deep5me
Copy link
Contributor

Hi folks,

I'm currently writing a beginner-friendly, end-to-end blog post for CAPMOX on "How to Use Cluster-API in a Home-Lab."

For this, I created a highly opinionated ClusterClass with a shared IP pool and automatic Cilium installation using the Cluster API Helm add-on. I'd really like to give something back, so it would be an honor to host the files in the upstream project rather than in one of my own repositories.

The blog post needs some fine-tuning and testing, but I believe the basic structure is solid. You can read it here (not yet public).

If you would agree to host the files here i could reference this repository in my Guide.

@github-actions
Copy link

Tests

Please note that running unit and e2e tests requires manual approval from a team member.

e2e tests

We use labels to control which e2e tests contexts are run:

Label Behaviour
none Run Generic tests only
e2e/none skip all e2e tests (documentation etc) - overrides all e2e/* labels Do not run any e2e tests
e2e/flatcar run Flatcar e2e tests Add Flatcar tests

ℹ️ Ask a team member to add the requested labels if you don't have enough permissions.

@ozhankaraman
Copy link

this PR is really good, thx

Copy link
Member

@mcbenjemaa mcbenjemaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this contribution, but this is so much manifests that we could take ownership of maintaining it.
I recommend you create your own repo, and we would create an examples section and mention it here.
How about that?

@3deep5me
Copy link
Contributor Author

This sounds good!
The repository is created: https://github.com/Caprox-eu/Proxmox-Kubernetes-Engine
Do you want to have the Examples section in the README.md?

README.md Outdated
## Launching a Kubernetes cluster on Proxmox VE

Check out the [quickstart guide](./docs/Usage.md#quick-start) for launching a cluster on Proxmox VE.
Check out the [quickstart guide](./docs/Usage.md#quick-start) for launching a cluster on Proxmox VE. For a more opinionated walkthrough, have a look at the [Examples](#examples).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please start with a new line.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for looking at it, if its fine feel free to resolve the conversation.

We take security seriously.
Please read our [security policy](SECURITY.md) for information on how to report security issues.

## Examples
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm unsure whether we place it here or in the Usage document.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wikkyk what do you think?
Placing the examples section here or in the Usage?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would name this section something like 'external links'. I wouldn't want to accidentally leave an impression of endorsement.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 3, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants