edgerun-edge-chaos 0.0.4

Edge Chaos

Edge Chaos

This project's aim is to cause chaos in edge-cloud environments.

Users can start and stop programs that should disrupt co-located applications. Currently the following features are implemented:

• CPU stress (using stress-ng)
• Network traffic shaping (using tc)

Install

Run the following steps to install all dependencies:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Build

We offer scripts to containerize the application for all common architectures (i.e., amd64, arm32v7 and arm64v8):

./scripts/docker-build.sh $arch

Release

./scripts/docker-release.sh $repository $version

The version argument is optional and defaults to $(git rev-parse --short HEAD).

Run

While it's main intended use case is to run in a container, you can also start it natively:

python3 -u -m edgechaos.daemon.run

To start as a container run:

docker run --network=host edgerun/edge-chaos:latest

Usage

EdgeChaos runs as a daemon (native, in a container or in a Kubernetes Pod) and waits to receive commands. Currently, commands are expected to arrive via Redis Pub/Sub or via AMQP (i.e., RabbitMQ).

Supported interaction:

• Redis: the daemon waits for messages published via the channel edgechaos/$edgechaos_host.
• RabbitMq: the daemon watis for messages published on the exchange edgechaos with the routing key `$edgechaos_host.

Whereas $edgechaos_host is set as environment variable and defaults to the HOSTNAME.

The expected body is the same across the different interaction methods. The daemon expects the message to be a JSON object, that has a name, parameters and kind key. The name indicates the type of attack (i.e., cpu) and the parameters specify further information necessary for the attack. The kind specifies whether it's a start or stop event. You can get a more detailed glimpse into the format by taking a look at the corresponding dataclass ChaosCommand.

Important: The body must be always the same. Which means if you want to stop an attack, you have to send the same body as before, except kind is set to stop.

To give an example, the following two JSON objects show how to start a CPU attack (using 1 core) and stop it.

Start the attack:

{
  "name": "stress-ng",
  "parameters": {
    "cpu": 1
  },
  "kind": "start"
}

And stop it:

{
  "name": "stress-ng",
  "parameters": {
    "cpu": 1
  },
  "kind": "stop"
}

Available chaos attacks

In the following we list all available attacks and specify their respective JSON objects for invocation.

stress-ng

stress-ng is a powerful stress test program that has over 280 different types of attacks (stressors). Therefore, users can specify any arbitrary combination of arguments that will be passed on to stress-ng. Which means that any key-value pair in the parameters object is passed on to stress-ng.

Stress-ng attacks can be executed in two ways:

1. A start and stop event is sent, in both cases the remaining content of the message must be identical.
2. Stress-ng offers parameters to stop the stress test after a certain amount of operations or time (i.e., timeout). In this case not stop event is required.

The request should look like this. The content of the parameter will be passed onto stress-ng, though it is not necessary to prefix the arguments (i.e,. JSON object keys) with --:

{
  "name": "stress-ng",
  "parameters": {
    "cpu": 0
  },
  "kind": "start"
}

Note that in the example attack, 0 indicates that stress-ng should use all available cores.

tc

tc is a Linux traffic shaping tool that can modify the traffic on network interfaces. This wiki entry offers a quick look into the capabilities of tc. As before with stress-ng, we do not want to limit users in their chaos attack configuration and thus just pass on any parameter to tc.

In contrast to stress-ng attacks, each attack needs to be manually stopped. That means that the edge-chaos agent does not modify the parameters and just passes on parameters. To stop the modification, it is necessary to send the correct tc command (see down below for an example) and that the kind key is set to stop.

Important: Manually stopping tc commands means that the edge-chaos agent does not stop executed commands on shutdown. Every set tc rule has to be manually deleted.

Further, because tc expects a list of parameters rather than flags, we expect the parameters object to have a single key (tc) which value is a list of strings that is passed on, without modification, to the tc command.

For example, to add a 100ms delay on the egress of the eth0 network interface, send:

{
  "name": "tc",
  "parameters": {
    "tc": [
      "qdisc",
      "add",
      "dev",
      "eth0",
      "root",
      "netem",
      "delay",
      "100ms"
    ]
  },
  "kind": "start"
}

And to remove the tc rule, send:

{
  "name": "tc",
  "parameters": {
    "tc": [
      "qdisc",
      "del",
      "dev",
      "eth0",
      "root",
      "netem",
      "delay",
      "100ms"
    ]
  },
  "kind": "stop"
}

Note that the value of kind has no influence on the command. However, it is recommended to set it appropriately for post-attack analysis.

Environment variables

Name	Default	Description
edgechaos_logging_level	INFO	Sets logger level
edgechaos_redis_host	localhost	Redis host
edgechaos_redis_port	6379	Redis port
edgechaos_redis_password	N/A	Redis password
edgechaos_listener_type	redis	Listener type (currently supported: redis, rabbitmq)
edgechaos_client_type	redis	Client type (currently supported: redis, rabbitmq)
edgechaos_host	$HOSTNAME	Hostname, determines the channel the daemon listens to
edgechaos_rabbitmq_url	N/A	RabbitMq connection url
edgechaos_rabbitmq_exchange	edgechaos	Used as name for the exchange to use for attacks