[DOC-2814] Bugs Bash [WIP] #1103
Merged
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
Typo Sentence case Chaos Hub to chaos hub Sentence rephrasing Signed-off-by: Smriti S <smriti.satyanarayana@harness.io>
|
Preview environment: https://hdh.pr.harness.io/pr-1103 |
Signed-off-by: Smriti S <smriti.satyanarayana@harness.io>
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
…doc-2814/bugs-bash
Signed-off-by: Smriti S <smriti.satyanarayana@harness.io>
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
| @@ -1,9 +1,11 @@ | |||
| --- | |||
| title: Configure and Add Probes | |||
| title: Configure and Add Probe(s) | |||
There was a problem hiding this comment.
Configure and add probe(s)
We are using sentence case for titles now
| A probe explores the behavior of a system in a chaotic or unpredictable manner and helps validate the declarative hypothesis set by the user. The goal of a chaos probe is to understand the underlying patterns and laws that govern the behavior of these systems, and to use that understanding to predict or control their behavior. | ||
| A probe explores the behavior of a [system that is in a chaotic or unpredictable state](../../technical-reference/chaos-faults) and helps validate the [declarative hypothesis](../../technical-reference/probes/overview.md) set by the user. The goal of a chaos probe is to understand the underlying patterns and laws that govern the behavior of these systems, and use this understanding to predict or control their behavior. | ||
|
|
||
| This section walks you step-by-step through how to configure and add probes to a chaos experiment. |
There was a problem hiding this comment.
Suggested change
| This section walks you step-by-step through how to configure and add probes to a chaos experiment. | |
| This section walks you through how to configure and add probes to a chaos experiment. |
| @@ -12,18 +14,16 @@ A probe explores the behavior of a system in a chaotic or unpredictable manner a | |||
|
|
|||
| ## Prerequisites | |||
|
|
|||
| - To configure and setup a probe inside a fault there should be an active chaos infrastructure to schedule the chaos experiment in. | |||
| - To configure and setup a probe inside a fault, you should have an active chaos infrastructure where you can schedule the chaos experiment. | |||
There was a problem hiding this comment.
Suggested change
| - To configure and setup a probe inside a fault, you should have an active chaos infrastructure where you can schedule the chaos experiment. | |
| - You should have an active chaos infrastructure where you can schedule the chaos experiment. |
| - Enterprise Hub connectivity status should be active | ||
| - Probe requires the read/write access to the chaos experiment to schedule or navigate to the probe addition user interface. |
There was a problem hiding this comment.
Suggested change
| - Probe requires the read/write access to the chaos experiment to schedule or navigate to the probe addition user interface. | |
| - Read/write access to the chaos experiment to schedule or navigate to the probe addition UI. |
| - Enterprise Hub connectivity status should be active | ||
| - Probe requires the read/write access to the chaos experiment to schedule or navigate to the probe addition user interface. | ||
| - Probe requires read access to the chaos infrastructure to select a chaos infrastructure when creating an experiment. |
There was a problem hiding this comment.
Suggested change
| - Probe requires read access to the chaos infrastructure to select a chaos infrastructure when creating an experiment. | |
| - Read access to the chaos infrastructure to select a chaos infrastructure when creating an experiment. |
| - Enterprise Hub connectivity status should be active | ||
| - Probe requires the read/write access to the chaos experiment to schedule or navigate to the probe addition user interface. | ||
| - Probe requires read access to the chaos infrastructure to select a chaos infrastructure when creating an experiment. | ||
| - Probe requires read access to the chaos hub to select faults from the chaos hub while creating an experiment. |
There was a problem hiding this comment.
Suggested change
| - Probe requires read access to the chaos hub to select faults from the chaos hub while creating an experiment. | |
| - Read access to the chaos hub to select faults from the chaos hub while creating an experiment. |
|
|
||
| Navigate to the Create Experiment View by clicking the `+ New Experiment` button and provide a name, description and tag for your experiment. | ||
| ## Step 1: Navigate to the chaos experiment creation |
There was a problem hiding this comment.
Suggested change
| ## Step 1: Navigate to the chaos experiment creation | |
| ## Navigate to the chaos experiment creation |
| @@ -35,32 +35,33 @@ And then click on `Start with blank canvas` once you see the start off drawer po | |||
|
|
|||
| ## Step 2: Select a fault | |||
There was a problem hiding this comment.
Suggested change
| ## Step 2: Select a fault | |
| ## Select a fault |
There was a problem hiding this comment.
Global comment: Remove Step 1, Step 2, Review, Option, etc. from the docs. We don't use it per new style guidelines
roshnisarangadharan
previously approved these changes
Apr 12, 2023
|
|
||
| Once a fault is clicked a Tuning drawer opens up with the fault name as a title, navigate to the last tab which says `Probes`. A default health check command probe should already be present. You can either add or replace the existing probe with a new one by clicking on the `+ Deploy new Probe` button. | ||
| Once you click on a fault, a **Tuning drawer** opens up. Navigate to the last tab `Probes`. A default health check command probe will already be present. You can either add or replace the existing probe with a new one by clicking `+ Deploy new Probe` button. |
There was a problem hiding this comment.
Once you select a fault..
for accessibility users its preferred to use select instead of click
| @@ -35,32 +35,33 @@ And then click on `Start with blank canvas` once you see the start off drawer po | |||
|
|
|||
| ## Step 2: Select a fault | |||
|
|
|||
| Click on the `+` icon to open the fault selection drawer and choose the fault which you would like to execute in your chaos experiment based on the hypothesis decided. | |||
| Click on the `+` icon to open the fault selection drawer and choose the fault to execute in your chaos experiment based on the hypothesis decided. | |||
There was a problem hiding this comment.
Select the + icon..
|
|
||
|  | ||
|
|
||
| Provide the necessary probe attributes, since we chose HTTP Probe, we can see attributes related to HTTP, like URL, Method, Criteria, etc along with the common probe properties. | ||
|
|
||
| Now, the screen shows common probe properties, such as `Probe timeout`, `Retry`, `Interval`, and so on. Enter relevant values, and click `Continue`. |
There was a problem hiding this comment.
... select Continue.
|  | ||
|
|
||
| Provide the required probe attributes. In this case, you have chosen HTTP probe, which shows attributes associated with it, such as `URL`, `Method`, `Criteria`, and so on. Enter relevant values, and click `Setup the probe`. |
There was a problem hiding this comment.
..select Setup the probe
use select globally instead of click
|  | ||
|
|
||
| ## Step 4: Save the probe | ||
|
|
||
| Once done, click on `Setup the Probe >` and your newly configured probe should be saved and appended to the manifest already. To view the configurations just saved, hover over `View` of the respective section. | ||
| Once you have added the parameters for the probe, click `Setup the Probe >`. The newly configured probe will be saved and appended to the manifest. To view the configurations that you saved, hover over `View` of the respective probe. |
| @@ -35,7 +35,7 @@ spec: | |||
|
|
|||
| ## Schema | |||
|
|
|||
| Probe schema for CMD Probe with common properties shared across all probes and properties unique to CMD probe. | |||
| Listed below is the probe schema for the command probe, with properties shared across all the probes and properties unique to the command probe. | |||
There was a problem hiding this comment.
Suggested change
| Listed below is the probe schema for the command probe, with properties shared across all the probes and properties unique to the command probe. | |
| Listed below is the probe schema for the command probe with properties shared across all the probes and properties unique to the command probe. |
| :::info YAML Only Feature | ||
| In the case of a complex POST request in which the body spans multiple lines, the `bodyPath` attribute can be used to provide the path to a file consisting of the same. This file can be made available to the experiment pod via a ConfigMap resource, with the ConfigMap name being defined in the [ChaosEngine](https://docs.litmuschaos.io/docs/concepts/chaos-engine) or the [ChaosExperiment](https://docs.litmuschaos.io/docs/concepts/chaos-experiment) CR. It can be defined at `.spec.experiments[].spec.probe` inside ChaosEngine. Also, `body` and `bodyPath` attributes are mutually exclusive. Refer to the probe schema [here](https://docs.litmuschaos.io/docs/concepts/probes#httpprobe). | ||
| :::info YAML only feature | ||
| In the case of a complex `POST` request in which the body spans multiple lines, the `bodyPath` attribute is used to specify the path to a file consisting of the same. This file is available to the experiment pod through a ConfigMap resource, wherein the ConfigMap name is defined in the [chaos engine](https://docs.litmuschaos.io/docs/concepts/chaos-engine) or the [chaos experiment](https://docs.litmuschaos.io/docs/concepts/chaos-experiment) CR. The `body` and `bodyPath` attributes are mutually exclusive. Go to the [probe schema](https://docs.litmuschaos.io/docs/concepts/probes#httpprobe) to learn more. |
There was a problem hiding this comment.
Go to probe schema to learn more.
Signed-off-by: Smriti S <smriti.satyanarayana@harness.io>
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
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.
Typo
Sentence case
Chaos Hub to chaos hub
Sentence rephrasing
Signed-off-by: Smriti S smriti.satyanarayana@harness.io