CHAOS-5921 Revamped resilience probes #7224

SmritiSatya · 2024-06-28T09:19:31Z

Revamp resilience probes:

Unify legacy and resilience probes.
Add notes about existing customer seeing old version of probes and new customers seeing new version of probes.
Remove "probe acceptance criteria" page and add its contents in other relevant locations.
Remove old content.

bot-gitexp-user · 2024-06-28T10:24:56Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://667e8ef4fc8ca00706714cfc--harness-developer.netlify.app

brian-r-fisher

looks good, added a few suggestions for you to consider

brian-r-fisher · 2024-06-28T13:13:06Z

docs/chaos-engineering/features/resilience-probes/overview.md

+sidebar_position: 1
+description: Resilience probes, their importance and types
+---
+This section introduces you to resilience probes, its importance, types, and generic properties.


Suggested change

This section introduces you to resilience probes, its importance, types, and generic properties.

This topic introduces you to resilience probes, their importance, types, and generic properties.

brian-r-fisher · 2024-06-28T13:14:11Z

docs/chaos-engineering/features/resilience-probes/overview.md

+
+## What is a resilience probe?
+
+Resilience probes (or probes) are pluggable health-checkers defined within the chaos engine for any chaos experiment.


Suggested change

Resilience probes (or probes) are pluggable health-checkers defined within the chaos engine for any chaos experiment.

Resilience probes (or probes) are pluggable health checkers defined within the chaos engine for any chaos experiment. Resilience probes do the following:

brian-r-fisher · 2024-06-28T13:14:30Z

docs/chaos-engineering/features/resilience-probes/overview.md

+## What is a resilience probe?
+
+Resilience probes (or probes) are pluggable health-checkers defined within the chaos engine for any chaos experiment.
+- It monitors your application's health **before**, **during** and **after** a chaos experiment.


Suggested change

- It monitors your application's health **before**, **during** and **after** a chaos experiment.

- Monitor your application's health **before**, **during**, and **after** a chaos experiment.

brian-r-fisher · 2024-06-28T13:14:54Z

docs/chaos-engineering/features/resilience-probes/overview.md

+
+Resilience probes (or probes) are pluggable health-checkers defined within the chaos engine for any chaos experiment.
+- It monitors your application's health **before**, **during** and **after** a chaos experiment.
+- It explores the behavior of a system in a chaotic or unpredictable manner.


Suggested change

- It explores the behavior of a system in a chaotic or unpredictable manner.

- Explore the behavior of a system in a chaotic or unpredictable manner.

brian-r-fisher · 2024-06-28T13:15:36Z

docs/chaos-engineering/features/resilience-probes/overview.md

+Resilience probes (or probes) are pluggable health-checkers defined within the chaos engine for any chaos experiment.
+- It monitors your application's health **before**, **during** and **after** a chaos experiment.
+- It explores the behavior of a system in a chaotic or unpredictable manner.
+- It helps understand the underlying patterns and laws that govern the behavior of these systems, and to use that understanding to predict or control their behavior.


Suggested change

- It helps understand the underlying patterns and laws that govern the behavior of these systems, and to use that understanding to predict or control their behavior.

- Help understand the underlying patterns and laws that govern the behavior of systems, and use that understanding to predict or control their behavior.

brian-r-fisher · 2024-06-28T13:37:01Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

+## Default/System resilience probes
+
+- You can create system (default probes) at the project level **only once**.
+- Once you create a default probe, you can't delete or disable or update it.


Suggested change

- Once you create a default probe, you can't delete or disable or update it.

- Once you create a default probe, you can't delete, disable, or update it.

brian-r-fisher · 2024-06-28T13:37:15Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

+
+- You can create system (default probes) at the project level **only once**.
+- Once you create a default probe, you can't delete or disable or update it.
+- If you have more than one resilience probe in your chaos experiment, you can disable, delete or update the system probe.


Suggested change

- If you have more than one resilience probe in your chaos experiment, you can disable, delete or update the system probe.

- If you have more than one resilience probe in your chaos experiment, you can disable, delete, or update the system probe.

brian-r-fisher · 2024-06-28T13:37:33Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

+- Default probes are a part of resilience probes and are entered as annotations in the experiment manifest.
+
+## Image registry support
+- You can configure the image registry to be used with the default probes. If you haven't configured a probe yet, the experiment will use default image registry.


Suggested change

- You can configure the image registry to be used with the default probes. If you haven't configured a probe yet, the experiment will use default image registry.

- You can configure the image registry to be used with the default probes. If you haven't configured a probe yet, the experiment will use the default image registry.

brian-r-fisher · 2024-06-28T13:38:09Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

+
+## Image registry support
+- You can configure the image registry to be used with the default probes. If you haven't configured a probe yet, the experiment will use default image registry.
+- HCE doesn't provide image registry support at the moment for default probes.


Suggested change

- HCE doesn't provide image registry support at the moment for default probes.

- HCE doesn't currently provide image registry support for default probes.

brian-r-fisher · 2024-06-28T13:38:54Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

+
+## License
+
+- Resilience probes are not a part of any subscription, and hence you don't have any limit on the number of probes you can create. With respect to usability, 1,000 probes can be executed in a month.


Suggested change

- Resilience probes are not a part of any subscription, and hence you don't have any limit on the number of probes you can create. With respect to usability, 1,000 probes can be executed in a month.

- Resilience probes are not a part of any subscription, and hence you don't have any limit on the number of probes you can create. Concerning usability, 1,000 probes can be executed in a month.

S-ayanide · 2024-07-01T07:08:41Z

docs/chaos-engineering/features/resilience-probes/cmd-probe/cmd-probe-usage.md

+## Known limitations of resilience probes
+
+* Command probes in the **source** mode for Kubernetes is available for both SMP and HCE SAAS.


Can you check the wording for this? Source mode in CMD resilience probe is only not available for Linux in SaaS

S-ayanide · 2024-07-01T07:10:54Z

docs/chaos-engineering/features/resilience-probes/overview.md

+|----------------------|------------------------------------------|------------------------------------|
+| probeTimeout         | Yes                                      | string with +d[ms][s][m][h] format |
+| interval             | Yes                                      | string with +d[ms][s][m][h] format |
+| retry                | Only available for Kubernetes (optional) |                                    |


Let's remove this since we're not advocating the use of this for Resilience Probe, its only present for backwards compatibility

S-ayanide · 2024-07-01T07:13:46Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

+- Go to [chaos faults](/docs/chaos-engineering/chaos-faults) to understand where probes are used.
+- You should have an active chaos infrastructure where you can schedule the chaos experiment.
+- Enterprise Hub connectivity status should be active
+- Read/write access to the chaos experiment to schedule or navigate to the probe addition UI.
+- Read access to the chaos infrastructure to select a chaos infrastructure when creating an experiment.
+- Read access to the chaos hub to select faults from the chaos hub while creating an experiment.


Can we check these prerequisites again! To configure a probe we only require the chaos experiment edit permission. It has no direct relation with hub, infra, or faults at all.

S-ayanide · 2024-07-01T07:14:55Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

@@ -41,7 +58,7 @@ This section describes steps you can follow to create and use a resilience probe
  ![setup](./static/use-probe/setup-6.png)

 :::tip
-If you are a first time user, you can create a resilience probe directly from Chaos Studio drawer (from within an experiment). For this, you will see an option to add a system probe (which is a health check system probe) as a one click button. This will not be present if you have configured atleast one resilience probe. 
+If you are a first time user, you can create a resilience probe directly from Chaos Studio drawer (from within an experiment). For this, you will see an option to add a system probe (which is a health check system probe) as a one click button. This will not be present if you have configured atleast one resilience probe.


Not just for first time users, but for users who are using the platform but haven't created any resilience probes yet.

S-ayanide · 2024-07-01T07:16:12Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

+When you wish to enter the probe name in the manifest (manually) as a probeRef annotation, follow the below format:
+
+```
+probeRef: '[{"name":"probe-name","mode":"SOT"}]'


name has been updated with probeID

S-ayanide · 2024-07-01T07:16:58Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

+```
+probeRef: '[{"name":"probe-name","mode":"SOT"}]'
+```
+Here, `probe-name` is the name of your probe.


This should be the ID instead

S-ayanide · 2024-07-01T07:17:33Z

docs/chaos-engineering/features/resilience-probes/use-probe.md

+
+:::info notes
+- **Legacy probes support (Backward compatibility)***: Users can still use [legacy probes](/docs/chaos-engineering/features/resilience-probes/cmd-probe).
+- **Audit integration**: There are no audit events for resilience probes.


There are audit integrations for resilience probes

bot-gitexp-user · 2024-07-01T07:21:39Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://66825881f102c1ea23c4e00f--harness-developer.netlify.app

bot-gitexp-user · 2024-07-01T07:50:54Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://66825f5be36167c3511494a3--harness-developer.netlify.app

bot-gitexp-user · 2024-07-01T10:19:31Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://6682822ff2cf5a06e471a9f5--harness-developer.netlify.app

bot-gitexp-user · 2024-07-01T13:16:10Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://6682ab960473b71432101392--harness-developer.netlify.app

Revamped resilience probes

1fe32d5

SmritiSatya self-assigned this Jun 28, 2024

SmritiSatya requested review from neelanjan00, ravilach and wei-harness as code owners June 28, 2024 09:19

Fix build error

0611d65

SmritiSatya added Content - chore/cleanup Content flag: Cleanup or edits on previously published content DO NOT MERGE PR is not ready to be merged. Review - Editorial Needs style/editorial review from docs council Review - PM Needs review from PM labels Jun 28, 2024

brian-r-fisher previously approved these changes Jun 28, 2024

View reviewed changes

Peer review

08fff08

SmritiSatya dismissed brian-r-fisher’s stale review via 08fff08 July 1, 2024 07:07

S-ayanide reviewed Jul 1, 2024

View reviewed changes

Tech review

84c3be4

Update use-probe.md

0bff500

Update cmd-probe-usage.md

f2de890

SmritiSatya merged commit 6ca6e01 into main Jul 1, 2024
2 checks passed

SmritiSatya deleted the CHAOS-5921 branch July 1, 2024 17:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CHAOS-5921 Revamped resilience probes #7224

CHAOS-5921 Revamped resilience probes #7224

SmritiSatya commented Jun 28, 2024

bot-gitexp-user commented Jun 28, 2024

brian-r-fisher left a comment

brian-r-fisher Jun 28, 2024

brian-r-fisher Jun 28, 2024

brian-r-fisher Jun 28, 2024

brian-r-fisher Jun 28, 2024

brian-r-fisher Jun 28, 2024

brian-r-fisher Jun 28, 2024

brian-r-fisher Jun 28, 2024

brian-r-fisher Jun 28, 2024

brian-r-fisher Jun 28, 2024

brian-r-fisher Jun 28, 2024

S-ayanide Jul 1, 2024

S-ayanide Jul 1, 2024

S-ayanide Jul 1, 2024

S-ayanide Jul 1, 2024

S-ayanide Jul 1, 2024

S-ayanide Jul 1, 2024

S-ayanide Jul 1, 2024

bot-gitexp-user commented Jul 1, 2024

bot-gitexp-user commented Jul 1, 2024

bot-gitexp-user commented Jul 1, 2024

bot-gitexp-user commented Jul 1, 2024

	This section introduces you to resilience probes, its importance, types, and generic properties.
	This topic introduces you to resilience probes, their importance, types, and generic properties.


		## What is a resilience probe?

		Resilience probes (or probes) are pluggable health-checkers defined within the chaos engine for any chaos experiment.

	- It monitors your application's health before, during and after a chaos experiment.
	- Monitor your application's health before, during, and after a chaos experiment.

	- It explores the behavior of a system in a chaotic or unpredictable manner.
	- Explore the behavior of a system in a chaotic or unpredictable manner.

	- It helps understand the underlying patterns and laws that govern the behavior of these systems, and to use that understanding to predict or control their behavior.
	- Help understand the underlying patterns and laws that govern the behavior of systems, and use that understanding to predict or control their behavior.

	- Once you create a default probe, you can't delete or disable or update it.
	- Once you create a default probe, you can't delete, disable, or update it.

	- If you have more than one resilience probe in your chaos experiment, you can disable, delete or update the system probe.
	- If you have more than one resilience probe in your chaos experiment, you can disable, delete, or update the system probe.

	- You can configure the image registry to be used with the default probes. If you haven't configured a probe yet, the experiment will use default image registry.
	- You can configure the image registry to be used with the default probes. If you haven't configured a probe yet, the experiment will use the default image registry.

	- HCE doesn't provide image registry support at the moment for default probes.
	- HCE doesn't currently provide image registry support for default probes.


		## License

		- Resilience probes are not a part of any subscription, and hence you don't have any limit on the number of probes you can create. With respect to usability, 1,000 probes can be executed in a month.

		## Known limitations of resilience probes

		* Command probes in the source mode for Kubernetes is available for both SMP and HCE SAAS.

CHAOS-5921 Revamped resilience probes #7224

CHAOS-5921 Revamped resilience probes #7224

Conversation

SmritiSatya commented Jun 28, 2024

bot-gitexp-user commented Jun 28, 2024

brian-r-fisher left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bot-gitexp-user commented Jul 1, 2024

bot-gitexp-user commented Jul 1, 2024

bot-gitexp-user commented Jul 1, 2024

bot-gitexp-user commented Jul 1, 2024