Skip to content

Latest commit

 

History

History
executable file
·
69 lines (48 loc) · 3.47 KB

README.SCAFFOLD.md

File metadata and controls

executable file
·
69 lines (48 loc) · 3.47 KB
Raw

Steadybit extension-scaffold

TODO describe what your extension is doing here from a user perspective.

TODO optionally add your extension to the Reliability Hub by creating a pull request 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.

Installation

Kubernetes

Detailed information about agent and extension installation in kubernetes can also be found in our documentation.

Recommended (via agent helm chart)

All extensions provide a helm chart that is also integrated in the helm-chart 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 of the extension.

Alternative (via own helm chart)

If you need more control, you can install the extension via its dedicated helm-chart.

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 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 for more information about extension registration and how to verify.