Coder Doctor is a command-line diagnostic tool for checking that a given platform can run the Coder control plane and workspaces.
Currently, the following platforms are supported, with the following preflight checks:
- Kubernetes Version: checks the cluster version for compatibility with the requested version of Coder.
- 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 Resosurces: checks that the cluster has the required resource types available to run Coder.
To check if your Kubernetes cluster is ready to install Coder, run:
coder-doctor check kubernetesFor more information, you can run:
coder-doctor -hWe love feedback! If you have any issues or suggestions, please feel free to submit an issue or pull request.
Note: This project is in alpha 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 the tool
enters beta state.
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/.