[Proposal] : Litmusctl Probe CRUD Commands (#4387)

* Adds litmusctl probe proposal Signed-off-by: nagesh bansal <[email protected]> * Adds implemantaions Signed-off-by: nagesh bansal <[email protected]> --------- Signed-off-by: nagesh bansal <[email protected]> Co-authored-by: Saranya Jena <[email protected]>
litmuschaos · Feb 15, 2024 · 77124b3 · 77124b3
1 parent 7e53059
commit 77124b3
Showing 1 changed file with 35 additions and 0 deletions.
diff --git a/proposals/litmusctl-probe.md b/proposals/litmusctl-probe.md
@@ -0,0 +1,35 @@
+| title | authors                                  | creation-date | last-updated |
+|-------|------------------------------------------|---------------|--------------|
+| Litmusctl Probe CRUD commmands | [@Nageshbansal](https://github.com/Nageshbansal) | 2024-01-04   | 2024-01-04|
+
+## Summary
+
+The Litmusctl probe commands can help developers create/list/delete the probes through the command line ( which can help them while they’re automating), as similar to chaos-center, a developer can save probes by going to the `Resilience Probe` tab.
+
+
+### Goals
+
+- Create, Describe, Delete, Update commands for Probe in Litmusctl
+- Make `save chaos-experiment` command to list and use the Probes
+
+## Proposal
+
+### Commands
+
+| Command       | Use Case |
+| :---          |     :---   | 
+| `save chaos-probe`  | The command allows to create a new probe,<br>specifying details such as type, name, timeout, <br>interval, retry, and polling interval.    |
+| `delete chaos-probe`  | The command allows developers to delete a probe<br> by providing its name.     |
+| `list chaos-probe`    |   It displays a list of existing probes <br> including their names, IDs, types, and references. |
+| `describe chaos-probe` | To view detailed information about a specific probe,<br> providing its ID.|
+
+### Implementation Details
+
+The proposal suggests leveraging chaos-center's Probe GraphQL APIs to implement Litmusctl probe commands. Detailed information about probe properties, such as timeout, interval, retry, polling interval, URL, and method, will be captured during creation and displayed during listing and describing.
+
+#### save chaos-probe command
+- A promptUI can be good choice to take user inputs for defining the probe
+- In case of Probes which requires too many inputs, user can just pass the yaml file having the probe configuration
+
+
+