Skip to content

Document coder-logstream-kube #8549

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

Closed
9 tasks done
bpmct opened this issue Jul 17, 2023 · 0 comments · Fixed by #8675
Closed
9 tasks done

Document coder-logstream-kube #8549

bpmct opened this issue Jul 17, 2023 · 0 comments · Fixed by #8675
Assignees
Labels
docs Area: coder.com/docs

Comments

@bpmct
Copy link
Member

bpmct commented Jul 17, 2023

We have coder-logstream-kube which resolves #7576. This feature is complete, but undocumented in Coder :)

Let's do the following:

  • Change our example Kubernetes templates to use a deployment instead of a pod. As the logstream-kube docs says, we need to set wait_for_rollout = false: https://github.com/coder/coder-logstream-kube#usage
  • Document logstream-kube in the README of the Kubernetes template.
  • Document logstream-kube in a separate page "Streaming Kubernetes logs" under Platforms > Kubernetes in our documentation
    • What it does and why it matters (screenshot of k8s logs)
      • Show Kubernetes quotas errors
      • Show if image doesn't exist
      • Show if pod crashed
    • How to install (e.g. via helm)
    • How it works (and link to github repo for more details)

Our docs can be relatively slim since the bulk of it is on the GitHub repo. A related effort is #8089 which will inform users about this in the UI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants