-
Notifications
You must be signed in to change notification settings - Fork 170
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC-2814] Bugs Bash [WIP] #1103
Merged
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
04ee8ff
Bugs Bash [WIP]
SmritiSatya c860e9f
Probe review
SmritiSatya b033e49
Merge branch 'main' of https://github.com/harness/developer-hub into …
SmritiSatya 36ea9d6
Fix broken links
SmritiSatya c4b087c
Peer review comments resolution
SmritiSatya File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Probe review
Signed-off-by: Smriti S <smriti.satyanarayana@harness.io>
- Loading branch information
commit c860e9f05f04c079b55a96ce5e967bc71737f7bc
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,19 +3,19 @@ title: HTTP Probe | |
sidebar_position: 3 | ||
--- | ||
|
||
The HTTP Probe allows you to specify a URL that the experiment uses to gauge the health or service availability (or other custom conditions) as a part of the entry or exit criteria. The status code received is mapped against an expected status. It supports HTTP [Get](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) and [Post](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) methods. | ||
HTTP probe allows you to specify a URL that the experiment uses to determine the health or service availability (or other custom conditions) that is a part of the entry or exit criteria. The status code received is mapped against an expected status. It supports HTTP [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) and [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) methods. | ||
|
||
The HTTP Get method sends a HTTP `GET` request to the provided URL. The response code received is matched and matches the response code based on the given criteria(`==`, `!=`, `oneOf`). | ||
The HTTP GET method sends a GET request to the specified URL. The response code received is matched with the response code based on the given criteria (`==`, `!=`, `oneOf`). | ||
|
||
In HTTP Post method it sends a http `POST` request to the provided url. | ||
HTTP POST method sends a `POST` request to the provided URL. | ||
|
||
:::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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Go to probe schema to learn more. |
||
::: | ||
|
||
## Where to define | ||
## Defining the probe | ||
|
||
The probes can be defined at **.spec.experiments[].spec.probe** path inside Chaos Engine. | ||
You can define the probes at **.spec.experiments[].spec.probe** path inside the chaos engine. | ||
|
||
```yaml | ||
kind: Workflow | ||
|
@@ -39,7 +39,7 @@ spec: | |
|
||
## Schema | ||
|
||
Probe schema for HTTP Probe with common properties shared across all probes and properties unique to HTTP probe. | ||
Listed below is the probe schema for HTTP Probe with common properties shared across all probes and properties unique to HTTP probe. | ||
|
||
<table> | ||
<tr> | ||
|
@@ -130,9 +130,7 @@ Probe schema for HTTP Probe with common properties shared across all probes and | |
|
||
### Method | ||
|
||
Probe properties for method GET and POST. | ||
|
||
#### GET | ||
#### GET method properties | ||
|
||
<table> | ||
<tr> | ||
|
@@ -173,7 +171,7 @@ Probe properties for method GET and POST. | |
</tr> | ||
</table> | ||
|
||
#### POST | ||
#### POST method properties | ||
|
||
<table> | ||
<tr> | ||
|
@@ -250,9 +248,7 @@ Probe properties for method GET and POST. | |
</tr> | ||
</table> | ||
|
||
### Run Properties | ||
|
||
Probe run properties for HTTP Probe. | ||
### Run properties | ||
|
||
<table> | ||
<tr> | ||
|
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.