Skip to content

Latest commit

 

History

History
277 lines (200 loc) · 8.54 KB

Usage_interactive.md

File metadata and controls

277 lines (200 loc) · 8.54 KB
Raw

Usage: Chaosctl (Interactive mode)

chaosctl Syntax

chaosctl has a syntax to use as follows:

chaosctl [command] [TYPE] [flags]
  • Command: refers to what you do want to perform (connect, create, get and config)
  • Type: refers to the feature type you are performing a command against (chaos-delegate, project etc.)
  • Flags: It takes some additional information for resource operations. For example, --installation-mode allows you to specify an installation mode.

chaosctl is using the .chaosconfig config file to manage multiple accounts

  1. If the --config flag is set, then only the given file is loaded. The flag may only be set once and no merging takes place.
  2. Otherwise, the ${HOME}/.chaosconfig file is used, and no merging takes place.

chaosctl supports both interactive and non-interactive(flag based) modes.

Only chaosctl connect chaos-delegate command needs --non-interactive flag, other commands don't need this flag to be in non-interactive mode. If mandatory flags aren't passed, then chaosctl takes input in an interactive mode.

Steps to connect to a chaos delegate

  • To setup an account with chaosctl
chaosctl config set-account

Next, you need to enter Harness Chaos Engineering Cloud/Harness Chaos Engineering Enterprise details to login into your account. Fields to be filled in:

What's the product name: Select the product name .

Example, https://preview.litmuschaos.io/

AccessID: What's the AccessID?:
AccessKey: What's the AccessKey?:

? What's the product name?:
  ▸ Harness Chaos Engineering Cloud
    Harness Chaos Engineering Enterprise

What's the AccessID?: Raj60163RjxQE
What's the AccessKey?: ***************

account.accessID/admin configured
  • To connect a chaos delegate in a cluster mode
chaosctl connect chaos-delegate

There will be a list of existing projects displayed on the terminal. Select the desired project by entering the sequence number indicated against it.

? Select a project from the list:
  ▸ Raj60163's project

Next, select the installation mode based on your requirement by entering the sequence number indicated against it.

It can install a chaos delegate in two different modes.

  • cluster mode: With this mode, the chaos delegate can run the chaos in any namespace. It installs appropriate cluster roles and cluster role bindings to achieve this mode.

  • namespace mode: With this mode, the chaos delegate can run the chaos in its namespace. It installs appropriate roles and role bindings to achieve this mode.

Note: With namespace mode, the user needs to create the namespace to install the chaos delegate as a prerequisite.

? What's the installation mode?:
  ▸ Cluster
    Namespace

🏃 Running prerequisites check....
🔑 clusterrole ✅
🔑 clusterrolebinding ✅
🌟 Sufficient permissions. Installing the Chaos Delegate...

Next, enter the details of the new chaos delegate.

Fields to be filled in

Field Description
Name: Enter a name of the chaos delegate which needs to be unique across the project
Description: Fill in details about the chaos delegate
Skip SSL verification Choose whether chaos delegate will skip SSL/TLS verification
Node Selector: To deploy the chaos delegate on a particular node based on the node selector labels
Platform Name: Enter the platform name on which this chaos delegate is hosted. For example, AWS, GCP, Rancher etc.
Enter the namespace: You can either enter an existing namespace or enter a new namespace. In cases where the namespace does not exist, chaosctl creates it for you
Enter service account: You can either enter an existing or new service account 
Enter the details of the chaos delegate
✔ What's the Chaos Delegate Name?: new-chaos-delegate

✔ Add your chaos delegate description: new-chaos-delegate

✔ Do you want Chaos Delegate to skip SSL/TLS check (Y/N) (Default: N): n

? Do you want NodeSelectors added to the chaos delegate deployments?:
    Yes
  ▸ No

? Do you want Tolerations added in the chaos delegate deployments??:
    Yes
  ▸ No

? What's your Kubernetes Platform?:
  ▸ Others
    AWS Elastic Kubernetes Service
    Google Kubernetes Service
    OpenShift
    Rancher

✔ Enter a new or existing namespace [Default: litmus ]: new-ns

✔ Enter a service account [Default: litmus ]:

Once, all these steps are implemented you will be able to see a summary of all the entered fields. After verification of these details, you can proceed with the connection of the chaos delegate by entering Y. The process of connection might take up to a few seconds.

Enter service account [Default: litmus]:

📌 Summary
Chaos Delegate Name: New-Chaos-Delegate
Chaos Delegate Description: This is a new chaos delegate
Platform Name: Others
Namespace:  litmus
Service Account:  litmus (new)
Installation Mode: cluster

? Do you want to continue with the above details?:
  ▸ Yes
    No

👍 Continuing chaos delegate connection!!
Applying YAML:
https://preview.litmuschaos.io/api/file/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbHVzdGVyX2lkIjoiMDUyZmFlN2UtZGM0MS00YmU4LWJiYTgtMmM4ZTYyNDFkN2I0In0.i31QQDG92X5nD6P_-7TfeAAarZqLvUTFfnAghJYXPiM.yaml

💡 Connecting chaos delegate to ChaosCenter.
🏃 Chaos Delegates are running!!

🚀 Chaos Delegate Connection Successful!! 🎉
👉 Litmus chaos delegates can be accessed here: https://cloud.chaosnative.com/delegates

Verify the new chaos delegate Connection**

To verify, if the connection process was successful you can view the list of connected chaos delegates from the Targets section on your ChaosCenter and ensure that the connected chaos delegate is in Active State.

Additional commands

  • To view the current configuration of .chaosconfig, type:
chaosctl config view

Output:

accounts:
- users:
  - expires_in: "1626897027"
    token: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjY4OTcwMjcsInJvbGUiOiJhZG1pbiIsInVpZCI6ImVlODZkYTljLTNmODAtNGRmMy04YzQyLTExNzlhODIzOTVhOSIsInVzZXJuYW1lIjoiYWRtaW4ifQ.O_hFcIhxP4rhyUN9NEVlQmWesoWlpgHpPFL58VbJHnhvJllP5_MNPbrRMKyFvzW3hANgXK2u8437u
    username: admin
  - expires_in: "1626944602"
    token: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjY5NDQ2MDIsInJvbGUiOiJ1c2VyIiwidWlkIjoiNjFmMDY4M2YtZWY0OC00MGE1LWIzMjgtZTU2ZDA2NjM1MTE4IiwidXNlcm5hbWUiOiJyYWoifQ.pks7xjkFdJD649RjCBwQuPF1_QMoryDWixSKx4tPAqXI75ns4sc-yGhMdbEvIZ3AJSvDaqTa47XTC6c8R
    username: litmus-user
  endpoint: https://preview.litmuschaos.io
apiVersion: v1
current-account: https://preview.litmuschaos.io
current-user: litmus-user
kind: Config
  • To get an overview of the accounts available within .chaosconfig, use the config get-accounts command:
chaosctl config get-accounts

Output:

CURRENT  ENDPOINT                         ACCESSID  EXPIRESIN
         https://preview.litmuschaos.io   admin     2021-07-22 01:20:27 +0530 IST
*        https://preview.litmuschaos.io   raj       2021-07-22 14:33:22 +0530 IST
  • To alter the current account use the use-account command:
chaosctl config use-account

? What's the product name?:
  ▸ Harness Chaos Engineering Cloud
    Harness Chaos Engineering Enterprise

What's the AccessID?: Raj60163RjxQE
  • To create a project, apply the following command :
chaosctl create project

Enter a project name: new
  • To view all the projects with the user, use the get projects command.
chaosctl get projects

Output:

PROJECT ID                                PROJECT NAME       CREATEDAT
50addd40-8767-448c-a91a-5071543a2d8e      Developer Project  2021-07-21 14:38:51 +0530 IST
7a4a259a-1ae5-4204-ae83-89a8838eaec3      DevOps Project     2021-07-21 14:39:14 +0530 IST
  • To get an overview of the chaos delegates available within a project, issue the following command.
chaosctl get chaos-delegates

Enter the Project ID: 50addd40-8767-448c-a91a-5071543a2d8e

Output:

CHAOS DELEGATE ID                                CHAOS DELEGATE NAME          STATUS
55ecc7f2-2754-43aa-8e12-6903e4c6183a   chaos-delegate-1            ACTIVE
13dsf3d1-5324-54af-4g23-5331g5v2364f   chaos-delegate-2            INACTIVE

For more information related to flags, Use chaosctl --help.