Skip to content

Files

Latest commit

6bfbb7e · Oct 14, 2024

History

History

chaos-operator

chaos-operator

Index

Schemas

ChaosEngine

litmuschaos io v1alpha1 chaos engine

Attributes

name type description default value
apiVersion required readOnly "litmuschaos.io/v1alpha1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "litmuschaos.io/v1alpha1"
kind required readOnly "ChaosEngine" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "ChaosEngine"
metadata ObjectMeta metadata
spec LitmuschaosIoV1alpha1ChaosEngineSpec spec
status any status

ChaosExperiment

litmuschaos io v1alpha1 chaos experiment

Attributes

name type description default value
apiVersion required readOnly "litmuschaos.io/v1alpha1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "litmuschaos.io/v1alpha1"
kind required readOnly "ChaosExperiment" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "ChaosExperiment"
metadata ObjectMeta metadata
spec LitmuschaosIoV1alpha1ChaosExperimentSpec spec
status any status

ChaosResult

litmuschaos io v1alpha1 chaos result

Attributes

name type description default value
apiVersion required readOnly "litmuschaos.io/v1alpha1" APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources "litmuschaos.io/v1alpha1"
kind required readOnly "ChaosResult" Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds "ChaosResult"
metadata ObjectMeta metadata
spec any spec
status any status

LitmuschaosIoV1alpha1ChaosEngineSpec

litmuschaos io v1alpha1 chaos engine spec

Attributes

name type description default value
annotationCheck str annotation check
appinfo LitmuschaosIoV1alpha1ChaosEngineSpecAppinfo appinfo
auxiliaryAppInfo str auxiliary app info
chaosServiceAccount str chaos service account
components LitmuschaosIoV1alpha1ChaosEngineSpecComponents components
engineState str engine state
experiments [LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0] experiments
jobCleanUpPolicy str job clean up policy
monitoring bool monitoring

LitmuschaosIoV1alpha1ChaosEngineSpecAppinfo

litmuschaos io v1alpha1 chaos engine spec appinfo

Attributes

name type description default value
appkind str appkind
applabel str applabel
appns str appns

LitmuschaosIoV1alpha1ChaosEngineSpecComponents

litmuschaos io v1alpha1 chaos engine spec components

Attributes

name type description default value
runner LitmuschaosIoV1alpha1ChaosEngineSpecComponentsRunner runner

LitmuschaosIoV1alpha1ChaosEngineSpecComponentsRunner

litmuschaos io v1alpha1 chaos engine spec components runner

Attributes

name type description default value
image str image
runnerannotation {str:str} runnerannotation
type str

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0

litmuschaos io v1alpha1 chaos engine spec experiments items0

Attributes

name type description default value
name str name
spec LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0Spec spec

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0Spec

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec

Attributes

name type description default value
components LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponents components
probe [LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0] probe

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponents

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec components

Attributes

name type description default value
configMaps [LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsConfigMapsItems0] config maps
env [LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0] env
experimentImage str experiment image
experimentannotation {str:str} experimentannotation
nodeSelector any node selector
secrets [LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsSecretsItems0] secrets
statusCheckTimeouts LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsStatusCheckTimeouts status check timeouts

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsConfigMapsItems0

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec components config maps items0

Attributes

name type description default value
mountPath str mount path
name str name

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0

EnvVar represents an environment variable present in a Container.

Attributes

name type description default value
name required str Name of the environment variable. Must be a C_IDENTIFIER.
value str Variable references ( V A R N A M E ) a r e e x p a n d e d u s i n g t h e p r e v i o u s d e f i n e d e n v i r o n m e n t v a r i a b l e s i n t h e c o n t a i n e r a n d a n y s e r v i c e e n v i r o n m e n t v a r i a b l e s . I f a v a r i a b l e c a n n o t b e r e s o l v e d , t h e r e f e r e n c e i n t h e i n p u t s t r i n g w i l l b e u n c h a n g e d . T h e (VAR_NAME) syntax can be escaped with a double , i e : (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
valueFrom LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFrom value from

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFrom

Source for the environment variable's value. Cannot be used if value is not empty.

Attributes

name type description default value
configMapKeyRef LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFromConfigMapKeyRef config map key ref
fieldRef LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFromFieldRef field ref
resourceFieldRef LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFromResourceFieldRef resource field ref
secretKeyRef LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFromSecretKeyRef secret key ref

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFromConfigMapKeyRef

Selects a key of a ConfigMap.

Attributes

name type description default value
key required str The key to select.
name str Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional bool Specify whether the ConfigMap or its key must be defined

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFromFieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.

Attributes

name type description default value
apiVersion str Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath required str Path of the field to select in the specified API version.

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFromResourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

Attributes

name type description default value
containerName str Container name: required for volumes, optional for env vars
divisor any Specifies the output format of the exposed resources, defaults to "1"
resource required str Required: resource to select

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsEnvItems0ValueFromSecretKeyRef

Selects a key of a secret in the pod's namespace

Attributes

name type description default value
key required str The key of the secret to select from. Must be a valid secret key.
name str Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional bool Specify whether the Secret or its key must be defined

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsSecretsItems0

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec components secrets items0

Attributes

name type description default value
mountPath str mount path
name str name

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecComponentsStatusCheckTimeouts

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec components status check timeouts

Attributes

name type description default value
delay int delay
timeout int timeout

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec probe items0

Attributes

name type description default value

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0CmdProbeInputs

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec probe items0 cmd probe inputs

Attributes

name type description default value
command str command
comparator LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0CmdProbeInputsComparator comparator
source str source

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0CmdProbeInputsComparator

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec probe items0 cmd probe inputs comparator

Attributes

name type description default value
criteria str criteria
type str
value str value

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0HTTPProbeInputs

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec probe items0 HTTP probe inputs

Attributes

name type description default value
expectedResponseCode str expected response code
insecureSkipVerify bool insecure skip verify
url str url

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0K8sProbeInputs

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec probe items0 k8s probe inputs

Attributes

name type description default value
command LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0K8sProbeInputsCommand command

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0K8sProbeInputsCommand

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec probe items0 k8s probe inputs command

Attributes

name type description default value
fieldSelector str field selector
group str group
labelSelector str label selector
namespace str namespace
resource str resource
version str version

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0PromProbeInputs

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec probe items0 prom probe inputs

Attributes

name type description default value
comparator LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0PromProbeInputsComparator comparator
endpoint str endpoint
query str query
queryPath str query path

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0PromProbeInputsComparator

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec probe items0 prom probe inputs comparator

Attributes

name type description default value
criteria str criteria
value str value

LitmuschaosIoV1alpha1ChaosEngineSpecExperimentsItems0SpecProbeItems0RunProperties

litmuschaos io v1alpha1 chaos engine spec experiments items0 spec probe items0 run properties

Attributes

name type description default value
initialDelaySeconds int initial delay seconds
interval required int interval
probePollingInterval int probe polling interval
probeTimeout required int probe timeout
retry required int retry

LitmuschaosIoV1alpha1ChaosExperimentSpec

litmuschaos io v1alpha1 chaos experiment spec

Attributes

name type description default value
definition LitmuschaosIoV1alpha1ChaosExperimentSpecDefinition definition

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinition

litmuschaos io v1alpha1 chaos experiment spec definition

Attributes

name type description default value
args [str] args
command [str] command
configmaps [LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionConfigmapsItems0] configmaps
env [LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0] List of ENV vars passed to chaosexperiment pod
hostFileVolumes [LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionHostFileVolumesItems0] host file volumes
hostPID bool host p ID
image str image
labels LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionLabels labels
permissions [LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionPermissionsItems0] permissions
scope str scope
secrets [LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionSecretsItems0] secrets
securityContext any security context

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionConfigmapsItems0

litmuschaos io v1alpha1 chaos experiment spec definition configmaps items0

Attributes

name type description default value
mountPath str mount path
name str name

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0

EnvVar represents an environment variable present in a Container.

Attributes

name type description default value
name required str Name of the environment variable. Must be a C_IDENTIFIER.
value str Variable references ( V A R N A M E ) a r e e x p a n d e d u s i n g t h e p r e v i o u s d e f i n e d e n v i r o n m e n t v a r i a b l e s i n t h e c o n t a i n e r a n d a n y s e r v i c e e n v i r o n m e n t v a r i a b l e s . I f a v a r i a b l e c a n n o t b e r e s o l v e d , t h e r e f e r e n c e i n t h e i n p u t s t r i n g w i l l b e u n c h a n g e d . T h e (VAR_NAME) syntax can be escaped with a double , i e : (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
valueFrom LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFrom value from

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFrom

Source for the environment variable's value. Cannot be used if value is not empty.

Attributes

name type description default value
configMapKeyRef LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFromConfigMapKeyRef config map key ref
fieldRef LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFromFieldRef field ref
resourceFieldRef LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFromResourceFieldRef resource field ref
secretKeyRef LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFromSecretKeyRef secret key ref

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFromConfigMapKeyRef

Selects a key of a ConfigMap.

Attributes

name type description default value
key required str The key to select.
name str Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional bool Specify whether the ConfigMap or its key must be defined

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFromFieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.

Attributes

name type description default value
apiVersion str Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath required str Path of the field to select in the specified API version.

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFromResourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

Attributes

name type description default value
containerName str Container name: required for volumes, optional for env vars
divisor any Specifies the output format of the exposed resources, defaults to "1"
resource required str Required: resource to select

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionEnvItems0ValueFromSecretKeyRef

Selects a key of a secret in the pod's namespace

Attributes

name type description default value
key required str The key of the secret to select from. Must be a valid secret key.
name str Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
optional bool Specify whether the Secret or its key must be defined

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionHostFileVolumesItems0

litmuschaos io v1alpha1 chaos experiment spec definition host file volumes items0

Attributes

name type description default value
mountPath str mount path
name str name
nodePath str node path
type str

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionLabels

litmuschaos io v1alpha1 chaos experiment spec definition labels

Attributes

name type description default value
name str name

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionPermissionsItems0

litmuschaos io v1alpha1 chaos experiment spec definition permissions items0

Attributes

name type description default value
apiGroups required [str] api groups
nonResourceURLs [str] non resource u r ls
resourceNames [str] resource names
resources required [str] resources
verbs required [str] verbs

LitmuschaosIoV1alpha1ChaosExperimentSpecDefinitionSecretsItems0

litmuschaos io v1alpha1 chaos experiment spec definition secrets items0

Attributes

name type description default value
mountPath str mount path
name str name