Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steadybit/extension-scaffold
This repository contains a Steadybit extension scaffold containing all the necessary boilerplate.
https://github.com/steadybit/extension-scaffold
Last synced: 5 days ago
JSON representation
This repository contains a Steadybit extension scaffold containing all the necessary boilerplate.
- Host: GitHub
- URL: https://github.com/steadybit/extension-scaffold
- Owner: steadybit
- License: mit
- Created: 2023-02-01T07:33:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T07:41:19.000Z (26 days ago)
- Last Synced: 2025-01-29T05:32:35.142Z (13 days ago)
- Language: Go
- Size: 651 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.SCAFFOLD.md
- Changelog: CHANGELOG.SCAFFOLD.md
- Contributing: CONTRIBUTING.SCAFFOLD.md
- License: LICENSE
Awesome Lists containing this project
README
# Steadybit extension-scaffold
TODO describe what your extension is doing here from a user perspective.
TODO optionally add your extension to the [Reliability Hub](https://hub.steadybit.com/) by creating
a [pull request](https://github.com/steadybit/reliability-hub-db) and add a link to this README.
## Configuration
| Environment Variable | Helm value | Meaning | Required | Default |
|-----------------------------------------------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------|----------|-------------------------|
| `STEADYBIT_EXTENSION_ROBOT_NAMES` | | Comma-separated list of discoverable robots | yes | Bender,Terminator,R2-D2 |
| `STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_ROBOT` | `discovery.attributes.excludes.robot | List of Robot Attributes which will be excluded during discovery. Checked by key equality and supporting trailing "*" | no | |
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-scaffold.enabled=true \
```
Additional configuration options can be found in
the [helm-chart](https://github.com/steadybit/extension-scaffold/blob/main/charts/steadybit-extension-scaffold/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-scaffold/blob/main/charts/steadybit-extension-scaffold).
```bash
helm repo add steadybit-extension-scaffold https://steadybit.github.io/extension-scaffold
helm repo update
helm upgrade steadybit-extension-scaffold \
--install \
--wait \
--timeout 5m0s \
--create-namespace \
--namespace steadybit-agent \
steadybit-extension-scaffold/steadybit-extension-scaffold
```
### Linux Package
Please use
our [agent-linux.sh script](https://docs.steadybit.com/install-and-configure/install-agent/install-on-linux-hosts)
to install the extension on your Linux machine. The script will download the latest version of the extension and install
it using the package manager.
After installing, configure the extension by editing `/etc/steadybit/extension-scaffold` and then restart the service.
## 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.