chaosmeshorg

package
v1.28.13 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 16, 2024 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

chaos-meshorg

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NetworkChaos_GVK 

func NetworkChaos_GVK() *cdk8s.GroupVersionKind

func NetworkChaos_IsConstruct 

func NetworkChaos_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func NetworkChaos_Manifest 

func NetworkChaos_Manifest(props *NetworkChaosProps) interface{}

Renders a Kubernetes manifest for "NetworkChaos".

This can be used to inline resource manifests inside other objects (e.g. as templates).

func NetworkChaos_Of 

func NetworkChaos_Of(c constructs.IConstruct) cdk8s.ApiObject

Returns the `ApiObject` named `Resource` which is a child of the given construct.

If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`.

func NewNetworkChaos_Override 

func NewNetworkChaos_Override(n NetworkChaos, scope constructs.Construct, id *string, props *NetworkChaosProps)

Defines a "NetworkChaos" API object.

Types

type NetworkChaos 

type NetworkChaos interface {
	cdk8s.ApiObject
	// The group portion of the API version (e.g. `authorization.k8s.io`).
	ApiGroup() *string
	// The object's API version (e.g. `authorization.k8s.io/v1`).
	ApiVersion() *string
	// The chart in which this object is defined.
	Chart() cdk8s.Chart
	// The object kind.
	Kind() *string
	// Metadata associated with this API object.
	Metadata() cdk8s.ApiObjectMetadataDefinition
	// The name of the API object.
	//
	// If a name is specified in `metadata.name` this will be the name returned.
	// Otherwise, a name will be generated by calling
	// `Chart.of(this).generatedObjectName(this)`, which by default uses the
	// construct path to generate a DNS-compatible name for the resource.
	Name() *string
	// The tree node.
	Node() constructs.Node
	// Create a dependency between this ApiObject and other constructs.
	//
	// These can be other ApiObjects, Charts, or custom.
	AddDependency(dependencies ...constructs.IConstruct)
	// Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
	//
	// Example:
	//     kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true));
	//
	AddJsonPatch(ops ...cdk8s.JsonPatch)
	// Renders the object to Kubernetes JSON.
	ToJson() interface{}
	// Returns a string representation of this construct.
	ToString() *string
}

NetworkChaos is the Schema for the networkchaos API.

func NewNetworkChaos 

func NewNetworkChaos(scope constructs.Construct, id *string, props *NetworkChaosProps) NetworkChaos

Defines a "NetworkChaos" API object.

type NetworkChaosProps 

type NetworkChaosProps struct {
	// Spec defines the behavior of a pod chaos experiment.
	Spec     *NetworkChaosSpec        `field:"required" json:"spec" yaml:"spec"`
	Metadata *cdk8s.ApiObjectMetadata `field:"optional" json:"metadata" yaml:"metadata"`
}

NetworkChaos is the Schema for the networkchaos API.

type NetworkChaosSpec 

type NetworkChaosSpec struct {
	// Action defines the specific network chaos action.
	//
	// Supported action: partition, netem, delay, loss, duplicate, corrupt Default action: delay.
	Action NetworkChaosSpecAction `field:"required" json:"action" yaml:"action"`
	// Mode defines the mode to run chaos action.
	//
	// Supported mode: one / all / fixed / fixed-percent / random-max-percent.
	Mode NetworkChaosSpecMode `field:"required" json:"mode" yaml:"mode"`
	// Selector is used to select pods that are used to inject chaos action.
	Selector *NetworkChaosSpecSelector `field:"required" json:"selector" yaml:"selector"`
	// Bandwidth represents the detail about bandwidth control action.
	Bandwidth *NetworkChaosSpecBandwidth `field:"optional" json:"bandwidth" yaml:"bandwidth"`
	// Corrupt represents the detail about corrupt action.
	Corrupt *NetworkChaosSpecCorrupt `field:"optional" json:"corrupt" yaml:"corrupt"`
	// Delay represents the detail about delay action.
	Delay *NetworkChaosSpecDelay `field:"optional" json:"delay" yaml:"delay"`
	// Direction represents the direction, this applies on netem and network partition action.
	Direction NetworkChaosSpecDirection `field:"optional" json:"direction" yaml:"direction"`
	// DuplicateSpec represents the detail about loss action.
	Duplicate *NetworkChaosSpecDuplicate `field:"optional" json:"duplicate" yaml:"duplicate"`
	// Duration represents the duration of the chaos action.
	Duration *string `field:"optional" json:"duration" yaml:"duration"`
	// ExternalTargets represents network targets outside k8s.
	ExternalTargets *[]*string `field:"optional" json:"externalTargets" yaml:"externalTargets"`
	// Loss represents the detail about loss action.
	Loss *NetworkChaosSpecLoss `field:"optional" json:"loss" yaml:"loss"`
	// Target represents network target, this applies on netem and network partition action.
	Target *NetworkChaosSpecTarget `field:"optional" json:"target" yaml:"target"`
	// Value is required when the mode is set to `FixedPodMode` / `FixedPercentPodMod` / `RandomMaxPercentPodMod`.
	//
	// If `FixedPodMode`, provide an integer of pods to do chaos action. If `FixedPercentPodMod`, provide a number from 0-100 to specify the percent of pods the server can do chaos action. IF `RandomMaxPercentPodMod`,  provide a number from 0-100 to specify the max percent of pods to do chaos action
	Value *string `field:"optional" json:"value" yaml:"value"`
}

Spec defines the behavior of a pod chaos experiment.

type NetworkChaosSpecAction 

type NetworkChaosSpecAction string

Action defines the specific network chaos action.

Supported action: partition, netem, delay, loss, duplicate, corrupt Default action: delay. 

const (
	// netem.
	NetworkChaosSpecAction_NETEM NetworkChaosSpecAction = "NETEM"
	// delay.
	NetworkChaosSpecAction_DELAY NetworkChaosSpecAction = "DELAY"
	// loss.
	NetworkChaosSpecAction_LOSS NetworkChaosSpecAction = "LOSS"
	// duplicate.
	NetworkChaosSpecAction_DUPLICATE NetworkChaosSpecAction = "DUPLICATE"
	// corrupt.
	NetworkChaosSpecAction_CORRUPT NetworkChaosSpecAction = "CORRUPT"
	// partition.
	NetworkChaosSpecAction_PARTITION NetworkChaosSpecAction = "PARTITION"
	// bandwidth.
	NetworkChaosSpecAction_BANDWIDTH NetworkChaosSpecAction = "BANDWIDTH"
)

type NetworkChaosSpecBandwidth 

type NetworkChaosSpecBandwidth struct {
	// Buffer is the maximum amount of bytes that tokens can be available for instantaneously.
	Buffer *float64 `field:"required" json:"buffer" yaml:"buffer"`
	// Limit is the number of bytes that can be queued waiting for tokens to become available.
	Limit *float64 `field:"required" json:"limit" yaml:"limit"`
	// Rate is the speed knob.
	//
	// Allows bps, kbps, mbps, gbps, tbps unit. bps means bytes per second.
	Rate *string `field:"required" json:"rate" yaml:"rate"`
	// Minburst specifies the size of the peakrate bucket.
	//
	// For perfect accuracy, should be set to the MTU of the interface.  If a peakrate is needed, but some burstiness is acceptable, this size can be raised. A 3000 byte minburst allows around 3mbit/s of peakrate, given 1000 byte packets.
	Minburst *float64 `field:"optional" json:"minburst" yaml:"minburst"`
	// Peakrate is the maximum depletion rate of the bucket.
	//
	// The peakrate does not need to be set, it is only necessary if perfect millisecond timescale shaping is required.
	Peakrate *float64 `field:"optional" json:"peakrate" yaml:"peakrate"`
}

Bandwidth represents the detail about bandwidth control action.

type NetworkChaosSpecCorrupt 

type NetworkChaosSpecCorrupt struct {
	Corrupt     *string `field:"required" json:"corrupt" yaml:"corrupt"`
	Correlation *string `field:"optional" json:"correlation" yaml:"correlation"`
}

Corrupt represents the detail about corrupt action.

type NetworkChaosSpecDelay 

type NetworkChaosSpecDelay struct {
	Latency     *string `field:"required" json:"latency" yaml:"latency"`
	Correlation *string `field:"optional" json:"correlation" yaml:"correlation"`
	Jitter      *string `field:"optional" json:"jitter" yaml:"jitter"`
	// ReorderSpec defines details of packet reorder.
	Reorder *NetworkChaosSpecDelayReorder `field:"optional" json:"reorder" yaml:"reorder"`
}

Delay represents the detail about delay action.

type NetworkChaosSpecDelayReorder 

type NetworkChaosSpecDelayReorder struct {
	Gap         *float64 `field:"required" json:"gap" yaml:"gap"`
	Reorder     *string  `field:"required" json:"reorder" yaml:"reorder"`
	Correlation *string  `field:"optional" json:"correlation" yaml:"correlation"`
}

ReorderSpec defines details of packet reorder.

type NetworkChaosSpecDirection 

type NetworkChaosSpecDirection string

Direction represents the direction, this applies on netem and network partition action. 

const (
	// to.
	NetworkChaosSpecDirection_TO NetworkChaosSpecDirection = "TO"
	// from.
	NetworkChaosSpecDirection_FROM NetworkChaosSpecDirection = "FROM"
	// both.
	NetworkChaosSpecDirection_BOTH   NetworkChaosSpecDirection = "BOTH"
	NetworkChaosSpecDirection_VALUE_ NetworkChaosSpecDirection = "VALUE_"
)

type NetworkChaosSpecDuplicate 

type NetworkChaosSpecDuplicate struct {
	Duplicate   *string `field:"required" json:"duplicate" yaml:"duplicate"`
	Correlation *string `field:"optional" json:"correlation" yaml:"correlation"`
}

DuplicateSpec represents the detail about loss action.

type NetworkChaosSpecLoss 

type NetworkChaosSpecLoss struct {
	Loss        *string `field:"required" json:"loss" yaml:"loss"`
	Correlation *string `field:"optional" json:"correlation" yaml:"correlation"`
}

Loss represents the detail about loss action.

type NetworkChaosSpecMode 

type NetworkChaosSpecMode string

Mode defines the mode to run chaos action.

Supported mode: one / all / fixed / fixed-percent / random-max-percent. 

const (
	// one.
	NetworkChaosSpecMode_ONE NetworkChaosSpecMode = "ONE"
	// all.
	NetworkChaosSpecMode_ALL NetworkChaosSpecMode = "ALL"
	// fixed.
	NetworkChaosSpecMode_FIXED NetworkChaosSpecMode = "FIXED"
	// fixed-percent.
	NetworkChaosSpecMode_FIXED_PERCENT NetworkChaosSpecMode = "FIXED_PERCENT"
	// random-max-percent.
	NetworkChaosSpecMode_RANDOM_MAX_PERCENT NetworkChaosSpecMode = "RANDOM_MAX_PERCENT"
)

type NetworkChaosSpecSelector 

type NetworkChaosSpecSelector struct {
	// Map of string keys and values that can be used to select objects.
	//
	// A selector based on annotations.
	AnnotationSelectors *map[string]*string `field:"optional" json:"annotationSelectors" yaml:"annotationSelectors"`
	// a slice of label selector expressions that can be used to select objects.
	//
	// A list of selectors based on set-based label expressions.
	ExpressionSelectors *[]*NetworkChaosSpecSelectorExpressionSelectors `field:"optional" json:"expressionSelectors" yaml:"expressionSelectors"`
	// Map of string keys and values that can be used to select objects.
	//
	// A selector based on fields.
	FieldSelectors *map[string]*string `field:"optional" json:"fieldSelectors" yaml:"fieldSelectors"`
	// Map of string keys and values that can be used to select objects.
	//
	// A selector based on labels.
	LabelSelectors *map[string]*string `field:"optional" json:"labelSelectors" yaml:"labelSelectors"`
	// Namespaces is a set of namespace to which objects belong.
	Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
	// Nodes is a set of node name and objects must belong to these nodes.
	Nodes *[]*string `field:"optional" json:"nodes" yaml:"nodes"`
	// Map of string keys and values that can be used to select nodes.
	//
	// Selector which must match a node's labels, and objects must belong to these selected nodes.
	NodeSelectors *map[string]*string `field:"optional" json:"nodeSelectors" yaml:"nodeSelectors"`
	// PodPhaseSelectors is a set of condition of a pod at the current time.
	//
	// supported value: Pending / Running / Succeeded / Failed / Unknown.
	PodPhaseSelectors *[]*string `field:"optional" json:"podPhaseSelectors" yaml:"podPhaseSelectors"`
	// Pods is a map of string keys and a set values that used to select pods.
	//
	// The key defines the namespace which pods belong, and the each values is a set of pod names.
	Pods *map[string]*[]*string `field:"optional" json:"pods" yaml:"pods"`
}

Selector is used to select pods that are used to inject chaos action.

type NetworkChaosSpecSelectorExpressionSelectors 

type NetworkChaosSpecSelectorExpressionSelectors struct {
	// key is the label key that the selector applies to.
	Key *string `field:"required" json:"key" yaml:"key"`
	// operator represents a key's relationship to a set of values.
	//
	// Valid operators are In, NotIn, Exists and DoesNotExist.
	Operator *string `field:"required" json:"operator" yaml:"operator"`
	// values is an array of string values.
	//
	// If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
	Values *[]*string `field:"optional" json:"values" yaml:"values"`
}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

type NetworkChaosSpecTarget 

type NetworkChaosSpecTarget struct {
	// Mode defines the mode to run chaos action.
	//
	// Supported mode: one / all / fixed / fixed-percent / random-max-percent.
	Mode NetworkChaosSpecTargetMode `field:"required" json:"mode" yaml:"mode"`
	// Selector is used to select pods that are used to inject chaos action.
	Selector *NetworkChaosSpecTargetSelector `field:"required" json:"selector" yaml:"selector"`
	// Value is required when the mode is set to `FixedPodMode` / `FixedPercentPodMod` / `RandomMaxPercentPodMod`.
	//
	// If `FixedPodMode`, provide an integer of pods to do chaos action. If `FixedPercentPodMod`, provide a number from 0-100 to specify the percent of pods the server can do chaos action. IF `RandomMaxPercentPodMod`,  provide a number from 0-100 to specify the max percent of pods to do chaos action
	Value *string `field:"optional" json:"value" yaml:"value"`
}

Target represents network target, this applies on netem and network partition action.

type NetworkChaosSpecTargetMode 

type NetworkChaosSpecTargetMode string

Mode defines the mode to run chaos action.

Supported mode: one / all / fixed / fixed-percent / random-max-percent. 

const (
	// one.
	NetworkChaosSpecTargetMode_ONE NetworkChaosSpecTargetMode = "ONE"
	// all.
	NetworkChaosSpecTargetMode_ALL NetworkChaosSpecTargetMode = "ALL"
	// fixed.
	NetworkChaosSpecTargetMode_FIXED NetworkChaosSpecTargetMode = "FIXED"
	// fixed-percent.
	NetworkChaosSpecTargetMode_FIXED_PERCENT NetworkChaosSpecTargetMode = "FIXED_PERCENT"
	// random-max-percent.
	NetworkChaosSpecTargetMode_RANDOM_MAX_PERCENT NetworkChaosSpecTargetMode = "RANDOM_MAX_PERCENT"
)

type NetworkChaosSpecTargetSelector 

type NetworkChaosSpecTargetSelector struct {
	// Map of string keys and values that can be used to select objects.
	//
	// A selector based on annotations.
	AnnotationSelectors *map[string]*string `field:"optional" json:"annotationSelectors" yaml:"annotationSelectors"`
	// a slice of label selector expressions that can be used to select objects.
	//
	// A list of selectors based on set-based label expressions.
	ExpressionSelectors *[]*NetworkChaosSpecTargetSelectorExpressionSelectors `field:"optional" json:"expressionSelectors" yaml:"expressionSelectors"`
	// Map of string keys and values that can be used to select objects.
	//
	// A selector based on fields.
	FieldSelectors *map[string]*string `field:"optional" json:"fieldSelectors" yaml:"fieldSelectors"`
	// Map of string keys and values that can be used to select objects.
	//
	// A selector based on labels.
	LabelSelectors *map[string]*string `field:"optional" json:"labelSelectors" yaml:"labelSelectors"`
	// Namespaces is a set of namespace to which objects belong.
	Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
	// Nodes is a set of node name and objects must belong to these nodes.
	Nodes *[]*string `field:"optional" json:"nodes" yaml:"nodes"`
	// Map of string keys and values that can be used to select nodes.
	//
	// Selector which must match a node's labels, and objects must belong to these selected nodes.
	NodeSelectors *map[string]*string `field:"optional" json:"nodeSelectors" yaml:"nodeSelectors"`
	// PodPhaseSelectors is a set of condition of a pod at the current time.
	//
	// supported value: Pending / Running / Succeeded / Failed / Unknown.
	PodPhaseSelectors *[]*string `field:"optional" json:"podPhaseSelectors" yaml:"podPhaseSelectors"`
	// Pods is a map of string keys and a set values that used to select pods.
	//
	// The key defines the namespace which pods belong, and the each values is a set of pod names.
	Pods *map[string]*[]*string `field:"optional" json:"pods" yaml:"pods"`
}

Selector is used to select pods that are used to inject chaos action.

type NetworkChaosSpecTargetSelectorExpressionSelectors 

type NetworkChaosSpecTargetSelectorExpressionSelectors struct {
	// key is the label key that the selector applies to.
	Key *string `field:"required" json:"key" yaml:"key"`
	// operator represents a key's relationship to a set of values.
	//
	// Valid operators are In, NotIn, Exists and DoesNotExist.
	Operator *string `field:"required" json:"operator" yaml:"operator"`
	// values is an array of string values.
	//
	// If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
	Values *[]*string `field:"optional" json:"values" yaml:"values"`
}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Source Files

View all Source files

Directories

Path Synopsis
Package jsii contains the functionality needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionality needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.