coder-doctor

Coder Doctor 🧑‍⚕️

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:

1. Click a release and download the tar file for your operating system (ex: coder-doctor-linux-amd64.tar.gz)
2. (Optional, recommended) Download the checksums.txt for the desired release and verify the sha256 checksum of the file you downloaded.
3. Extract the coder-doctor binary.
4. Move the coder-doctor binary to somewhere in your $PATH (e.g., mv coder-doctor /usr/local/bin/coder-doctor for macOS/Linux).
5. (macOS Users) You may need to grant coder-doctor additional permissions before running.

Alternatively, use the below command, replacing $VERSION, $OSTYPE (one of darwin, linux, windows) and $ARCH (one of amd64, arm64) as required:

$ curl -fSsL "https://github.com/cdr/coder-doctor/releases/latest/download/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:

coder-doctor check kubernetes

For more information, you can run:

coder-doctor -h

Development

To run from source, clone the repository and run:

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.

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 https://www.gnu.org/licenses/.