-
Notifications
You must be signed in to change notification settings - Fork 936
feat: add helm README, install guide, linters #3268
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
helm/README.md
Outdated
|
||
| Key | Type | Description | Default | | ||
| ------------------- | ---- | ----------- | ------------------------------- | | ||
| coder | object | Primary configuration for `coder server`. | `{"env":[{"name":"CODER_ACCESS_URL","value":"https://coder.example.com"}],"image":{"pullPolicy":"IfNotPresent","repo":"ghcr.io/coder/coder","tag":""},"resources":{},"service":{"enable":true,"externalTrafficPolicy":"Cluster","loadBalancerIP":"","type":"LoadBalancer"},"tls":{"secretName":""}}` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to do this generation? It always has confused me, and people can just look at values.yaml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with removing it and pointing towards values.yaml instead, @ammario any thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can see it both ways.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can remove it, but encourage users to install with defaults, such as the access URL and postgres URL
This Pull Request is becoming stale. In order to minimize WIP, prevent merge conflicts and keep the tracker readable, I'm going close to this PR in 3 days if there isn't more activity. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I started on some helm docs, then remembered this was underway. Awesome!
helm/README.md
Outdated
|
||
| Key | Type | Description | Default | | ||
| ------------------- | ---- | ----------- | ------------------------------- | | ||
| coder | object | Primary configuration for `coder server`. | `{"env":[{"name":"CODER_ACCESS_URL","value":"https://coder.example.com"}],"image":{"pullPolicy":"IfNotPresent","repo":"ghcr.io/coder/coder","tag":""},"resources":{},"service":{"enable":true,"externalTrafficPolicy":"Cluster","loadBalancerIP":"","type":"LoadBalancer"},"tls":{"secretName":""}}` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can remove it, but encourage users to install with defaults, such as the access URL and postgres URL
plz get this merged 🤓🤓🤓 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs LGTM
helm/README.md
which is generated from a template byhelm-docs
(like in Coder Classic).helm/Makefile
which has lint and generate tasks for the Helm chart + README.cd helm && make gen
andcd helm && make lint
.Closes #3226
Closes #3224