Steadybit extension-kong

A Steadybit attack implementation to inject HTTP faults into Kong API gateway.

Learn about the capabilities of this extension in our Reliability Hub.

Prerequisites

• Kong needs to have the request-termination plugin installed (typically installed by default).

Configuration

Environment Variable	Helm value	Meaning	required
STEADYBIT_EXTENSION_KONG_INSTANCE_<n>_NAME	kong.name	Name of the kong instance	yes
STEADYBIT_EXTENSION_KONG_INSTANCE_<n>_ORIGIN	kong.origin	Url of the kong admin interface	yes
STEADYBIT_EXTENSION_KONG_INSTANCE_<n>_HEADER_KEY	kong.headerKey	Optional header key to send to the Kong admin API. Typically used for authentication purposes.	no
STEADYBIT_EXTENSION_KONG_INSTANCE_<n>_HEADER_VALUE	kong.headerValue	Optional header value to send to the Kong admin API. Typically used for authentication purposes.	no
STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_SERVICE	discovery.attributes.excludes.service	List of Target Attributes which will be excluded during discovery. Checked by key equality and supporting trailing "*"	no
STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_ROUTE	discovery.attributes.excludes.route	List of Target 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.

When installed as linux package this configuration is in/etc/steadybit/extension-kong.

Installation

We recommend that you deploy the extension with our official Helm chart.

Helm

helm repo add steadybit-extension-kong https://steadybit.github.io/extension-kong
helm repo update

helm upgrade steadybit-extension-kong \
  --install \
  --wait \
  --timeout 5m0s \
  --create-namespace \
  --namespace steadybit-agent \
  --set kong.name="{{SYMBOLIC_NAME}}" \
  --set kong.origin="{{KONG_API_SERVER_ORIGIN}}" \
  steadybit-extension-kong/steadybit-extension-kong

Docker

You may alternatively start the Docker container manually.

docker run \
  --env STEADYBIT_LOG_LEVEL=info \
  --env STEADYBIT_LOG_LEVEL=info \
  --env STEADYBIT_EXTENSION_KONG_INSTANCE_0_ORIGIN="{{KONG_API_SERVER_ORIGIN}}" \
  --expose 8084 \
  ghcr.io/steadybit/extension-kong:latest

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-kong and then restart the service.

Register the extension

Make sure to register the extension at the steadybit platform. Please refer to the documentation for more information.