|
1 | | -# Coder doctor |
| 1 | +# Coder Doctor 🧑⚕️ |
2 | 2 |
|
3 | | -This repository contains an initial implementation of a command-line |
4 | | -diagnostic tool and library for checking that a given system can run |
5 | | -the Coder control plane and workspaces. |
| 3 | +Coder Doctor is a command-line diagnostic tool for checking that a |
| 4 | +given platform can run the Coder control plane and workspaces. |
6 | 5 |
|
7 | | -The initial implementation performs a series of preflight checks, as |
8 | | -described in [Preflight cluster health check tool] RFC. |
| 6 | +## Supported Platforms |
9 | 7 |
|
10 | | -[Preflight cluster health check tool]: https://www.notion.so/coderhq/Preflight-cluster-health-check-tool-07024636e1c741e2a30e482bb796ea0a |
| 8 | +Currently, the following platforms are supported, with the following |
| 9 | +preflight checks: |
11 | 10 |
|
12 | | -This may (or may not) be the final home of this project. Please |
13 | | -provide feedback regarding the plan on the RFC, or comments on the |
14 | | -implementation as comments in the relevant pull requests. |
| 11 | +### Kubernetes |
15 | 12 |
|
16 | | -This project is in `alpha` state and Coder offers no compatibility |
17 | | -guarantees, either for the tool itself or any public Go APIs. Most |
18 | | -code is kept in the `internal` package to make this clear, and will |
19 | | -be promoted to an externally-importable package once we enter `beta` |
20 | | -state. |
| 13 | +- Kubernetes Version: checks the cluster version for compatibility |
| 14 | +with the requested version of Coder. |
| 15 | +- Helm Version: checks the locally-installed Helm version for |
| 16 | +compatibility with the requested version of Coder. |
| 17 | +- Kubernetes RBAC: checks that the service account has the required |
| 18 | +permissions to run Coder. |
| 19 | +- Kubernetes Resosurces: checks that the cluster has the required |
| 20 | +resource types available to run Coder. |
| 21 | + |
| 22 | +## Usage |
| 23 | + |
| 24 | +To check if your Kubernetes cluster is ready to install Coder, run: |
| 25 | + |
| 26 | +```console |
| 27 | +coder-doctor check kubernetes |
| 28 | +``` |
| 29 | + |
| 30 | +For more information, you can run: |
| 31 | + |
| 32 | +```console |
| 33 | +coder-doctor -h |
| 34 | +``` |
| 35 | + |
| 36 | +## Feedback |
| 37 | + |
| 38 | +We love feedback! If you have any issues or suggestions, please feel |
| 39 | +free to submit an [issue](https://github.com/cdr/coder-doctor/issues) or [pull request](https://github.com/cdr/coder-doctor/pulls). |
| 40 | + |
| 41 | +**Note:** This project is in `alpha` state and Coder offers no |
| 42 | +compatibility guarantees, either for the tool itself or any public Go |
| 43 | +APIs. Most code is kept in the `internal` package to make this clear, |
| 44 | +and will be promoted to an externally-importable package once the tool |
| 45 | +enters `beta` state. |
0 commit comments