Skip to content

Conversation

@antoniolago
Copy link
Contributor

@antoniolago antoniolago commented Jun 6, 2025

As discussed in #55, users should have helm chart as option for deploying headplane, I forked an existing chart and fixed a few things.
I will keep https://github.com/antoniolago/headplane-chart/ as is, but the mantainers may want the helm's code into this repo tree so other devs can use and enhance it in a more official way.

I used my personal OCI registry on README, feel free to change this or any other thing.

I have deployed and tested >some< features and it worked (basic admin access, add device, edit acl via values.yaml) so it definetly should be more tested.

Edit:
Using this chart at a production environment and everything looks good

@antoniolago antoniolago marked this pull request as draft June 7, 2025 04:45
@tale
Copy link
Owner

tale commented Jun 9, 2025

Whenever you're ready for review and merge, feel free to change it off of a draft and I'll take a look. Take your time though, we have a long time to go before 0.6.1!

@tale tale added this to the 0.6.1 milestone Jun 9, 2025
@tale tale added the enhancement New feature or request label Jun 9, 2025
@antoniolago antoniolago marked this pull request as ready for review June 13, 2025 20:17
@antoniolago
Copy link
Contributor Author

Hey, added some few things and I think it's looking good, already using this chart on my personal and work clusters, headplane is so nice, thanks for bringing this awesome app to the community :)

antoniolago and others added 3 commits June 13, 2025 17:22
This is only applicable if the user choose policy mode file, but without this value the configmap is not being created
Co-Authored-By: definitelynobody <[email protected]>
@tale
Copy link
Owner

tale commented Jun 20, 2025

Thank you for all the hard work, I'll try to get it merged into 0.6.1 ASAP.

Copy link
Owner

@tale tale left a comment

Choose a reason for hiding this comment

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

Aside from nits related to the packaging and distribution of the charts, this looks good to me.

### Install the Chart
```sh
# Install with default values
helm install headplane oci://harbor.lag0.com.br/library/headplane
Copy link
Owner

Choose a reason for hiding this comment

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

Otherwise a good overall PR, wondering why we're defaulting to the Harbor hosted instance, is there not a way to just pull it directly from the GitHub repository or publish a chart repository using GitHub pages?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I use Harbor just because I like self-hosting stuff lol, no objections for creating a workflow to push this to another chart repository, maybe you can setup a workflow based on this one: https://github.com/antoniolago/headplane-chart/blob/main/.github/workflows/publish-helm-chart.yml (tests are included in this PR already)

Consider using a secrets management solution in production like external-secrets.

## License
Copyright © 2025 antoniolago
Copy link
Owner

Choose a reason for hiding this comment

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

I'd prefer if this isn't licensed, especially as Apache because its language doesn't necessarily fit well with MIT the best.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure we can remove Apache license since the code is forked from https://github.com/nbcloudio/headplane-chart unless all contributors agrees, or am I wrong?

Copy link
Owner

Choose a reason for hiding this comment

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

Then in that case, we do need their permission yes, and I can't technically merge this in-tree until it's been addressed.

Note: Make sure to keep your secrets secure and never commit them to version control.
Consider using a secrets management solution in production like external-secrets.

## License
Copy link
Owner

Choose a reason for hiding this comment

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

Same concerns as earlier

antoniolago and others added 2 commits June 23, 2025 21:34
Co-Authored-By: Stephan Deumier <[email protected]>
@jcstryker
Copy link

@antoniolago @tale - I have been using this helm chart locally but saw you were contributing a fixed version of the existing one so just kept it to myself.

#263

If licensing is a concern, I am happy to provide that under MIT as an option - no hard feelings at all if this one works out and you decide to close my PR

If you find it helpful, @antoniolago I would love to collaborate with you on bringing this up to standard

@antoniolago
Copy link
Contributor Author

@antoniolago @tale - I have been using this helm chart locally but saw you were contributing a fixed version of the existing one so just kept it to myself.

#263

If licensing is a concern, I am happy to provide that under MIT as an option - no hard feelings at all if this one works out and you decide to close my PR

If you find it helpful, @antoniolago I would love to collaborate with you on bringing this up to standard

Hello, nice work you're doing, havent got the opportunity to test yet but it looks like you know what you are doing, at the moment I've reached a goal state to >my specific requirements< with headplane's infra, this PR and the chart repository is a way to share this but it's not necessarely the best chart option, tho we could ask the 4 people involved if they agree to change license theres a certainty on your solution to the license issue, so maybe we should actually go for it! At the moment I'm changing obsessions lol, but I'll keep an eye on this for sure.

Copy link

@lucasfcnunes lucasfcnunes left a comment

Choose a reason for hiding this comment

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

*multiple files have missing new line at EOF

Comment on lines +26 to +27
cp /headscale-config/config.yaml /headscale-data/config.yaml
cp /headscale-acl/acl.hujson /headscale-data/acl.hujson

Choose a reason for hiding this comment

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

isn't this going to overwrite changes made from the ui with the values in the configmap and secret?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Only if headscale.config.policy.mode is 'file'

Choose a reason for hiding this comment

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

what about dns configs?

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

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants