From 7b2c18c67a46ddd7b9d8e50da1d317b9c079ee47 Mon Sep 17 00:00:00 2001 From: Soumya Ghosh Dastidar <44349253+gdsoumya@users.noreply.github.com> Date: Mon, 17 Jan 2022 13:00:49 +0530 Subject: [PATCH 1/5] Update usage-interactive-mode.md --- .../docs/litmusctl/usage-interactive-mode.md | 42 ++++++++++++++++++- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/website/docs/litmusctl/usage-interactive-mode.md b/website/docs/litmusctl/usage-interactive-mode.md index ae1782c9..e564583c 100644 --- a/website/docs/litmusctl/usage-interactive-mode.md +++ b/website/docs/litmusctl/usage-interactive-mode.md @@ -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. -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 @@ -115,6 +113,10 @@ Fields to be filled in
Agent Description: Fill in details about the agent + + Skip SSL verification + Choose whether agent will skip SSL/TLS verification + Node Selector: To deploy the agent on a particular node based on the node selector labels @@ -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: @@ -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) @@ -276,6 +281,39 @@ AGENTID AGENTNAME STATUS 13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE ``` +## Flag details + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagShort FlagTypeDescription
--cacertStringcustom ca certificate used by litmusctl for communicating with portal
--configStringconfig file (default is $HOME/.litmusctl)
--skipSSLBooleanlitmusctl will skip ssl/tls verification while communicating with portal
--help-hhelp for litmusctl
+ For more information related to flags, Use `litmusctl --help`. ## Learn More From 32aefae9e0b9d842ba8e5789fc9b82a68924f634 Mon Sep 17 00:00:00 2001 From: Soumya Ghosh Dastidar <44349253+gdsoumya@users.noreply.github.com> Date: Mon, 17 Jan 2022 13:03:21 +0530 Subject: [PATCH 2/5] Update usage-interactive-mode.md --- .../litmusctl/usage-interactive-mode.md | 42 ++++++++++++++++++- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md b/website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md index ae1782c9..e564583c 100644 --- a/website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md +++ b/website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md @@ -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. -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 @@ -115,6 +113,10 @@ Fields to be filled in
Agent Description: Fill in details about the agent + + Skip SSL verification + Choose whether agent will skip SSL/TLS verification + Node Selector: To deploy the agent on a particular node based on the node selector labels @@ -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: @@ -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) @@ -276,6 +281,39 @@ AGENTID AGENTNAME STATUS 13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE ``` +## Flag details + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagShort FlagTypeDescription
--cacertStringcustom ca certificate used by litmusctl for communicating with portal
--configStringconfig file (default is $HOME/.litmusctl)
--skipSSLBooleanlitmusctl will skip ssl/tls verification while communicating with portal
--help-hhelp for litmusctl
+ For more information related to flags, Use `litmusctl --help`. ## Learn More From 65465f41624e6628894c554aabcac7054a2910f5 Mon Sep 17 00:00:00 2001 From: Soumya Ghosh Dastidar <44349253+gdsoumya@users.noreply.github.com> Date: Mon, 17 Jan 2022 13:04:06 +0530 Subject: [PATCH 3/5] Update usage-non-interactive-mode.md --- .../litmusctl/usage-non-interactive-mode.md | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md b/website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md index a4d0eddb..dfff7ad2 100644 --- a/website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md +++ b/website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md @@ -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: @@ -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 >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` @@ -58,12 +58,9 @@ Or, litmusctl create agent --agent-name="" --project-id="" --non-interactive ``` -#### 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 + @@ -80,6 +77,12 @@ To verify, if the connection process was successful you can view the list of con + + + + + + @@ -108,7 +111,7 @@ To verify, if the connection process was successful you can view the list of con - + @@ -224,6 +227,7 @@ AGENTID AGENTNAME STATUS 13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE ``` + For more information related to flags, Use `litmusctl --help`. --- From bd7c34476a1d7894593080692d67c80c546b5a01 Mon Sep 17 00:00:00 2001 From: Soumya Ghosh Dastidar <44349253+gdsoumya@users.noreply.github.com> Date: Mon, 17 Jan 2022 13:04:18 +0530 Subject: [PATCH 4/5] Update usage-non-interactive-mode.md --- .../litmusctl/usage-non-interactive-mode.md | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/website/docs/litmusctl/usage-non-interactive-mode.md b/website/docs/litmusctl/usage-non-interactive-mode.md index a4d0eddb..dfff7ad2 100644 --- a/website/docs/litmusctl/usage-non-interactive-mode.md +++ b/website/docs/litmusctl/usage-non-interactive-mode.md @@ -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: @@ -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 >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` @@ -58,12 +58,9 @@ Or, litmusctl create agent --agent-name="" --project-id="" --non-interactive ``` -#### 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
Flag Short Flag TypeString Set the cluster-type to external for external agents | Supported=external/internal (default "external")
--skip-agent-sslBooleanSet whether agent will skip ssl/tls check (can be used for self-signed certs, if cert is not provided in portal) (default false)
--cluster-type --node-selector StringSet the node-selector for agent components | Format: key1=value1,key2=value2)Set the node-selector for agent components | Format: key1=value1,key2=value2)
--non-interactive
+ @@ -80,6 +77,12 @@ To verify, if the connection process was successful you can view the list of con + + + + + + @@ -108,7 +111,7 @@ To verify, if the connection process was successful you can view the list of con - + @@ -224,6 +227,7 @@ AGENTID AGENTNAME STATUS 13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE ``` + For more information related to flags, Use `litmusctl --help`. --- From e38b77af477ef636616aeb8b9b3eed80d9e5ef8d Mon Sep 17 00:00:00 2001 From: Soumya Ghosh Dastidar <44349253+gdsoumya@users.noreply.github.com> Date: Mon, 17 Jan 2022 13:09:25 +0530 Subject: [PATCH 5/5] Apply suggestions from code review --- website/docs/litmusctl/usage-interactive-mode.md | 2 ++ website/docs/litmusctl/usage-non-interactive-mode.md | 8 ++++++-- .../version-2.5.0/litmusctl/usage-interactive-mode.md | 2 ++ .../version-2.5.0/litmusctl/usage-non-interactive-mode.md | 8 ++++++-- 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/website/docs/litmusctl/usage-interactive-mode.md b/website/docs/litmusctl/usage-interactive-mode.md index e564583c..2212f714 100644 --- a/website/docs/litmusctl/usage-interactive-mode.md +++ b/website/docs/litmusctl/usage-interactive-mode.md @@ -34,6 +34,8 @@ 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. +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 diff --git a/website/docs/litmusctl/usage-non-interactive-mode.md b/website/docs/litmusctl/usage-non-interactive-mode.md index dfff7ad2..f639d4b2 100644 --- a/website/docs/litmusctl/usage-non-interactive-mode.md +++ b/website/docs/litmusctl/usage-non-interactive-mode.md @@ -43,7 +43,7 @@ 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 +* To create an agent without a project in a cluster mode >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 @@ -58,6 +58,10 @@ litmusctl create agent --agent-name="" --non-interactive litmusctl create agent --agent-name="" --project-id="" --non-interactive ``` +#### 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
Flag Short Flag TypeString Set the cluster-type to external for external agents | Supported=external/internal (default "external")
--skip-agent-sslBooleanSet whether agent will skip ssl/tls check (can be used for self-signed certs, if cert is not provided in portal) (default false)
--cluster-type --node-selector StringSet the node-selector for agent components | Format: key1=value1,key2=value2)Set the node-selector for agent components | Format: key1=value1,key2=value2)
--non-interactive
@@ -111,7 +115,7 @@ litmusctl create agent --agent-name="" --project-id="" --non-interactive - diff --git a/website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md b/website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md index e564583c..2212f714 100644 --- a/website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md +++ b/website/versioned_docs/version-2.5.0/litmusctl/usage-interactive-mode.md @@ -34,6 +34,8 @@ 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. +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 diff --git a/website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md b/website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md index dfff7ad2..f639d4b2 100644 --- a/website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md +++ b/website/versioned_docs/version-2.5.0/litmusctl/usage-non-interactive-mode.md @@ -43,7 +43,7 @@ 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 +* To create an agent without a project in a cluster mode >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 @@ -58,6 +58,10 @@ litmusctl create agent --agent-name="" --non-interactive litmusctl create agent --agent-name="" --project-id="" --non-interactive ``` +#### 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
--node-selector StringSet the node-selector for agent components | Format: key1=value1,key2=value2) + Set the node-selector for agent components | Format: key1=value1,key2=value2)
--non-interactive
@@ -111,7 +115,7 @@ litmusctl create agent --agent-name="" --project-id="" --non-interactive -
--node-selector StringSet the node-selector for agent components | Format: key1=value1,key2=value2) + Set the node-selector for agent components | Format: key1=value1,key2=value2)
--non-interactive