Skip to content

feat: add helm README, install guide, linters - #3268

Merged
deansheather merged 6 commits into
mainfrom
helm-docs
Aug 18, 2022
Merged

deansheather merged 6 commits into
mainfrom
helm-docs

Conversation

@deansheather

Copy link
Copy Markdown
Collaborator
  • Adds helm/README.md which is generated from a template by helm-docs (like in Coder Classic).
  • Adds a "Kubernetes via Helm" section to the install guide.
    • Links to details about cloud PostgreSQL offerings at Google Cloud, AWS, Azure and DigitalOcean.
    • Links to Bitnami's PostgreSQL Helm chart.
    • Links to Postgres operator.
  • Adds helm/Makefile which has lint and generate tasks for the Helm chart + README.
  • Adds CI tasks for cd helm && make gen and cd helm && make lint.

Closes #3226
Closes #3224

@deansheather
deansheather requested a review from ammario as a code owner July 28, 2022 17:28
@deansheather
deansheather requested a review from kylecarbs July 28, 2022 17:29
@deansheather deansheather self-assigned this Jul 28, 2022
@deansheather deansheather added docs Area: coder.com/docs api Area: HTTP API labels Jul 28, 2022
Comment thread 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":""}}` |

Copy link
Copy Markdown
Member

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

Copy link
Copy Markdown
Collaborator Author

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?

Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Member

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

@github-actions

github-actions Bot commented Aug 6, 2022

Copy link
Copy Markdown
Contributor

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.

@github-actions github-actions Bot added the stale This issue is like stale bread. label Aug 6, 2022

@bpmct bpmct left a comment

Copy link
Copy Markdown
Member

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!

Comment thread 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":""}}` |

Copy link
Copy Markdown
Member

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

Comment thread docs/install.md Resolved
Comment thread docs/install.md Resolved
@github-actions github-actions Bot closed this Aug 12, 2022
@ammario

ammario commented Aug 16, 2022

Copy link
Copy Markdown
Member

plz get this merged 🤓🤓🤓

@ammario ammario reopened this Aug 16, 2022
@deansheather
deansheather requested a review from ammario August 18, 2022 16:07

@ammario ammario left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

docs LGTM

@deansheather
deansheather merged commit 55890df into main Aug 18, 2022
@deansheather
deansheather deleted the helm-docs branch August 18, 2022 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api Area: HTTP API docs Area: coder.com/docs stale This issue is like stale bread.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use helm-docs to generate Helm README.md Write documentation for how to use helm chart

4 participants