Improve helm chart documentation #248
Conversation
faganihajizada
commented
Feb 18, 2025
•
faganihajizada
commented
- Github action to auto-generate README file with Helm-docs
Add helm-docs workflow to auto-generate README.md for helm charts. Signed-off-by: faganihajizada <[email protected]>
There was a problem hiding this comment.
I think the scope of this PR is too broad, I would split it into 2 PR's one for HPA and one for the GItHub Action.
Also for the GitHub action, please check the PR we currently have open for reusable workflows and try to make the Helm action follow a similar pattern.
| scaleTargetRef: | ||
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| name: {{ include "k8s-dra-driver.fullname" . }}-controller |
There was a problem hiding this comment.
We explicitly do not want more than one instance of the controller running in a cluster at a time. it is not designed to have multiple replicas running.
There was a problem hiding this comment.
Thanks, @klueska for the info. I remove the HPA and I will add a note about this to README
Readme.md is auto-generated with helm-docs and Chart.yaml is updated with the correct description. Signed-off-by: faganihajizada <[email protected]>
faganihajizada
force-pushed
the
improve-helm-chart
branch
from
ca2bce4 to
c43e639
Compare
thanks for review @ArangoGutierrez According to #248 (comment) there should not be more than one instance of the controller running. I removed the HPA from this PR. Do you suggest waiting for the merge of #246 and then adjust accordingly? |
Update README files to note that only one controller instance should run per cluster at a time. Signed-off-by: faganihajizada <[email protected]>
Update dockerfiles to align with the k8s-device-plugin. Signed-off-by: Evan Lezar <[email protected]>
Signed-off-by: Evan Lezar <[email protected]>
Signed-off-by: Evan Lezar <[email protected]>
Signed-off-by: Evan Lezar <[email protected]>
Signed-off-by: Evan Lezar <[email protected]>
Signed-off-by: Evan Lezar <[email protected]>
Bumps [github.com/spf13/pflag](https://github.com/spf13/pflag) from 1.0.5 to 1.0.6. - [Release notes](https://github.com/spf13/pflag/releases) - [Commits](spf13/pflag@v1.0.5...v1.0.6) --- updated-dependencies: - dependency-name: github.com/spf13/pflag dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>
Bumps [golang.org/x/sys](https://github.com/golang/sys) from 0.29.0 to 0.30.0. - [Commits](golang/sys@v0.29.0...v0.30.0) --- updated-dependencies: - dependency-name: golang.org/x/sys dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: John Belamaric <[email protected]>
Signed-off-by: Kevin Klues <[email protected]> Signed-off-by: Evan Lezar <[email protected]>
|
I will make a new PR if/when #246 is merged |
