add_latency

Type	action
Module	chaosk8s.chaosmesh.network.actions
Name	add_latency
Return	mapping

Usage

JSON

{
  "name": "add-latency",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosk8s.chaosmesh.network.actions",
    "func": "add_latency",
    "arguments": {
      "name": ""
    }
  }
}

YAML

name: add-latency
provider:
  arguments:
    name: ''
  func: add_latency
  module: chaosk8s.chaosmesh.network.actions
  type: python
type: action

Arguments

Name	Type	Default	Required	Title	Description
name	string		Yes	Name	A unique name to identify this particular fault
direction	string	to	No	Direction	Which direction to apply the latency: from, to or both
latency	string		Yes	Latency	Latency to add to the network, e.g. 20ms
jitter	string		No	Jitter	How much jitter to set, for instance 1ms
correlation	string		No	Correlation	How much correlation between two pass of latency injection. Between 0 and 100
ns	string	default	No	Namespace	Namespace where to apply the fault
namespaces_selectors	string		No	Namespaces Selectors	Comma-separated list of namespaces to scope the pod which is submitted to latency
label_selectors	string		No	Label Selectors	Comma-separated list of key=value pairs to scope the pod which is submitted to latency
annotations_selectors	string		No	Annotation Selectors	Comma-separated list of key=value pairs to scope the pod which is submitted to latency
mode	string	one	No	Mode	Mode of fault injection: one, all, fixed, fixed-percent, random-max-percent
mode_value	string		No	Mode Value	Value depending on the mode above. It must be set when mode is fixed, fixed-percent or random-max-percent
external_targets	string		No	External Targets	IPv4 or domain targetted by the fault when direction is set to “to”
target_namespaces_selectors	string		No	Target Namespaces Selectors	Comma-separated list of namespaces to limit the latency on the link with that specific pod. Only required when direction is set to both or from
target_label_selectors	string		No	Target Label Selectors	Comma-separated list of key=value pairs to limit the latency on the link with that specific pod. Only required when direction is set to both or from
target_annotations_selectors	string		No	Target Annotation Selectors	Comma-separated list of key=value pairs to limit the latency on the link with that specific pod. Only required when direction is set to both or from
target_mode	string	one	No	Target Mode	Target Mode of fault injection: one, all, fixed, fixed-percent, random-max-percent
target_mode_value	string		No	Target Mode Value	Value depending on the mode above

This action relies on Chaos Mesh to perform the fault. Make sure to install it before hand.

Signature

def add_latency(name: str,
                ns: str = 'default',
                namespaces_selectors: Union[str, List[str], NoneType] = None,
                label_selectors: Union[str, Dict[str, Any], NoneType] = None,
                annotations_selectors: Union[str, Dict[str, Any],
                                             NoneType] = None,
                mode: str = 'one',
                mode_value: Optional[str] = None,
                direction: str = 'to',
                latency: Optional[str] = None,
                correlation: Optional[str] = None,
                jitter: Optional[str] = None,
                external_targets: Union[str, List[str], NoneType] = None,
                target_mode: Optional[str] = 'one',
                target_mode_value: Optional[str] = None,
                target_namespaces_selectors: Union[str, List[str],
                                                   NoneType] = None,
                target_label_selectors: Union[str, Dict[str, Any],
                                              NoneType] = None,
                target_annotations_selectors: Union[str, Dict[str, Any],
                                                    NoneType] = None,
                secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass