litmuschaos
/
litmus
mirror of https://github.com/litmuschaos/litmus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

* Adds litmusctl probe proposal

Signed-off-by: nagesh bansal <nageshbansal59@gmail.com>

* Adds implemantaions

Signed-off-by: nagesh bansal <nageshbansal59@gmail.com>

---------

Signed-off-by: nagesh bansal <nageshbansal59@gmail.com>
Co-authored-by: Saranya Jena <saranya.jena@harness.io>
This commit is contained in:
Nageshbansal 2024-02-15 14:50:58 +05:30 committed by GitHub
parent 7e530592df
commit 77124b385a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
proposals/litmusctl-probe.md Normal file
View File

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