README
¶
ChaosCTL
The command-line tool, chaosctl, allows you to manage chaos delegate plane. You can use chaosctl to create chaos delegates, project, and manage multiple accounts.
Usage
- For more information including a complete list of chaosctl operations, see the chaosctl reference documentation.
- Non-Interactive mode: Click here
- Interactive mode: Click here
Requirements
The chaosctl CLI requires the following things:
- kubeconfig - chaosctl needs the kubeconfig of the k8s cluster where we need to connect chaos delegates. The CLI currently uses the default path of kubeconfig i.e.
~/.kube/config. - kubectl- chaosctl is using kubectl under the hood to apply the manifest. To install kubectl, follow: kubectl
Compatibility matrix
To check compatibility of chaosctl with products
| Chaosctl version | HCE Onprem | HCE SaaS |
|---|---|---|
| 0.2.0 | 2.8.0 | Not supported |
| 0.3.1 | Not supported | Supported |
| 0.4.0 | 2.11.0 and above | Not supported |
Installation
To install the latest version of chaosctl follow the below steps:
| Platforms | main(Unreleased) | v0.2.0 | v0.3.1 | v0.4.0 |
|---|---|---|---|---|
| chaosctl-darwin-amd64 (MacOS) | Click here | Click here | Click here | Click here |
| chaosctl-linux-386 | Click here | Click here | Click here | Click here |
| chaosctl-linux-amd64 | Click here | Click here | Click here | Click here |
| chaosctl-linux-arm | Click here | Click here | Click here | Click here |
| chaosctl-linux-arm64 | Click here | Click here | Click here | Click here |
| chaosctl-windows-386 | Click here | Click here | Click here | Click here |
| chaosctl-windows-amd64 | Click here | Click here | Click here | Click here |
| chaosctl-windows-arm | Click here | Click here | Click here | Click here |
Linux/MacOS
- Extract the binary
tar -zxvf chaosctl-<OS>-<ARCH>-<VERSION>.tar.gz
- Provide necessary permissions
chmod +x chaosctl
- Move the chaosctl binary to /usr/local/bin/chaosctl. Note: Make sure to use root user or use sudo as a prefix
mv chaosctl /usr/local/bin/chaosctl
- You can run the chaosctl command in Linux/macOS:
chaosctl <command> <subcommand> <subcommand> [options and parameters]
Windows
-
Extract the binary from the zip using WinZip or any other extraction tool.
-
You can run the chaosctl command in windows:
chaosctl.exe <command> <subcommand> <subcommand> [options and parameters]
- To check the version of the chaosctl:
chaosctl version
Documentation
¶
Overview ¶
Copyright © 2021 The LitmusChaos Authors
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories