Closed jessebot closed 1 month ago
I don't know of a good title for this PR, but it's ready for review 👋
@JanMa Is there a recommended way to merge this self-hosted Helm repo into our existing site?
Per Jan in the openbao/openbao-general matrix room (to keep anyone not on matrix in the loop):
Ah found it, thanks for the hint. I don't think it makes a lot of sense to integrate the generated HELM repo with our existing docs site. Those assets are only ever downloaded by the HELM CLI when you install the repository, and not something a user would look at.
The documentation for the HELM chart is already in our main repo, we just exclude it from the published site for now. So for me it would be fine to just use the openbao.github.io/openbao-helm url for the HELM repo. Alternatively we could also configure it to use a subdomain like helm.openbao.org to serve all our assets from the same domain
I think we're going to have a similar discussion again soon when it comes to the question at which domain we want to host our DEB and RPM repos. I would like to host them via GitHub pages as well
Let me know how you'd like to proceed. I think it's easiest to move it forward with openbao.github.io/openbao-helm however, I still need a gh-pages branch setup for this repo. If you'd like it to go somewhere else, I'll need to spend time looking into this, as I have only ever used the official paved road path for helm/chart-releaser.
I am in favor of using the default pages domain to get this in. The project can look at sub-domain integration down the road.
Description
This is the beginning of addressing #1 so that we can begin releasing the chart locally. This PR contains a number of changes related to the CI/CD of this chart that I will list below. It looks like a lot of files, but most of it is just moving the helm chart into a new directory as per the helm chart standard.
Chart linting
Changes I've made to the linting and testing aspects of this chart/repo:
.github/workflows/lint-chart.yml
to lint the chart on each pull request.github/workflows/actionlint.yml
as this referced the old release processChart release via github pages
I've done most of the work to allow for releases via github pages using the chart-releaser-action. This includes:
templates
,Chart.yaml
,.helmignore
) under a new dir calledcharts/openbao/
so it's automatically picked up by the helm/chart-releaser-action.github/workflows/release-chart.yml
to release on push to main and generated release notes with PR link.github/workflows/update-helm-charts-index.yml
as this was specific to hashicorpTo finish this, a maintainer of this repo needs to set up the following according to the helm/chart-releaser-action docs:
Please let me know if you have any questions.
basic docs
I've generated some docs from the values.yaml using norwoodj/helm-docs so that
./charts/openbao/README.md
has a readable chart for all parameters.Misc
Chart.yaml
I've changed the name of the chart from Vault to OpenBao and reset theversion
to0.1.0
since we have a lot of testing to do..github/workflows/jira.yaml
as it is related to hashicorp's jira instance and project workflowEdit: moved open discussions/issues to https://github.com/openbao/openbao-helm/issues/3 and https://github.com/openbao/openbao-helm/discussions/4