docs(agents|workflows): Update usage documentation #78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: PrayagS <prayagsavsani@gmail.com>
Signed-off-by: PrayagS <prayagsavsani@gmail.com>
Signed-off-by: PrayagS <prayagsavsani@gmail.com>
Signed-off-by: PrayagS <prayagsavsani@gmail.com>
PrayagS
requested review from
Jonsy13,
Saranya-jena and
SarthakJain26
as code owners
SarthakJain26
requested changes
Jun 9, 2022
Usage.md
Outdated
|
|
||
| * To disconnect an agent, issue the following command.. | ||
| ```shell | ||
| litmusctl disconnect agent f9799723-29f1-454c-b830-ae8ba7ee4c30 --project-id="" |
There was a problem hiding this comment.
Can you also add one more command displaying agent_id as a placeholder instead of the actual agent_id and use the current command as an example.
litmusctl disconnect agent <agent_id> --project-id="<project_id>"
| ``` | ||
|
|
||
|
|
||
| * To list the created workflows within a project, issue the following command. |
There was a problem hiding this comment.
Can you also add examples to display the usage of different flags to display workflows and workflow runs
Jonsy13
requested changes
Jun 14, 2022
Usage.md
Outdated
|
|
||
| * To describe a particular chaos workflow, issue the following command. | ||
| ```shell | ||
| litmusctl describe workflow 9433b48c-4ab7-4544-8dab-4a7237619e09 --project-id="" |
There was a problem hiding this comment.
can we also add command without actual workflowID, so that user knows what is - 9433b48c-4ab7-4544-8dab-4a7237619e09
Usage.md
Outdated
|
|
||
| * To delete a particular chaos workflow, issue the following command. | ||
| ```shell | ||
| litmusctl delete workflow df91c6b2-ad33-45ae-9a2f-00cb87978657 --project-id="" |
Usage_interactive.md
Outdated
|
|
||
| * To disconnect an agent, issue the following command.. | ||
| ```shell | ||
| litmusctl disconnect agent f9799723-29f1-454c-b830-ae8ba7ee4c30 --project-id="" |
Usage_interactive.md
Outdated
|
|
||
| * To describe a particular chaos workflow, issue the following command. | ||
| ```shell | ||
| litmusctl describe workflow 9433b48c-4ab7-4544-8dab-4a7237619e09 --project-id="" |
Usage_interactive.md
Outdated
|
|
||
| * To delete a particular chaos workflow, issue the following command. | ||
| ```shell | ||
| litmusctl delete workflow df91c6b2-ad33-45ae-9a2f-00cb87978657 --project-id="" |
Jonsy13
approved these changes
Jun 14, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the following changes in the usage documentation for litmusctl.
create agenttoconnect agent.REGISTRATIONfield inget agents.disconnect agentscommand under additional commands.create workflowcommand.get,delete, anddescribeunder additional commands.Signed-off-by: PrayagS prayagsavsani@gmail.com