Skip to main content

Changed Annotations

Sidecar Annotations

Operator v2 makes changes to the set of annotations applied. Some annotations are removed or renamed.

AnnotationStateDescription
sidecar.speedscale.com/removeremovedTo un-inject the Speedscale proxy from a workload, set sidecar.speedscale.com/inject to false
sidecar.speedscale.com/statusremovedNo direct replacement for this annotation. Status is now tracked in a TrafficReplay Custom Resource
sidecar.speedscale.com/envoyFilterrenamedsidecar.speedscale.com/envoy-filter
sidecar.speedscale.com/debugremovedNo direct replacement
sidecar.speedscale.com/captureNodeTrafficrenamedsidecar.speedscale.com/capture-node-traffic
sidecar.speedscale.com/captureModerenamedsidecar.speedscale.com/capture-mode
sidecar.speedscale.com/proxyModerenamedsidecar.speedscale.com/proxy-mode
sidecar.speedscale.com/proxyProtocolrenamedsidecar.speedscale.com/proxy-protocol
sidecar.speedscale.com/proxyHostrenamedsidecar.speedscale.com/proxy-host
sidecar.speedscale.com/proxyPortrenamedsidecar.speedscale.com/proxy-port
sidecar.speedscale.com/proxyInPortrenamedsidecar.speedscale.com/proxy-in-port
sidecar.speedscale.com/proxyOutPortrenamedsidecar.speedscale.com/proxy-out-port
sidecar.speedscale.com/tls-outnewEnables/disables outbound TLS interception. Defaults to false if not present.
sidecar.speedscale.com/tlsremovedsidecar.speedscale.com/tls-out acts as a replacement, and sidecar.speedscale.com/tls-in-secret will implicitly enable TLS interception on inbound traffic.
sidecar.speedscale.com/tlsinsecretrenamedsidecar.speedscale.com/tls-in-secret
sidecar.speedscale.com/tlsinprivaterenamedsidecar.speedscale.com/tls-in-private
sidecar.speedscale.com/tlsinpublicrenamedsidecar.speedscale.com/tls-in-public
sidecar.speedscale.com/tlsmutualsecretrenamedsidecar.speedscale.com/tls-mutual-secret
sidecar.speedscale.com/tlsmutualprivaterenamedsidecar.speedscale.com/tls-mutual-private
sidecar.speedscale.com/tlsmutualpublicrenamedsidecar.speedscale.com/tls-mutual-public
sidecar.speedcale.com/insertfirstrenamedsidecar.speedscale.com/insert-init-first
sidecar.speedscale.com/ignoreDstIpsrenamedsidecar.speedscale.com/ignore-dst-ips
sidecar.speedscale.com/ignoreSrcIpsrenamedsidecar.speedscale.com/ignore-src-ips
sidecar.speedscale.com/ignoreDstHostsrenamedsidecar.speedscale.com/ignore-dst-hosts
sidecar.speedscale.com/ignoreSrcHostsrenamedsidecar.speedscale.com/ignore-src-hosts
sidecar.speedscale.com/cpu-limitnewSpecifies the CPU limit for Speedscales proxy sidecar
sidecar.speedscale.com/cpu-requestnewSpecifies the CPU request for Speedscales proxy sidecar
sidecar.speedscale.com/memory-limitnewSpecifies the memory limit for Speedscales proxy sidecar
sidecar.speedscale.com/memory-requestnewSpecifies the memory request for Speedscales proxy sidecar
sidecar.speedscale.com/enableMongoDbDetectionrenamedsidecar.speedscale.com/detect-mongo
sidecar.speedscale.com/enablePostgresDetectionrenamedsidecar.speedscale.com/detect-postgres
sidecar.speedscale.com/enableAMQPv091Detectionrenamedsidecar.speedscale.com/detect-amqpv091

Replay Annotations

The test.speedscale.com subdomain was changed to replay.speedscale.com. See below for more detailed changes.

AnnotationStateDescription
replay.speedscale.com/env-idnewIndicates the name of the TrafficReplay Custom Resource tied to a currently running replay for this workload.
test.speedscale.com/cleanuprenamedreplay.speedscale.com/cleanup. Additionally, possible values are changed and this is no longer boolean. New values are: inventory, all or none. Defaults to inventory if annotation is not present. inventory instructs the operator to clean up all objects related to Speedscale's replay of traffic once finished (such as ConfigMaps, traffic generators, collectors, responders, and related infrastructure), as well as reverting changes made to the workload. all instructs the operator to clean up all objects as well as the workload under test (such as a Deployment, Job, DaemonSet, or StatefulSet). none instructs the operator to not do anything with replay resources once a replay is finished.
test.speedscale.com/scenarioidrenamedreplay.speedscale.com/snapshot-id
test.speedscale.com/testconfigidrenamedreplay.speedscale.com/testconfig-id. This annotation is no longer required. Defaults to standard if annotation is not present.
test.speedscale.com/ignoreremovedoperator.speedscale.com/ignore
test.speedscale.com/tagrenamedreplay.speedscale.com/build-tag
test.speedscale.com/secretsrenamedreplay.speedscale.com/secrets
test.speedscale.com/jwtremovedUse replay.speedscale.com/secrets
test.speedscale.com/sutremovedReplaced by operator.speedscale.com/sut
test.speedscale.com/sutURLrenamedreplay.speedscale.com/sut-url
test.speedscale.com/logCollectionrenamedreplay.speedscale.com/collect-logs
test.speedscale.com/responderLowDatarenamedreplay.speedscale.com/responder-low-data
replay.speedscale.com/timeoutnewSpecifies a timeout for a replay. Ignored when replay mode is responder-only
test.speedscale.com/deployResponderremovedThe new annotation replay.speedscale.com/mode: responder-only replaces this annotation
test.speedscale.com/deployGeneratorremovedThe new annotation replay.speedscale.com/mode: generator-only replaces this annotation
replay.speedscale.com/modenewSets the mode for replaying. Possible values: full-replay - instructs the operator to deploy both the generator and responder components and make changes to the workload (such as adding responder host aliases), responder-only - deploys on the responder components and makes changes to the workload (such as adding responder host aliases), generator-only - deploys on the generator, makes no changes to the workload
note

The operator will remove all listed replay annotations from the workload during admission review and move them into an associated TrafficReplay Custom Resource. This prevents side effects such as the operator observing and executing the same replay after it has finished. It also allows subsequent runs of the same replay by applying the same manifests, or incorporating the annotations into a GitOps workflow.

Common Annotations

These annotations are common across workloads and Speedscale's Custom Resources.

AnnotationDescription
operator.speedscale.com/ignoreThe presence of this annotation on a workload instructs the operator to skip processing of the workload regardless of any other Speedscale annotations. Changes made to a workload manually AFTER this annotation was added won’t be reverted by the operator.
operator.speedscale.com/sutThe presence of this annotation on a workload indicates that this workload has a sidecar injected AND/OR replay running. (SUT stands for System Under Test)
operator.speedscale.com/managed-byThis annotation on a workload or TrafficReplay CR defines a unique name of the operator instance which manages this resource (sourced from INSTANCE_ID var in the operator’s ConfigMap). This is to prevent race conditions in cases where multiple Speedscale operators are installed to different namespaces.