extension-gcp

README

Steadybit extension-gcp

A Steadybit discovery and attack implementation to inject faults into various Google Cloud / GCP services.

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

Configuration

Environment Variable	Helm value	Meaning	Required	Default
STEADYBIT_EXTENSION_CREDENTIALS_KEYFILE_PATH	gcp.credentialsKeyfilePath	To authorize using a JSON key file via location path (https://cloud.google.com/iam/docs/managing-service-account-keys)	false	Tries to get a client with default google apis
STEADYBIT_EXTENSION_CREDENTIALS_KEYFILE_JSON	gcp.credentialsKeyfileJson	To authorize using a JSON key file content as string instead of a path to the file (https://cloud.google.com/iam/docs/managing-service-account-keys)	false	Tries to get a client with default google apis
STEADYBIT_EXTENSION_PROJECT_ID	gcp.projectID	The Google Cloud Project ID to be used	true
STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_VM	discovery.attributes.excludes.vm	List of Target Attributes which will be excluded during discovery. Checked by key equality and supporting trailing "*"	false

The extension supports all environment variables provided by steadybit/extension-kit.

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

Installation

Using Docker

docker run \
  --rm \
  -p 8093 \
  --name steadybit-extension-gcp \
  -e STEADYBIT_EXTENSION_PROJECT_ID='YOUR_GCP_PROJECT_ID' \
  -e STEADYBIT_EXTENSION_CREDENTIALS_KEYFILE_JSON='{  "type": "service_account".......' \
  ghcr.io/steadybit/extension-gcp:latest

Using Helm in Kubernetes

helm repo add steadybit-extension-gcp https://steadybit.github.io/extension-gcp
helm repo update
helm upgrade steadybit-extension-gcp \
    --install \
    --wait \
    --timeout 5m0s \
    --create-namespace \
    --namespace steadybit-extension \
    --set gcp.projectID=YOUR_GCP_PROJECT_ID \
    --set gcp.credentialsKeyfilePath=PATH_TO_JSON_FILE \
    steadybit-extension-gcp/steadybit-extension-gcp

Register the extension

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