https://github.com/steadybit/extension-kubernetes
A Steadybit extension to check the state of the Kubernetes cluster and inject faults.
https://github.com/steadybit/extension-kubernetes
chaos-engineering chaos-testing helm kubernetes reliability
Last synced: 15 days ago
JSON representation
A Steadybit extension to check the state of the Kubernetes cluster and inject faults.
- Host: GitHub
- URL: https://github.com/steadybit/extension-kubernetes
- Owner: steadybit
- License: mit
- Created: 2022-09-22T09:16:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T14:40:02.000Z (19 days ago)
- Last Synced: 2025-04-10T14:49:24.456Z (19 days ago)
- Topics: chaos-engineering, chaos-testing, helm, kubernetes, reliability
- Language: Go
- Homepage: https://hub.steadybit.com/extension/com.steadybit.extension_kubernetes
- Size: 1.83 MB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Steadybit extension-kubernetes
A [Steadybit](https://www.steadybit.com/) extension implementation for Kubernetes.
Learn about the capabilities of this extension in our [Reliability Hub](https://hub.steadybit.com/extension/com.steadybit.extension_kubernetes).
## Configuration
| Environment Variable | Helm value | Meaning | required | default |
|------------------------------------------------------------------|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------------------------------------------------------------|
| `STEADYBIT_EXTENSION_KUBERNETES_CLUSTER_NAME` | `kubernetes.clusterName` | The name of the kubernetes cluster | yes | |
| `STEADYBIT_EXTENSION_DISABLE_DISCOVERY_EXCLUDES` | `discovery.disableExcludes` | Ignore discovery excludes specified by `steadybit.com/discovery-disabled` | false | `false` |
| `STEADYBIT_EXTENSION_LABEL_FILTER` | | These labels will be ignored and not added to the discovered targets | false | `controller-revision-hash,pod-template-generation,pod-template-hash` |
| `STEADYBIT_EXTENSION_ACTIVE_ADVICE_LIST` | | List of active advice definitions, default is all (*). You can define a list of active adviceDefinitionId. See UI -> Settings -> Extension -> Advice -> Column: ID | false | `*` |
| `STEADYBIT_EXTENSION_ADVICE_SINGLE_REPLICA_MIN_REPLICAS` | | Minimal required replicas for the "Redundant Pod" advice | false | 2 |
| `STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_CONTAINER` | `discovery.attributes.excludes.container` | List of Target Attributes which will be excluded during container discovery. Checked by key equality and supporting trailing "*" | false | |
| `STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_DEPLOYMENT` | `discovery.attributes.excludes.deployment` | List of Target Attributes which will be excluded during deployment discovery. Checked by key equality and supporting trailing "*" | false | |
| `STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_DAEMON_SET` | `discovery.attributes.excludes.daemonSet` | List of Target Attributes which will be excluded during daemonSet discovery. Checked by key equality and supporting trailing "*" | false | |
| `STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_STATEFUL_SET` | `discovery.attributes.excludes.statefulSet` | List of Target Attributes which will be excluded during statefulSet discovery. Checked by key equality and supporting trailing "*" | false | |
| `STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_POD` | `discovery.attributes.excludes.pod` | List of Target Attributes which will be excluded during pod discovery. Checked by key equality and supporting trailing "*" | false | |
| `STEADYBIT_EXTENSION_DISCOVERY_MAX_POD_COUNT` | `discovery.maxPodCount` | Skip listing pods, containers and hosts for deployments, statefulsets, etc. if there are more then the given pods. | false | 50 |
| `STEADYBIT_EXTENSION_NAMESPACE` | `Release.Namespace` | The namespace of the extension. If env var is set, discovery is only discovering in that namespace | false | `default` |
The extension supports all environment variables provided by [steadybit/extension-kit](https://github.com/steadybit/extension-kit#environment-variables).
## Permissions
The process requires access rights to interact with the Kubernetes API ([permissions in helm chart](/charts/steadybit-extension-kubernetes/templates/_permissions.tpl)).
The cluster role for the extension requires "read" permissions for different kind of workloads in the cluster.
If the permission is not granted to a specific resource type, those will not be discovered and cannot be attacked.
To run the different attacks "write" permissions are required:
- Scale Deployment/StatefulSet/DaemonSet: `update`, `patch` on the workload type
- Rollout Restart Deployment: `patch` on `deployment`
- Delete Pod Attack: `delete` on `pod`
- Crash Loop Pod: `create` on `pod/exec` also needs to have an `sh` and `kill` binary in the target container
## 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.
The extension is installed by default when you install the agent.
You must provide additional values to configure this extension.
```
--set extension-kubernetes.kubernetes.clusterName= \
```
Additional configuration options can be found in
the [helm-chart](https://github.com/steadybit/extension-kubernetes/blob/main/charts/steadybit-extension-kubernetes/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-kubernetes/blob/main/charts/steadybit-extension-kubernetes).
```bash
helm repo add steadybit-extension-kubernetes https://steadybit.github.io/extension-kubernetes
helm repo update
helm upgrade steadybit-extension-kubernetes \
--install \
--wait \
--timeout 5m0s \
--create-namespace \
--namespace steadybit-agent \
--set kubernetes.clusterName= \
steadybit-extension-kubernetes/steadybit-extension-kubernetes
```
## 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.
## mark resources as "do not discover"
to exclude a deployment / namespace / pod from discovery you can add the label `"steadybit.com/discovery-disabled": "true"` to the resource labels
## Version and Revision
The version and revision of the extension:
- are printed during the startup of the extension
- are added as a Docker label to the image
- are available via the `version.txt`/`revision.txt` files in the root of the image