chore(docs): adding source and destination ports (#3802)

Signed-off-by: Shubham Chaudhary <shubham.chaudhary@harness.io>

Signed-off-by: Shubham Chaudhary <shubham.chaudhary@harness.io>
This commit is contained in:
Shubham Chaudhary 2022-11-14 13:26:26 +05:30 committed by GitHub
parent d41609ac0c
commit a288f92c89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 301 additions and 1 deletions

View File

@ -171,12 +171,22 @@
<td> DNS Names/FQDN names of the services, the accessibility to which, is impacted </td>
<td> if not provided, it will induce network chaos for all ips/destinations or DESTINATION_IPS if already defined</td>
</tr>
<tr>
<td> SOURCE_PORTS </td>
<td> ports of the target application, the accessibility to which is impacted </td>
<td> comma separated port(s) can be provided. If not provided, it will induce network chaos for all ports</td>
</tr>
<tr>
<td> DESTINATION_PORTS </td>
<td> ports of the destination services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted </td>
<td> comma separated port(s) can be provided. If not provided, it will induce network chaos for all ports</td>
</tr>
<tr>
<td> PODS_AFFECTED_PERC </td>
<td> The Percentage of total pods to target </td>
<td> Defaults to 0 (corresponds to 1 replica), provide numeric value only </td>
</tr>
<tr>
<tr>
<td> LIB </td>
<td> The chaos lib used to inject the chaos </td>
<td> Default value: litmus, supported values: pumba and litmus </td>
@ -281,6 +291,45 @@ spec:
value: '60'
```
### Source And Destination Ports
The network experiments interrupt traffic for all the source & destination ports by default. The interruption of specific port(s) can be tuned via `SOURCE_PORTS` and `DESTINATION_PORTS` ENV.
- `SOURCE_PORTS`: It contains ports of the target application, the accessibility to which is impacted
- `DESTINATION_PORTS`: It contains the ports of the destination services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted
Use the following example to tune this:
[embedmd]:# (pod-network-corruption/source-and-destination-ports.yaml yaml)
```yaml
# it inject the chaos for the ingrees and egress traffic for specific ports
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
name: engine-nginx
spec:
engineState: "active"
annotationCheck: "false"
appinfo:
appns: "default"
applabel: "app=nginx"
appkind: "deployment"
chaosServiceAccount: pod-network-corruption-sa
experiments:
- name: pod-network-corruption
spec:
components:
env:
# supports comma separated source ports
- name: SOURCE_PORTS
value: '80'
# supports comma separated destination ports
- name: DESTINATION_PORTS
value: '8080,9000'
- name: TOTAL_CHAOS_DURATION
value: '60'
```
### Network Interface
The defined name of the ethernet interface, which is considered for shaping traffic. It can be tuned via `NETWORK_INTERFACE` ENV. Its default value is `eth0`.

View File

@ -0,0 +1,26 @@
# it inject the chaos for the ingrees and egress traffic for specific ports
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
name: engine-nginx
spec:
engineState: "active"
annotationCheck: "false"
appinfo:
appns: "default"
applabel: "app=nginx"
appkind: "deployment"
chaosServiceAccount: pod-network-corruption-sa
experiments:
- name: pod-network-corruption
spec:
components:
env:
# supports comma separated source ports
- name: SOURCE_PORTS
value: '80'
# supports comma separated destination ports
- name: DESTINATION_PORTS
value: '8080,9000'
- name: TOTAL_CHAOS_DURATION
value: '60'

View File

@ -172,6 +172,16 @@
<td> DNS Names/FQDN names of the services, the accessibility to which, is impacted </td>
<td> if not provided, it will induce network chaos for all ips/destinations or DESTINATION_IPS if already defined</td>
</tr>
<tr>
<td> SOURCE_PORTS </td>
<td> ports of the target application, the accessibility to which is impacted </td>
<td> comma separated port(s) can be provided. If not provided, it will induce network chaos for all ports</td>
</tr>
<tr>
<td> DESTINATION_PORTS </td>
<td> ports of the destination services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted </td>
<td> comma separated port(s) can be provided. If not provided, it will induce network chaos for all ports</td>
</tr>
<tr>
<td> PODS_AFFECTED_PERC </td>
<td> The Percentage of total pods to target </td>
@ -282,6 +292,45 @@ spec:
value: '60'
```
### Source And Destination Ports
The network experiments interrupt traffic for all the source & destination ports by default. The interruption of specific port(s) can be tuned via `SOURCE_PORTS` and `DESTINATION_PORTS` ENV.
- `SOURCE_PORTS`: It contains ports of the target application, the accessibility to which is impacted
- `DESTINATION_PORTS`: It contains the ports of the destination services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted
Use the following example to tune this:
[embedmd]:# (pod-network-duplication/source-and-destination-ports.yaml yaml)
```yaml
# it inject the chaos for the ingrees and egress traffic for specific ports
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
name: engine-nginx
spec:
engineState: "active"
annotationCheck: "false"
appinfo:
appns: "default"
applabel: "app=nginx"
appkind: "deployment"
chaosServiceAccount: pod-network-duplication-sa
experiments:
- name: pod-network-duplication
spec:
components:
env:
# supports comma separated source ports
- name: SOURCE_PORTS
value: '80'
# supports comma separated destination ports
- name: DESTINATION_PORTS
value: '8080,9000'
- name: TOTAL_CHAOS_DURATION
value: '60'
```
### Network Interface
The defined name of the ethernet interface, which is considered for shaping traffic. It can be tuned via `NETWORK_INTERFACE` ENV. Its default value is `eth0`.

View File

@ -0,0 +1,26 @@
# it inject the chaos for the ingrees and egress traffic for specific ports
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
name: engine-nginx
spec:
engineState: "active"
annotationCheck: "false"
appinfo:
appns: "default"
applabel: "app=nginx"
appkind: "deployment"
chaosServiceAccount: pod-network-duplication-sa
experiments:
- name: pod-network-duplication
spec:
components:
env:
# supports comma separated source ports
- name: SOURCE_PORTS
value: '80'
# supports comma separated destination ports
- name: DESTINATION_PORTS
value: '8080,9000'
- name: TOTAL_CHAOS_DURATION
value: '60'

View File

@ -180,6 +180,16 @@
<td> DESTINATION_HOSTS </td>
<td> DNS Names/FQDN names of the services, the accessibility to which, is impacted </td>
<td> if not provided, it will induce network chaos for all ips/destinations or DESTINATION_IPS if already defined</td>
</tr>
<tr>
<td> SOURCE_PORTS </td>
<td> ports of the target application, the accessibility to which is impacted </td>
<td> comma separated port(s) can be provided. If not provided, it will induce network chaos for all ports</td>
</tr>
<tr>
<td> DESTINATION_PORTS </td>
<td> ports of the destination services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted </td>
<td> comma separated port(s) can be provided. If not provided, it will induce network chaos for all ports</td>
</tr>
<tr>
<td> PODS_AFFECTED_PERC </td>
@ -291,6 +301,45 @@ spec:
value: '60'
```
### Source And Destination Ports
The network experiments interrupt traffic for all the source & destination ports by default. The interruption of specific port(s) can be tuned via `SOURCE_PORTS` and `DESTINATION_PORTS` ENV.
- `SOURCE_PORTS`: It contains ports of the target application, the accessibility to which is impacted
- `DESTINATION_PORTS`: It contains the ports of the destination services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted
Use the following example to tune this:
[embedmd]:# (pod-network-latency/source-and-destination-ports.yaml yaml)
```yaml
# it inject the chaos for the ingrees and egress traffic for specific ports
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
name: engine-nginx
spec:
engineState: "active"
annotationCheck: "false"
appinfo:
appns: "default"
applabel: "app=nginx"
appkind: "deployment"
chaosServiceAccount: pod-network-latency-sa
experiments:
- name: pod-network-latency
spec:
components:
env:
# supports comma separated source ports
- name: SOURCE_PORTS
value: '80'
# supports comma separated destination ports
- name: DESTINATION_PORTS
value: '8080,9000'
- name: TOTAL_CHAOS_DURATION
value: '60'
```
### Network Interface
The defined name of the ethernet interface, which is considered for shaping traffic. It can be tuned via `NETWORK_INTERFACE` ENV. Its default value is `eth0`.

View File

@ -0,0 +1,26 @@
# it inject the chaos for the ingrees and egress traffic for specific ports
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
name: engine-nginx
spec:
engineState: "active"
annotationCheck: "false"
appinfo:
appns: "default"
applabel: "app=nginx"
appkind: "deployment"
chaosServiceAccount: pod-network-latency-sa
experiments:
- name: pod-network-latency
spec:
components:
env:
# supports comma separated source ports
- name: SOURCE_PORTS
value: '80'
# supports comma separated destination ports
- name: DESTINATION_PORTS
value: '8080,9000'
- name: TOTAL_CHAOS_DURATION
value: '60'

View File

@ -171,6 +171,16 @@
<td> DESTINATION_HOSTS </td>
<td> DNS Names/FQDN names of the services, the accessibility to which, is impacted </td>
<td> if not provided, it will induce network chaos for all ips/destinations or DESTINATION_IPS if already defined</td>
</tr>
<tr>
<td> SOURCE_PORTS </td>
<td> ports of the target application, the accessibility to which is impacted </td>
<td> comma separated port(s) can be provided. If not provided, it will induce network chaos for all ports</td>
</tr>
<tr>
<td> DESTINATION_PORTS </td>
<td> ports of the destination services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted </td>
<td> comma separated port(s) can be provided. If not provided, it will induce network chaos for all ports</td>
</tr>
<tr>
<td> PODS_AFFECTED_PERC </td>
@ -282,6 +292,45 @@ spec:
value: '60'
```
### Source And Destination Ports
The network experiments interrupt traffic for all the source & destination ports by default. The interruption of specific port(s) can be tuned via `SOURCE_PORTS` and `DESTINATION_PORTS` ENV.
- `SOURCE_PORTS`: It contains ports of the target application, the accessibility to which is impacted
- `DESTINATION_PORTS`: It contains the ports of the destination services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted
Use the following example to tune this:
[embedmd]:# (pod-network-loss/source-and-destination-ports.yaml yaml)
```yaml
# it inject the chaos for the ingrees and egress traffic for specific ports
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
name: engine-nginx
spec:
engineState: "active"
annotationCheck: "false"
appinfo:
appns: "default"
applabel: "app=nginx"
appkind: "deployment"
chaosServiceAccount: pod-network-loss-sa
experiments:
- name: pod-network-loss
spec:
components:
env:
# supports comma separated source ports
- name: SOURCE_PORTS
value: '80'
# supports comma separated destination ports
- name: DESTINATION_PORTS
value: '8080,9000'
- name: TOTAL_CHAOS_DURATION
value: '60'
```
### Network Interface
The defined name of the ethernet interface, which is considered for shaping traffic. It can be tuned via `NETWORK_INTERFACE` ENV. Its default value is `eth0`.

View File

@ -0,0 +1,26 @@
# it inject the chaos for the ingrees and egress traffic for specific ports
apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
name: engine-nginx
spec:
engineState: "active"
annotationCheck: "false"
appinfo:
appns: "default"
applabel: "app=nginx"
appkind: "deployment"
chaosServiceAccount: pod-network-loss-sa
experiments:
- name: pod-network-loss
spec:
components:
env:
# supports comma separated source ports
- name: SOURCE_PORTS
value: '80'
# supports comma separated destination ports
- name: DESTINATION_PORTS
value: '8080,9000'
- name: TOTAL_CHAOS_DURATION
value: '60'