Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update usage-interactive-mode.md #163

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update usage-interactive-mode.md #163

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7b2c18c
Update usage-interactive-mode.md
gdsoumya Jan 17, 2022
32aefae
Update usage-interactive-mode.md
gdsoumya Jan 17, 2022
65465f4
Update usage-non-interactive-mode.md
gdsoumya Jan 17, 2022
bd7c344
Update usage-non-interactive-mode.md
gdsoumya Jan 17, 2022
e38b77a
Apply suggestions from code review
gdsoumya Jan 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 40 additions & 2 deletions website/docs/litmusctl/usage-interactive-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ Litmusctl supports both interactive and non-interactive(flag based) modes.

> 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.

gdsoumya marked this conversation as resolved.
Show resolved Hide resolved
Multiple external ChaosAgents can be connected to the ChaosCenter with the help of the command line utility [litmusctl](installation.md)

### Steps to create an agent

- To setup an account with litmusctl
Expand Down Expand Up @@ -115,6 +113,10 @@ Fields to be filled in <br />
<td>Agent Description:</td>
<td>Fill in details about the agent</td>
</tr>
<tr>
<td>Skip SSL verification</td>
<td>Choose whether agent will skip SSL/TLS verification</td>
</tr>
<tr>
<td>Node Selector:</td>
<td>To deploy the agent on a particular node based on the node selector labels</td>
Expand All @@ -140,6 +142,8 @@ Agent Name: New-Agent

Agent Description: This is a new agent

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

Do you want NodeSelector to be added in the agent deployments (Y/N) (Default: N): N

Platform List:
Expand All @@ -164,6 +168,7 @@ Enter service account [Default: litmus]:
📌 Summary
Agent Name: New-Agent
Agent Description: This is a new agent
Agent SSL/TLS Skip: false
Platform Name: Others
Namespace: litmus
Service Account: litmus (new)
Expand Down Expand Up @@ -276,6 +281,39 @@ AGENTID AGENTNAME STATUS
13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE
```

## Flag details

<table>
<th>Flag</th>
<th>Short Flag</th>
<th>Type</th>
<th>Description</th>
<tr>
<td>--cacert</td>
<td></td>
<td>String</td>
<td>custom ca certificate used by litmusctl for communicating with portal</td>
</tr>
<tr>
<td>--config</td>
<td></td>
<td>String</td>
<td>config file (default is $HOME/.litmusctl)</td>
</tr>
<tr>
<td>--skipSSL</td>
<td></td>
<td>Boolean</td>
<td>litmusctl will skip ssl/tls verification while communicating with portal</td>
</tr>
<tr>
<td>--help</td>
<td>-h</td>
<td></td>
<td>help for litmusctl</td>
</tr>
</table>

For more information related to flags, Use `litmusctl --help`.

## Learn More
Expand Down
20 changes: 12 additions & 8 deletions website/docs/litmusctl/usage-non-interactive-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_label: Using non interactive mode
# Usage: Litmusctl v0.3.0
> Notes:
> * For litmusctl v0.3.0 or latest
> * Compatible with Litmus 2.0.0 or latest
> * Compatible with Litmus 2.0.0-Beta9 or latest

### litmusctl Syntax
`litmusctl` has a syntax to use as follows:
Expand Down Expand Up @@ -43,13 +43,13 @@ Note: With namespace mode, the user needs to create the namespace to install the
litmusctl config set-account --endpoint="" --username="" --password=""
```

* To create an agent without a project in a cluster mode
* To create an agent without a project
gdsoumya marked this conversation as resolved.
Show resolved Hide resolved
>Note: If the user doesn't have any project, it will create a random project and add the agent in that random project.
```shell
litmusctl create agent --agent-name="" --non-interactive
```

Or,
### Or,

* To create an agent with an existing project
> Note: To get `project-id`. Apply `litmusctl get projects`
Expand All @@ -58,12 +58,9 @@ Or,
litmusctl create agent --agent-name="" --project-id="" --non-interactive
```

gdsoumya marked this conversation as resolved.
Show resolved Hide resolved
#### Verify the new Agent Connection

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.

### Flags for `create agent` command
<table>
<tr>
<th>Flag</th>
<th>Short Flag</th>
<th>Type</th>
Expand All @@ -80,6 +77,12 @@ To verify, if the connection process was successful you can view the list of con
<td>String</td>
<td>Set the cluster-type to external for external agents | Supported=external/internal (default "external")</td>
</tr>
<tr>
<td>--skip-agent-ssl</td>
<td></td>
<td>Boolean</td>
<td>Set whether agent will skip ssl/tls check (can be used for self-signed certs, if cert is not provided in portal) (default false)</td>
</tr>
<tr>
<td>--cluster-type</td>
<td></td>
Expand Down Expand Up @@ -108,7 +111,7 @@ To verify, if the connection process was successful you can view the list of con
<td>--node-selector</td>
<td></td>
<td>String</td>
<td>Set the node-selector for agent components | Format: key1=value1,key2=value2)</td>
<td>Set the node-selector for agent components | Format: key1=value1,key2=value2)
gdsoumya marked this conversation as resolved.
Show resolved Hide resolved
</tr>
<tr>
<td>--non-interactive</td>
Expand Down Expand Up @@ -224,6 +227,7 @@ AGENTID AGENTNAME STATUS
13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE
```


For more information related to flags, Use `litmusctl --help`.

---
Expand Down
42 changes: 40 additions & 2 deletions website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ Litmusctl supports both interactive and non-interactive(flag based) modes.

> 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.

gdsoumya marked this conversation as resolved.
Show resolved Hide resolved
Multiple external ChaosAgents can be connected to the ChaosCenter with the help of the command line utility [litmusctl](installation.md)

### Steps to create an agent

- To setup an account with litmusctl
Expand Down Expand Up @@ -115,6 +113,10 @@ Fields to be filled in <br />
<td>Agent Description:</td>
<td>Fill in details about the agent</td>
</tr>
<tr>
<td>Skip SSL verification</td>
<td>Choose whether agent will skip SSL/TLS verification</td>
</tr>
<tr>
<td>Node Selector:</td>
<td>To deploy the agent on a particular node based on the node selector labels</td>
Expand All @@ -140,6 +142,8 @@ Agent Name: New-Agent

Agent Description: This is a new agent

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

Do you want NodeSelector to be added in the agent deployments (Y/N) (Default: N): N

Platform List:
Expand All @@ -164,6 +168,7 @@ Enter service account [Default: litmus]:
📌 Summary
Agent Name: New-Agent
Agent Description: This is a new agent
Agent SSL/TLS Skip: false
Platform Name: Others
Namespace: litmus
Service Account: litmus (new)
Expand Down Expand Up @@ -276,6 +281,39 @@ AGENTID AGENTNAME STATUS
13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE
```

## Flag details

<table>
<th>Flag</th>
<th>Short Flag</th>
<th>Type</th>
<th>Description</th>
<tr>
<td>--cacert</td>
<td></td>
<td>String</td>
<td>custom ca certificate used by litmusctl for communicating with portal</td>
</tr>
<tr>
<td>--config</td>
<td></td>
<td>String</td>
<td>config file (default is $HOME/.litmusctl)</td>
</tr>
<tr>
<td>--skipSSL</td>
<td></td>
<td>Boolean</td>
<td>litmusctl will skip ssl/tls verification while communicating with portal</td>
</tr>
<tr>
<td>--help</td>
<td>-h</td>
<td></td>
<td>help for litmusctl</td>
</tr>
</table>

For more information related to flags, Use `litmusctl --help`.

## Learn More
Expand Down
20 changes: 12 additions & 8 deletions website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_label: Using non interactive mode
# Usage: Litmusctl v0.3.0
> Notes:
> * For litmusctl v0.3.0 or latest
> * Compatible with Litmus 2.0.0 or latest
> * Compatible with Litmus 2.0.0-Beta9 or latest

### litmusctl Syntax
`litmusctl` has a syntax to use as follows:
Expand Down Expand Up @@ -43,13 +43,13 @@ Note: With namespace mode, the user needs to create the namespace to install the
litmusctl config set-account --endpoint="" --username="" --password=""
```

* To create an agent without a project in a cluster mode
* To create an agent without a project
gdsoumya marked this conversation as resolved.
Show resolved Hide resolved
>Note: If the user doesn't have any project, it will create a random project and add the agent in that random project.
```shell
litmusctl create agent --agent-name="" --non-interactive
```

Or,
### Or,

* To create an agent with an existing project
> Note: To get `project-id`. Apply `litmusctl get projects`
Expand All @@ -58,12 +58,9 @@ Or,
litmusctl create agent --agent-name="" --project-id="" --non-interactive
```

gdsoumya marked this conversation as resolved.
Show resolved Hide resolved
#### Verify the new Agent Connection

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.

### Flags for `create agent` command
<table>
<tr>
<th>Flag</th>
<th>Short Flag</th>
<th>Type</th>
Expand All @@ -80,6 +77,12 @@ To verify, if the connection process was successful you can view the list of con
<td>String</td>
<td>Set the cluster-type to external for external agents | Supported=external/internal (default "external")</td>
</tr>
<tr>
<td>--skip-agent-ssl</td>
<td></td>
<td>Boolean</td>
<td>Set whether agent will skip ssl/tls check (can be used for self-signed certs, if cert is not provided in portal) (default false)</td>
</tr>
<tr>
<td>--cluster-type</td>
<td></td>
Expand Down Expand Up @@ -108,7 +111,7 @@ To verify, if the connection process was successful you can view the list of con
<td>--node-selector</td>
<td></td>
<td>String</td>
<td>Set the node-selector for agent components | Format: key1=value1,key2=value2)</td>
<td>Set the node-selector for agent components | Format: key1=value1,key2=value2)
gdsoumya marked this conversation as resolved.
Show resolved Hide resolved
</tr>
<tr>
<td>--non-interactive</td>
Expand Down Expand Up @@ -224,6 +227,7 @@ AGENTID AGENTNAME STATUS
13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE
```


For more information related to flags, Use `litmusctl --help`.

---
Expand Down