Skip to main content

VMware HTTP response modify

Last updated on

VMware HTTP response modify is a VMware chaos fault that rewrites HTTP responses from the service listening on TARGET_SERVICE_PORT inside the Linux VM VM_NAME. Depending on HTTP_CHAOS_TYPE, the fault overrides the status code (STATUS_CODE, optionally with a body via MODIFY_RESPONSE_BODY and RESPONSE_BODY) or modifies headers (HEADERS_MAP, HEADER_MODE). The fault inserts an HTTP proxy on PROXY_PORT (on interface NETWORK_INTERFACE) that affects a TOXICITY percentage of traffic for TOTAL_CHAOS_DURATION seconds, then restores normal routing.

Use this fault to test how callers behave when responses are corrupted: whether the caller honors error semantics for non-2xx status codes, whether body-parsing handles unexpected payloads gracefully, whether monitoring detects the regression within the alerting SLA, and whether on-call alerts fire correctly.

Run your first experiment

If you have not configured the chaos infrastructure yet, go to Quickstart to install the chaos infrastructure and run an experiment end to end.


Use cases

  • Bad status codes: When the service returns 503 instead of 200, does the caller retry inside the SLO budget?
  • Garbled body: When the body is replaced with arbitrary content, does the caller's parser handle the error gracefully?
  • Header injection / removal: Does the workload depend on a header that may disappear?

Prerequisites

  • Kubernetes version: 1.21 or later for the chaos infrastructure cluster.
  • VMware Tools running on the guest: Verify with vmware-toolbox-cmd -v.
  • HTTP proxy binary installed inside the guest: Go to VMware Linux binary installation to install the HTTP chaos prerequisite.
  • Free port: PROXY_PORT is not already in use on NETWORK_INTERFACE.
  • Capability for the port: VM_USER_NAME can bind PROXY_PORT (ports below 1024 require sudo or CAP_NET_BIND_SERVICE).
  • Traffic redirected to the proxy: The fault requires iptables (or equivalent) on the guest to route service traffic through PROXY_PORT.
  • vCenter chaos role: GOVC_USERNAME is mapped to the chaos role per VMware permissions.

Supported environments

PlatformSupport status
Linux VMs hosted on vSphere / vCenter (any distro with VMware Tools, iptables, and the HTTP chaos binary)Supported
Windows VMsNot supported

Permissions required

On vCenter. Map GOVC_USERNAME to the chaos role described in VMware permissions. The role needs Guest Operations (Program execution, Modifications, Queries).

On the guest OS. VM_USER_NAME must be able to launch the HTTP chaos binary, bind PROXY_PORT, and update iptables rules for traffic redirection.


Authentication

LayerTunables
vCenterGOVC_URL, GOVC_USERNAME, GOVC_PASSWORD, GOVC_INSECURE
Guest OSVM_USER_NAME, VM_PASSWORD

Store each credential as a text secret in Harness Secret Manager and reference the secret identifier when configuring the experiment.


Fault tunables

Required parameters

TunableDescriptionDefault
VM_NAMEName of the target VM as it appears in vCenter.(required)
VM_USER_NAMEOS user account on the target VM.(required)
VM_PASSWORDPassword for VM_USER_NAME.(required)
HTTP_CHAOS_TYPEType of modification: status_code, body, or header.status_code
TARGET_SERVICE_PORTPort of the target HTTP service on the guest.80

Status code / body parameters

TunableDescriptionDefault
STATUS_CODEStatus code to return when HTTP_CHAOS_TYPE=status_code.""
MODIFY_RESPONSE_BODYIf true, the body is also replaced with a default error payload matching the status code.true
RESPONSE_BODYCustom body to return instead of the default. Used with HTTP_CHAOS_TYPE=body or as the override body when MODIFY_RESPONSE_BODY=true.""

Header parameters

TunableDescriptionDefault
HEADERS_MAPJSON object of headers to add or modify, for example {"X-Source":"chaos"}.{}
HEADER_MODEresponse (rewrite response headers) or request (rewrite request headers).response

Proxy parameters

TunableDescriptionDefault
NETWORK_INTERFACEInterface where the proxy is inserted.ens160
PROXY_PORTPort the chaos proxy listens on.8080
TOXICITYPercentage of intercepted requests affected (0-100).100

Chaos parameters

TunableDescriptionDefault
TOTAL_CHAOS_DURATIONTotal duration of the fault in seconds.30
CHAOS_INTERVALDelay in seconds between iterations.10
SEQUENCEparallel or serial.parallel
RAMP_TIMEWait period in seconds before and after the fault.0

vCenter authentication

TunableDescriptionDefault
GOVC_URLvCenter server URL.""
GOVC_USERNAMEvCenter user mapped to the chaos role.""
GOVC_PASSWORDPassword for GOVC_USERNAME.""
GOVC_INSECURESkip SSL certificate verification when set to true.true

Tunables that apply to every fault are documented in common tunables for all faults.


Fault execution in brief

Authenticates to vCenter, opens a Guest Operations session on VM_NAME as VM_USER_NAME, runs an HTTP chaos proxy on PROXY_PORT of NETWORK_INTERFACE, redirects traffic destined for TARGET_SERVICE_PORT through the proxy, and rewrites responses (status code / body / headers per HTTP_CHAOS_TYPE) for TOXICITY percent of requests for TOTAL_CHAOS_DURATION seconds, then removes the redirection and stops the proxy.


Expected behavior during fault execution

  • HTTP responses on TARGET_SERVICE_PORT are mutated according to HTTP_CHAOS_TYPE:
    • status_code: Status is replaced with STATUS_CODE. If MODIFY_RESPONSE_BODY=true, the body is replaced as well.
    • body: The body is replaced with RESPONSE_BODY.
    • header: Headers are modified per HEADERS_MAP in HEADER_MODE direction.
  • Callers may treat modified responses as errors and retry, or may surface incorrect data.
  • After the duration ends, the redirection is removed; responses return to baseline.
When the fault ends

The chaos pod removes the traffic redirection and stops the proxy via Guest Operations. HTTP responses return to baseline within seconds.

Signals to watch

  • HTTP error rate: Use an HTTP probe.
  • Caller retry behavior: Use a Prometheus probe on caller-side retry and error metrics.

Verify the fault execution effect

  1. Send an HTTP request to the target service during the chaos window.

    curl -v http://<VM_IP>:<TARGET_SERVICE_PORT>/health

    For HTTP_CHAOS_TYPE=status_code, the response should show STATUS_CODE instead of the original.

  2. After the fault ends, repeat the request.

    The response should match the original behavior of the service.


Recovery and cleanup

  • End of duration: The chaos pod removes the redirection and stops the proxy.
  • Abort: Stopping the experiment also removes the redirection.
  • Manual recovery: If the redirection remains, SSH into the VM and remove the offending iptables rule, and kill the chaos process listening on PROXY_PORT.

Limitations

  • HTTP only: The fault affects HTTP traffic. HTTPS requires the proxy to terminate TLS or the client to trust the proxy CA.
  • Single port per run: Each fault run targets one TARGET_SERVICE_PORT.
  • HEADERS_MAP format: Must be valid JSON; invalid JSON causes the fault to error out.
  • VMware Tools required: Without VMware Tools, the fault cannot run.

Troubleshooting

VMware HTTP response modify has no observable effect in Harness Chaos Engineering

Verify that traffic is actually flowing through the chaos proxy (sudo iptables -t nat -L -n on the guest). Confirm TARGET_SERVICE_PORT matches the live service port. Confirm the workload talks HTTP, not HTTPS.

HEADERS_MAP rejected as invalid JSON in HCE

HEADERS_MAP must be a flat JSON object of strings, for example {"X-Source":"chaos"}. Validate the JSON before submitting the experiment.