diff --git a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-corruption.md b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-corruption.md index 9f24147f120..4b71b953548 100644 --- a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-corruption.md +++ b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-corruption.md @@ -81,6 +81,11 @@ permissions: Packet corruption in percentage. Default: 100. For more information, go to network packet corruption. + + CORRELATION + Degree of dependency between consecutive packets + It should be in range of (0,100]. For more information, go to correlation. + CONTAINER_RUNTIME Container runtime interface for the cluster. @@ -185,6 +190,37 @@ spec: value: '60' ``` +### Correlation + +Degree of dependency between consecutive packets. Tune it by using the `CORRELATION` environment variable. + +The following YAML snippet illustrates the use of this environment variable: + +[embedmd]:# (./static/manifests/pod-network-corruption/correlation.yaml yaml) +```yaml +apiVersion: litmuschaos.io/v1alpha1 +kind: ChaosEngine +metadata: + name: engine-nginx +spec: + engineState: "active" + annotationCheck: "false" + appinfo: + appns: "default" + applabel: "app=nginx" + appkind: "deployment" + chaosServiceAccount: litmus-admin + experiments: + - name: pod-network-corruption + spec: + components: + env: + - name: CORRELATION + value: '100' #in percentage + - name: TOTAL_CHAOS_DURATION + value: '60' +``` + ### Destination IPs and destination hosts Default IPs and hosts whose traffic is interrupted due to the network faults. Tune it by using the `DESTINATION_IPS` and `DESTINATION_HOSTS` environment variables, respectively. diff --git a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-duplication.md b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-duplication.md index 8f61fb5ef6e..0a3952cdcc9 100644 --- a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-duplication.md +++ b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-duplication.md @@ -81,6 +81,11 @@ permissions: Packet duplication (in percentage). Default: 100 %. For more information, go to network packet duplication. + + CORRELATION + Degree of dependency between consecutive packets + It should be in range of (0,100]. For more information, go to correlation. + CONTAINER_RUNTIME Container runtime interface for the cluster. @@ -186,6 +191,37 @@ spec: value: "60" ``` +### Correlation + +Degree of dependency between consecutive packets. Tune it by using the `CORRELATION` environment variable. + +The following YAML snippet illustrates the use of this environment variable: + +[embedmd]:# (./static/manifests/pod-network-duplication/correlation.yaml yaml) +```yaml +apiVersion: litmuschaos.io/v1alpha1 +kind: ChaosEngine +metadata: + name: engine-nginx +spec: + engineState: "active" + annotationCheck: "false" + appinfo: + appns: "default" + applabel: "app=nginx" + appkind: "deployment" + chaosServiceAccount: litmus-admin + experiments: + - name: pod-network-duplication + spec: + components: + env: + - name: CORRELATION + value: '100' #in percentage + - name: TOTAL_CHAOS_DURATION + value: '60' +``` + ### Destination IPs and destination hosts Default IPs and hosts whose traffic is interrupted due to the network faults. Tune it by using the `DESTINATION_IPS` and `DESTINATION_HOSTS` environment variables, respectively. diff --git a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-latency.md b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-latency.md index be777d56bf0..29bbe2fc628 100644 --- a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-latency.md +++ b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-latency.md @@ -89,6 +89,11 @@ permissions: Delay (in milliseconds). Provide numeric values. Defaults to 2000. For more information, go to network latency. + + CORRELATION + Degree of dependency between consecutive packets + It should be in range of (0,100]. For more information, go to correlation. + JITTER Network jitter (in milliseconds). Provide numeric values. @@ -199,6 +204,37 @@ spec: value: "60" ``` +### Correlation + +Degree of dependency between consecutive packets. Tune it by using the `CORRELATION` environment variable. + +The following YAML snippet illustrates the use of this environment variable: + +[embedmd]:# (./static/manifests/pod-network-latency/correlation.yaml yaml) +```yaml +apiVersion: litmuschaos.io/v1alpha1 +kind: ChaosEngine +metadata: + name: engine-nginx +spec: + engineState: "active" + annotationCheck: "false" + appinfo: + appns: "default" + applabel: "app=nginx" + appkind: "deployment" + chaosServiceAccount: litmus-admin + experiments: + - name: pod-network-latency + spec: + components: + env: + - name: CORRELATION + value: '100' #in percentage + - name: TOTAL_CHAOS_DURATION + value: '60' +``` + ### Destination IPs and destination hosts Default IPs and hosts whose traffic is interrupted due to the network faults. Tune it by using the `DESTINATION_IPS` and `DESTINATION_HOSTS` environment variabes, respectively. diff --git a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-loss.md b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-loss.md index 19a635bc83a..40fd4cf4086 100644 --- a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-loss.md +++ b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-network-loss.md @@ -88,6 +88,11 @@ permissions: Packet loss (in percentage). Default: 100 %. For more information, go to network packet loss. + + CORRELATION + Degree of dependency between consecutive packets + It should be in range of (0,100]. For more information, go to correlation. + CONTAINER_RUNTIME Container runtime interface for the cluster. @@ -186,6 +191,38 @@ spec: - name: TOTAL_CHAOS_DURATION value: '60' ``` + +### Correlation + +Degree of dependency between consecutive packets. Tune it by using the `CORRELATION` environment variable. + +The following YAML snippet illustrates the use of this environment variable: + +[embedmd]:# (./static/manifests/pod-network-loss/correlation.yaml yaml) +```yaml +apiVersion: litmuschaos.io/v1alpha1 +kind: ChaosEngine +metadata: + name: engine-nginx +spec: + engineState: "active" + annotationCheck: "false" + appinfo: + appns: "default" + applabel: "app=nginx" + appkind: "deployment" + chaosServiceAccount: litmus-admin + experiments: + - name: pod-network-loss + spec: + components: + env: + - name: CORRELATION + value: '100' #in percentage + - name: TOTAL_CHAOS_DURATION + value: '60' +``` + ### Destination IPs and destination hosts Default IPs and hosts whose traffic is interrupted because of the network faults. Tune it by using the `DESTINATION_IPS` and `DESTINATION_HOSTS` environment variables, respectively. diff --git a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-corruption/correlation.yaml b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-corruption/correlation.yaml new file mode 100644 index 00000000000..350d0587329 --- /dev/null +++ b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-corruption/correlation.yaml @@ -0,0 +1,21 @@ +apiVersion: litmuschaos.io/v1alpha1 +kind: ChaosEngine +metadata: + name: engine-nginx +spec: + engineState: "active" + annotationCheck: "false" + appinfo: + appns: "default" + applabel: "app=nginx" + appkind: "deployment" + chaosServiceAccount: litmus-admin + experiments: + - name: pod-network-corruption + spec: + components: + env: + - name: CORRELATION + value: '100' #in percentage + - name: TOTAL_CHAOS_DURATION + value: '60' \ No newline at end of file diff --git a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-duplication/correlation.yaml b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-duplication/correlation.yaml new file mode 100644 index 00000000000..12ec8f6fcda --- /dev/null +++ b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-duplication/correlation.yaml @@ -0,0 +1,21 @@ +apiVersion: litmuschaos.io/v1alpha1 +kind: ChaosEngine +metadata: + name: engine-nginx +spec: + engineState: "active" + annotationCheck: "false" + appinfo: + appns: "default" + applabel: "app=nginx" + appkind: "deployment" + chaosServiceAccount: litmus-admin + experiments: + - name: pod-network-duplication + spec: + components: + env: + - name: CORRELATION + value: '100' #in percentage + - name: TOTAL_CHAOS_DURATION + value: '60' \ No newline at end of file diff --git a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-latency/correlation.yaml b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-latency/correlation.yaml new file mode 100644 index 00000000000..2e55efa303a --- /dev/null +++ b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-latency/correlation.yaml @@ -0,0 +1,21 @@ +apiVersion: litmuschaos.io/v1alpha1 +kind: ChaosEngine +metadata: + name: engine-nginx +spec: + engineState: "active" + annotationCheck: "false" + appinfo: + appns: "default" + applabel: "app=nginx" + appkind: "deployment" + chaosServiceAccount: litmus-admin + experiments: + - name: pod-network-latency + spec: + components: + env: + - name: CORRELATION + value: '100' #in percentage + - name: TOTAL_CHAOS_DURATION + value: '60' \ No newline at end of file diff --git a/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-loss/correlation.yaml b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-loss/correlation.yaml new file mode 100644 index 00000000000..1de19d0ed47 --- /dev/null +++ b/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/static/manifests/pod-network-loss/correlation.yaml @@ -0,0 +1,21 @@ +apiVersion: litmuschaos.io/v1alpha1 +kind: ChaosEngine +metadata: + name: engine-nginx +spec: + engineState: "active" + annotationCheck: "false" + appinfo: + appns: "default" + applabel: "app=nginx" + appkind: "deployment" + chaosServiceAccount: litmus-admin + experiments: + - name: pod-network-loss + spec: + components: + env: + - name: CORRELATION + value: '100' #in percentage + - name: TOTAL_CHAOS_DURATION + value: '60' \ No newline at end of file