Skip to content

Commit e38b77a

Browse files
authored
Apply suggestions from code review
1 parent bd7c344 commit e38b77a

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

website/docs/litmusctl/usage-interactive-mode.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Litmusctl supports both interactive and non-interactive(flag based) modes.
3434

3535
> Only `litmusctl create agent` 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 litmusctl takes input in an interactive mode.
3636
37+
Multiple external ChaosAgents can be connected to the ChaosCenter with the help of the command line utility [litmusctl](installation.md)
38+
3739
### Steps to create an agent
3840

3941
- To setup an account with litmusctl

website/docs/litmusctl/usage-non-interactive-mode.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Note: With namespace mode, the user needs to create the namespace to install the
4343
litmusctl config set-account --endpoint="" --username="" --password=""
4444
```
4545

46-
* To create an agent without a project
46+
* To create an agent without a project in a cluster mode
4747
>Note: If the user doesn't have any project, it will create a random project and add the agent in that random project.
4848
```shell
4949
litmusctl create agent --agent-name="" --non-interactive
@@ -58,6 +58,10 @@ litmusctl create agent --agent-name="" --non-interactive
5858
litmusctl create agent --agent-name="" --project-id="" --non-interactive
5959
```
6060

61+
#### Verify the new Agent Connection
62+
63+
To verify, if the connection process was successful you can view the list of connected agents from the Targets section on your ChaosCenter and ensure that the connected agent is in Active State.
64+
6165
### Flags for `create agent` command
6266
<table>
6367
<tr>
@@ -111,7 +115,7 @@ litmusctl create agent --agent-name="" --project-id="" --non-interactive
111115
<td>--node-selector</td>
112116
<td></td>
113117
<td>String</td>
114-
<td>Set the node-selector for agent components | Format: key1=value1,key2=value2)
118+
<td>Set the node-selector for agent components | Format: key1=value1,key2=value2)</td>
115119
</tr>
116120
<tr>
117121
<td>--non-interactive</td>

website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Litmusctl supports both interactive and non-interactive(flag based) modes.
3434

3535
> Only `litmusctl create agent` 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 litmusctl takes input in an interactive mode.
3636
37+
Multiple external ChaosAgents can be connected to the ChaosCenter with the help of the command line utility [litmusctl](installation.md)
38+
3739
### Steps to create an agent
3840

3941
- To setup an account with litmusctl

website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Note: With namespace mode, the user needs to create the namespace to install the
4343
litmusctl config set-account --endpoint="" --username="" --password=""
4444
```
4545

46-
* To create an agent without a project
46+
* To create an agent without a project in a cluster mode
4747
>Note: If the user doesn't have any project, it will create a random project and add the agent in that random project.
4848
```shell
4949
litmusctl create agent --agent-name="" --non-interactive
@@ -58,6 +58,10 @@ litmusctl create agent --agent-name="" --non-interactive
5858
litmusctl create agent --agent-name="" --project-id="" --non-interactive
5959
```
6060

61+
#### Verify the new Agent Connection
62+
63+
To verify, if the connection process was successful you can view the list of connected agents from the Targets section on your ChaosCenter and ensure that the connected agent is in Active State.
64+
6165
### Flags for `create agent` command
6266
<table>
6367
<tr>
@@ -111,7 +115,7 @@ litmusctl create agent --agent-name="" --project-id="" --non-interactive
111115
<td>--node-selector</td>
112116
<td></td>
113117
<td>String</td>
114-
<td>Set the node-selector for agent components | Format: key1=value1,key2=value2)
118+
<td>Set the node-selector for agent components | Format: key1=value1,key2=value2)</td>
115119
</tr>
116120
<tr>
117121
<td>--non-interactive</td>

0 commit comments

Comments
 (0)