diff --git a/website/docs/litmusctl/usage-interactive-mode.md b/website/docs/litmusctl/usage-interactive-mode.md index ae1782c9..2212f714 100644 --- a/website/docs/litmusctl/usage-interactive-mode.md +++ b/website/docs/litmusctl/usage-interactive-mode.md @@ -115,6 +115,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 +144,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 +170,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 +283,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 diff --git a/website/docs/litmusctl/usage-non-interactive-mode.md b/website/docs/litmusctl/usage-non-interactive-mode.md index a4d0eddb..f639d4b2 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: @@ -49,7 +49,7 @@ litmusctl config set-account --endpoint="" --username="" --password="" 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` @@ -64,6 +64,7 @@ To verify, if the connection process was successful you can view the list of con ### Flags for `create agent` command + @@ -80,6 +81,12 @@ To verify, if the connection process was successful you can view the list of con + + + + + + @@ -224,6 +231,7 @@ AGENTID AGENTNAME STATUS 13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE ``` + For more information related to flags, Use `litmusctl --help`. --- 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..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 @@ -115,6 +115,10 @@ Fields to be filled in
+ + + + @@ -140,6 +144,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 +170,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 +283,39 @@ AGENTID AGENTNAME STATUS 13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE ``` +## Flag details + +
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 Agent Description: Fill in details about the agent
Skip SSL verificationChoose whether agent will skip SSL/TLS verification
Node Selector: To deploy the agent on a particular node based on the node selector labels
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 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..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 @@ -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: @@ -49,7 +49,7 @@ litmusctl config set-account --endpoint="" --username="" --password="" 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` @@ -64,6 +64,7 @@ To verify, if the connection process was successful you can view the list of con ### Flags for `create agent` command + @@ -80,6 +81,12 @@ To verify, if the connection process was successful you can view the list of con + + + + + + @@ -224,6 +231,7 @@ AGENTID AGENTNAME STATUS 13dsf3d1-5324-54af-4g23-5331g5v2364f agent-2 INACTIVE ``` + For more information related to flags, Use `litmusctl --help`. ---
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