Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steadybit/extension-postman
A Steadybit extension to execute Postman collections via Postman Cloud Api
https://github.com/steadybit/extension-postman
chaos-engineering chaos-testing cloud postman
Last synced: 5 days ago
JSON representation
A Steadybit extension to execute Postman collections via Postman Cloud Api
- Host: GitHub
- URL: https://github.com/steadybit/extension-postman
- Owner: steadybit
- License: mit
- Created: 2022-08-01T13:55:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T08:01:55.000Z (26 days ago)
- Last Synced: 2025-01-29T05:32:35.130Z (13 days ago)
- Topics: chaos-engineering, chaos-testing, cloud, postman
- Language: Go
- Homepage: https://hub.steadybit.com/extension/com.steadybit.extension_postman
- Size: 1.76 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Steadybit extension-postman
A [Steadybit](https://www.steadybit.com/) extension to execute [Postman](https://www.postman.com/) collections via Postman Cloud Api.
Learn about the capabilities of this extension in our [Reliability Hub](https://hub.steadybit.com/extension/com.steadybit.extension_postman).
## Prerequisites
- A Postman account with a
valid [API Key](https://www.postman.com/postman/workspace/postman-public-workspace/documentation/12959542-c8142d51-e97c-46b6-bd77-52bb66712c9a#authentication)
is needed to execute collections.
## Configuration
Postman_Api_Key
## Configuration
| Environment Variable | Helm value | Meaning | Required | Default |
|---------------------------------------|------------------------|-------------------------------------------------------------|----------|---------|
| `HTTPS_PROXY` | via extraEnv variables | Configure the proxy to be used for Postman communication. | no | |
| `STEADYBIT_EXTENSION_POSTMAN_API_KEY` | postman.apiKey | Configure the api-key to be used for Postman communication. | yes | |
The extension supports all environment variables provided by [steadybit/extension-kit](https://github.com/steadybit/extension-kit#environment-variables).
## Installation
### Kubernetes
Detailed information about agent and extension installation in kubernetes can also be found in
our [documentation](https://docs.steadybit.com/install-and-configure/install-agent/install-on-kubernetes).
#### Recommended (via agent helm chart)
All extensions provide a helm chart that is also integrated in the
[helm-chart](https://github.com/steadybit/helm-charts/tree/main/charts/steadybit-agent) of the agent.
You must provide additional values to activate this extension.
```
--set extension-postman.enabled=true \
--set extension-postman.postman.apiKey={{YOUR_POSTMAN_API_KEY}} \
```
Additional configuration options can be found in
the [helm-chart](https://github.com/steadybit/extension-postman/blob/main/charts/steadybit-extension-postman/values.yaml) of the
extension.
#### Alternative (via own helm chart)
If you need more control, you can install the extension via its
dedicated [helm-chart](https://github.com/steadybit/extension-postman/blob/main/charts/steadybit-extension-postman).
```bash
helm repo add steadybit-extension-postman https://steadybit.github.io/extension-postman
helm repo update
helm upgrade steadybit-extension-postman \
--install \
--wait \
--timeout 5m0s \
--create-namespace \
--namespace steadybit-agent \
--set postman.apiKey= \
steadybit-extension-postman/steadybit-extension-postman
```
### Linux Package
This extension is currently not available as a Linux package.
## Extension registration
Make sure that the extension is registered with the agent. In most cases this is done automatically. Please refer to
the [documentation](https://docs.steadybit.com/install-and-configure/install-agent/extension-registration) for more
information about extension registration and how to verify.
## Proxy
To communicate to Postman via a proxy, we need the environment variable `https_proxy` to be set.
This can be set via helm using the extraEnv variable
```bash
--set "extraEnv[0].name=HTTPS_PROXY" \
--set "extraEnv[0].value=https:\\user:[email protected]:8888"
```