https://github.com/coder/coder-doctor
A preflight check tool for Coder
https://github.com/coder/coder-doctor
Last synced: 15 days ago
JSON representation
A preflight check tool for Coder
- Host: GitHub
- URL: https://github.com/coder/coder-doctor
- Owner: coder
- License: gpl-3.0
- Archived: true
- Created: 2021-08-07T16:21:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-14T12:00:29.000Z (about 2 years ago)
- Last Synced: 2025-04-05T02:47:04.622Z (21 days ago)
- Language: Go
- Homepage: https://coder.com
- Size: 286 KB
- Stars: 7
- Watchers: 7
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Coder Doctor 🧑⚕️
[](https://github.com/coder/coder-doctor/releases)
[](https://pkg.go.dev/cdr.dev/coder-doctor)
[](https://goreportcard.com/report/cdr.dev/coder-doctor)
[](https://github.com/coder/coder-doctor/actions/workflows/build.yaml?query=branch%3Amain)
[](https://coveralls.io/github/coder/coder-doctor?branch=main)
Coder Doctor is a command-line diagnostic tool for checking that a
given platform can run the Coder control plane and workspaces.
## Supported Platforms
Currently, the following platforms are supported, with the following
preflight checks:
### Kubernetes
- Kubernetes Version: checks that the selected Coder version is
compatible with the Kubernetes control plane.
- Helm Version: checks the locally-installed Helm version for
compatibility with the requested version of Coder.
- Kubernetes RBAC: checks that the service account has the required
permissions to run Coder.
- Kubernetes Resources: checks that the cluster has the required
resource types available to run Coder.
## Installation
You can manually download the latest [release](https://github.com/coder/coder-doctor/releases):
1. Click a release and download the tar file for your operating system
(ex: coder-doctor-linux-amd64.tar.gz)
1. (Optional, recommended) Download the `checksums.txt` for the desired
release and verify the `sha256` checksum of the file you downloaded.
1. Extract the `coder-doctor` binary.
1. Move the `coder-doctor` binary to somewhere in your `$PATH` (e.g., `mv coder-doctor /usr/local/bin/coder-doctor` for macOS/Linux).
2. (macOS Users) You may need to [grant `coder-doctor` additional permissions](https://support.apple.com/en-us/HT202491) before running.
Alternatively, use the below command, replacing `$VERSION`, `$OSTYPE`
(one of `darwin`, `linux`, `windows`) and `$ARCH` (one of `amd64`, `arm64`)
as required:
```shell-session
$ curl -fSsL "https://github.com/coder/coder-doctor/releases/download/v${VERSION}/coder-doctor_${VERSION}_${OSTYPE}_${ARCH}.tar.gz" | tar -xzvf -
README.md
coder-doctor
```
## Usage
To check if your Kubernetes cluster is ready to install Coder, run:
```console
coder-doctor check kubernetes
```
For more information, you can run:
```console
coder-doctor -h
```
## Development
To run from source, clone the repository and run:
```bash
go run . help
```
The `Makefile` also includes various helpful targets to run
linters and tests, but standard Go tools (e.g. `go test`)
should work as well.
## Feedback
We love feedback! Please [open an issue] or [submit a pull request]
with any ideas for improving this.
[open an issue]: https://github.com/coder/coder-doctor/issues
[submit a pull request]: https://github.com/coder/coder-doctor/pulls
**Note:** This tool is in `beta` state and Coder offers no compatibility
guarantees, either for the tool itself or any public Go APIs. Most code
is kept in the `internal` package to make this clear, and will be promoted
to an externally-importable package once things stabilize.
## Copyright and License
coder-doctor preflight diagnostic tool
Copyright (C) 2021 Coder Technologies, Inc. <https://coder.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .