Skip to content

litmuschaos.v1alpha1.chaosSchedule

Index

Fields

fn new

new(name)

new returns an instance of ChaosSchedule

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

fn spec.withConcurrencyPolicy

withConcurrencyPolicy(concurrencyPolicy)

fn spec.withScheduleState

withScheduleState(scheduleState)

obj spec.engineTemplateSpec

fn spec.engineTemplateSpec.withAuxiliaryAppInfo

withAuxiliaryAppInfo(auxiliaryAppInfo)

fn spec.engineTemplateSpec.withChaosServiceAccount

withChaosServiceAccount(chaosServiceAccount)

fn spec.engineTemplateSpec.withDefaultHealthCheck

withDefaultHealthCheck(defaultHealthCheck)

fn spec.engineTemplateSpec.withEngineState

withEngineState(engineState)

fn spec.engineTemplateSpec.withExperiments

withExperiments(experiments)

fn spec.engineTemplateSpec.withExperimentsMixin

withExperimentsMixin(experiments)

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.withJobCleanUpPolicy

withJobCleanUpPolicy(jobCleanUpPolicy)

fn spec.engineTemplateSpec.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

obj spec.engineTemplateSpec.appinfo

fn spec.engineTemplateSpec.appinfo.withAppkind

withAppkind(appkind)

fn spec.engineTemplateSpec.appinfo.withApplabel

withApplabel(applabel)

fn spec.engineTemplateSpec.appinfo.withAppns

withAppns(appns)

obj spec.engineTemplateSpec.components

fn spec.engineTemplateSpec.components.withSidecar

withSidecar(sidecar)

fn spec.engineTemplateSpec.components.withSidecarMixin

withSidecarMixin(sidecar)

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.components.runner

fn spec.engineTemplateSpec.components.runner.withImage

withImage(image)

fn spec.engineTemplateSpec.components.runner.withRunnerAnnotations

withRunnerAnnotations(runnerAnnotations)

fn spec.engineTemplateSpec.components.runner.withRunnerAnnotationsMixin

withRunnerAnnotationsMixin(runnerAnnotations)

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.components.runner.withRunnerLabels

withRunnerLabels(runnerLabels)

fn spec.engineTemplateSpec.components.runner.withRunnerLabelsMixin

withRunnerLabelsMixin(runnerLabels)

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.components.runner.withTolerations

withTolerations(tolerations)

"Pod's tolerations."

fn spec.engineTemplateSpec.components.runner.withTolerationsMixin

withTolerationsMixin(tolerations)

"Pod's tolerations."

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.components.runner.withType

withType(type)

obj spec.engineTemplateSpec.components.runner.tolerations

"Pod's tolerations."

fn spec.engineTemplateSpec.components.runner.tolerations.withEffect

withEffect(effect)

"Effect to match. Empty means all effects."

fn spec.engineTemplateSpec.components.runner.tolerations.withKey

withKey(key)

"Taint key the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists."

fn spec.engineTemplateSpec.components.runner.tolerations.withOperator

withOperator(operator)

"Operators are Exists or Equal. Defaults to Equal."

fn spec.engineTemplateSpec.components.runner.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"Period of time the toleration tolerates the taint."

fn spec.engineTemplateSpec.components.runner.tolerations.withValue

withValue(value)

"If the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.engineTemplateSpec.components.sidecar

fn spec.engineTemplateSpec.components.sidecar.withEnv

withEnv(env)

"ENV contains ENV passed to the sidecar container"

fn spec.engineTemplateSpec.components.sidecar.withEnvFrom

withEnvFrom(envFrom)

"EnvFrom for the sidecar container"

fn spec.engineTemplateSpec.components.sidecar.withEnvFromMixin

withEnvFromMixin(envFrom)

"EnvFrom for the sidecar container"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.components.sidecar.withEnvMixin

withEnvMixin(env)

"ENV contains ENV passed to the sidecar container"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.components.sidecar.withImage

withImage(image)

fn spec.engineTemplateSpec.components.sidecar.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

fn spec.engineTemplateSpec.components.sidecar.withSecrets

withSecrets(secrets)

fn spec.engineTemplateSpec.components.sidecar.withSecretsMixin

withSecretsMixin(secrets)

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.components.sidecar.env

"ENV contains ENV passed to the sidecar container"

fn spec.engineTemplateSpec.components.sidecar.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.engineTemplateSpec.components.sidecar.env.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"."

obj spec.engineTemplateSpec.components.sidecar.env.valueFrom

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

obj spec.engineTemplateSpec.components.sidecar.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.engineTemplateSpec.components.sidecar.env.valueFrom.fieldRef

"Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.engineTemplateSpec.components.sidecar.env.valueFrom.resourceFieldRef

"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."

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.engineTemplateSpec.components.sidecar.env.valueFrom.secretKeyRef

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

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.components.sidecar.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.engineTemplateSpec.components.sidecar.envFrom

"EnvFrom for the sidecar container"

fn spec.engineTemplateSpec.components.sidecar.envFrom.withPrefix

withPrefix(prefix)

"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."

obj spec.engineTemplateSpec.components.sidecar.envFrom.configMapRef

"The ConfigMap to select from"

fn spec.engineTemplateSpec.components.sidecar.envFrom.configMapRef.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.components.sidecar.envFrom.configMapRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap must be defined"

obj spec.engineTemplateSpec.components.sidecar.envFrom.secretRef

"The Secret to select from"

fn spec.engineTemplateSpec.components.sidecar.envFrom.secretRef.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.components.sidecar.envFrom.secretRef.withOptional

withOptional(optional)

"Specify whether the Secret must be defined"

obj spec.engineTemplateSpec.components.sidecar.secrets

fn spec.engineTemplateSpec.components.sidecar.secrets.withMountPath

withMountPath(mountPath)

fn spec.engineTemplateSpec.components.sidecar.secrets.withName

withName(name)

obj spec.engineTemplateSpec.experiments

fn spec.engineTemplateSpec.experiments.withName

withName(name)

obj spec.engineTemplateSpec.experiments.spec

fn spec.engineTemplateSpec.experiments.spec.withProbe

withProbe(probe)

fn spec.engineTemplateSpec.experiments.spec.withProbeMixin

withProbeMixin(probe)

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.experiments.spec.components

fn spec.engineTemplateSpec.experiments.spec.components.withConfigMaps

withConfigMaps(configMaps)

fn spec.engineTemplateSpec.experiments.spec.components.withConfigMapsMixin

withConfigMapsMixin(configMaps)

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.components.withEnv

withEnv(env)

fn spec.engineTemplateSpec.experiments.spec.components.withEnvMixin

withEnvMixin(env)

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.components.withExperimentAnnotations

withExperimentAnnotations(experimentAnnotations)

fn spec.engineTemplateSpec.experiments.spec.components.withExperimentAnnotationsMixin

withExperimentAnnotationsMixin(experimentAnnotations)

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.components.withExperimentImage

withExperimentImage(experimentImage)

fn spec.engineTemplateSpec.experiments.spec.components.withNodeSelector

withNodeSelector(nodeSelector)

fn spec.engineTemplateSpec.experiments.spec.components.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.components.withSecrets

withSecrets(secrets)

fn spec.engineTemplateSpec.experiments.spec.components.withSecretsMixin

withSecretsMixin(secrets)

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.components.withTolerations

withTolerations(tolerations)

"Pod's tolerations."

fn spec.engineTemplateSpec.experiments.spec.components.withTolerationsMixin

withTolerationsMixin(tolerations)

"Pod's tolerations."

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.experiments.spec.components.configMaps

fn spec.engineTemplateSpec.experiments.spec.components.configMaps.withMountPath

withMountPath(mountPath)

fn spec.engineTemplateSpec.experiments.spec.components.configMaps.withName

withName(name)

obj spec.engineTemplateSpec.experiments.spec.components.env

fn spec.engineTemplateSpec.experiments.spec.components.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.engineTemplateSpec.experiments.spec.components.env.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"."

obj spec.engineTemplateSpec.experiments.spec.components.env.valueFrom

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

obj spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.fieldRef

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

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.resourceFieldRef

"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."

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.secretKeyRef

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

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.experiments.spec.components.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.engineTemplateSpec.experiments.spec.components.secrets

fn spec.engineTemplateSpec.experiments.spec.components.secrets.withMountPath

withMountPath(mountPath)

fn spec.engineTemplateSpec.experiments.spec.components.secrets.withName

withName(name)

obj spec.engineTemplateSpec.experiments.spec.components.statusCheckTimeouts

fn spec.engineTemplateSpec.experiments.spec.components.statusCheckTimeouts.withDelay

withDelay(delay)

fn spec.engineTemplateSpec.experiments.spec.components.statusCheckTimeouts.withTimeout

withTimeout(timeout)

obj spec.engineTemplateSpec.experiments.spec.components.tolerations

"Pod's tolerations."

fn spec.engineTemplateSpec.experiments.spec.components.tolerations.withEffect

withEffect(effect)

"Effect to match. Empty means all effects."

fn spec.engineTemplateSpec.experiments.spec.components.tolerations.withKey

withKey(key)

"Taint key the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists."

fn spec.engineTemplateSpec.experiments.spec.components.tolerations.withOperator

withOperator(operator)

"Operators are Exists or Equal. Defaults to Equal."

fn spec.engineTemplateSpec.experiments.spec.components.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"Period of time the toleration tolerates the taint."

fn spec.engineTemplateSpec.experiments.spec.components.tolerations.withValue

withValue(value)

"If the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.engineTemplateSpec.experiments.spec.probe

fn spec.engineTemplateSpec.experiments.spec.probe.withData

withData(data)

fn spec.engineTemplateSpec.experiments.spec.probe.withMode

withMode(mode)

fn spec.engineTemplateSpec.experiments.spec.probe.withName

withName(name)

fn spec.engineTemplateSpec.experiments.spec.probe.withType

withType(type)

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.withCommand

withCommand(command)

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.comparator

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.comparator.withCriteria

withCriteria(criteria)

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.comparator.withType

withType(type)

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.comparator.withValue

withValue(value)

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source

"The external pod where we have to run the probe commands. It will run the commands inside the experiment pod itself(inline mode) if source contains a nil value"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withAnnotations

withAnnotations(annotations)

"Annotations for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations for the source pod"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withArgs

withArgs(args)

"Args for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withArgsMixin

withArgsMixin(args)

"Args for the source pod"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withCommand

withCommand(command)

"Command for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withCommandMixin

withCommandMixin(command)

"Command for the source pod"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withEnv

withEnv(env)

"ENVList contains ENV passed to the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withEnvMixin

withEnvMixin(env)

"ENVList contains ENV passed to the source pod"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withHostNetwork

withHostNetwork(hostNetwork)

"HostNetwork define the hostNetwork of the external pod it supports boolean values and default value is false"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withImage

withImage(image)

"Image for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

"ImagePullSecrets for source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

"ImagePullSecrets for source pod"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withInheritInputs

withInheritInputs(inheritInputs)

"InheritInputs define to inherit experiment details in probe pod it supports boolean values and default value is false."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withLabels

withLabels(labels)

"Labels for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withLabelsMixin

withLabelsMixin(labels)

"Labels for the source pod"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector for the source pod"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withPrivileged

withPrivileged(privileged)

"Privileged for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withTolerations

withTolerations(tolerations)

"Tolerations for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations for the source pod"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withVolumeMount

withVolumeMount(volumeMount)

"VolumesMount for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withVolumeMountMixin

withVolumeMountMixin(volumeMount)

"VolumesMount for the source pod"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withVolumes

withVolumes(volumes)

"Volumes for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.withVolumesMixin

withVolumesMixin(volumes)

"Volumes for the source pod"

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env

"ENVList contains ENV passed to the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.withValue

withValue(value)

"Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom

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

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.fieldRef

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

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.resourceFieldRef

"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."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.secretKeyRef

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

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.imagePullSecrets

"ImagePullSecrets for source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.imagePullSecrets.withName

withName(name)

"Name of the referent"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.tolerations

"Tolerations for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.tolerations.withEffect

withEffect(effect)

"Effect to match. Empty means all effects."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.tolerations.withKey

withKey(key)

"Taint key the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.tolerations.withOperator

withOperator(operator)

"Operators are Exists or Equal. Defaults to Equal."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"Period of time the toleration tolerates the taint."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.tolerations.withValue

withValue(value)

"If the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumeMount

"VolumesMount for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumeMount.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumeMount.withMountPropagation

withMountPropagation(mountPropagation)

"mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumeMount.withName

withName(name)

"This must match the Name of a Volume."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumeMount.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumeMount.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumeMount.withSubPathExpr

withSubPathExpr(subPathExpr)

"Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive. This field is beta in 1.15."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes

"Volumes for the source pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.withName

withName(name)

"Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.awsElasticBlockStore

"AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.awsElasticBlockStore.withFsType

withFsType(fsType)

"Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.awsElasticBlockStore.withPartition

withPartition(partition)

"The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.awsElasticBlockStore.withReadOnly

withReadOnly(readOnly)

"Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\". If omitted, the default is \"false\". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.awsElasticBlockStore.withVolumeID

withVolumeID(volumeID)

"Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureDisk

"AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureDisk.withCachingMode

withCachingMode(cachingMode)

"Host Caching mode: None, Read Only, Read Write."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureDisk.withDiskName

withDiskName(diskName)

"The Name of the data disk in the blob storage"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureDisk.withDiskURI

withDiskURI(diskURI)

"The URI the data disk in the blob storage"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureDisk.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureDisk.withKind

withKind(kind)

"Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureDisk.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureFile

"AzureFile represents an Azure File Service mount on the host and bind mount to the pod."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureFile.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureFile.withSecretName

withSecretName(secretName)

"the name of secret that contains Azure Storage Account Name and Key"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.azureFile.withShareName

withShareName(shareName)

"Share Name"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cephfs

"CephFS represents a Ceph FS mount on the host that shares a pod's lifetime"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cephfs.withMonitors

withMonitors(monitors)

"Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cephfs.withMonitorsMixin

withMonitorsMixin(monitors)

"Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cephfs.withPath

withPath(path)

"Optional: Used as the mounted root, rather than the full Ceph tree, default is /"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cephfs.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cephfs.withSecretFile

withSecretFile(secretFile)

"Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cephfs.withUser

withUser(user)

"Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cephfs.secretRef

"Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cephfs.secretRef.withName

withName(name)

"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?"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cinder

"Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cinder.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cinder.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cinder.withVolumeID

withVolumeID(volumeID)

"volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cinder.secretRef

"Optional: points to a secret object containing parameters used to connect to OpenStack."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.cinder.secretRef.withName

withName(name)

"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?"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap

"ConfigMap represents a configMap that should populate this volume"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap.withDefaultMode

withDefaultMode(defaultMode)

"Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap.withItems

withItems(items)

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap.withItemsMixin

withItemsMixin(items)

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its keys must be defined"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap.items

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap.items.withKey

withKey(key)

"The key to project."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.configMap.items.withPath

withPath(path)

"The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.csi

"CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature)."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.csi.withDriver

withDriver(driver)

"Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.csi.withFsType

withFsType(fsType)

"Filesystem type to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.csi.withReadOnly

withReadOnly(readOnly)

"Specifies a read-only configuration for the volume. Defaults to false (read/write)."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

"VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

"VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.csi.nodePublishSecretRef

"NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.csi.nodePublishSecretRef.withName

withName(name)

"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?"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI

"DownwardAPI represents downward API about the pod that should populate this volume"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.withDefaultMode

withDefaultMode(defaultMode)

"Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.withItems

withItems(items)

"Items is a list of downward API volume file"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of downward API volume file"

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items

"Items is a list of downward API volume file"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items.withPath

withPath(path)

"Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items.fieldRef

"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items.resourceFieldRef

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

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.emptyDir

"EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.emptyDir.withMedium

withMedium(medium)

"What type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

"Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.fc

"FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.fc.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.fc.withLun

withLun(lun)

"Optional: FC target lun number"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.fc.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.fc.withTargetWWNs

withTargetWWNs(targetWWNs)

"Optional: FC target worldwide names (WWNs)"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.fc.withTargetWWNsMixin

withTargetWWNsMixin(targetWWNs)

"Optional: FC target worldwide names (WWNs)"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.fc.withWwids

withWwids(wwids)

"Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.fc.withWwidsMixin

withWwidsMixin(wwids)

"Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flexVolume

"FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flexVolume.withDriver

withDriver(driver)

"Driver is the name of the driver to use for this volume."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flexVolume.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flexVolume.withOptions

withOptions(options)

"Optional: Extra command options if any."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flexVolume.withOptionsMixin

withOptionsMixin(options)

"Optional: Extra command options if any."

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flexVolume.withReadOnly

withReadOnly(readOnly)

"Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flexVolume.secretRef

"Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flexVolume.secretRef.withName

withName(name)

"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?"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flocker

"Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flocker.withDatasetName

withDatasetName(datasetName)

"Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.flocker.withDatasetUUID

withDatasetUUID(datasetUUID)

"UUID of the dataset. This is unique identifier of a Flocker dataset"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.gcePersistentDisk

"GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.gcePersistentDisk.withFsType

withFsType(fsType)

"Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.gcePersistentDisk.withPartition

withPartition(partition)

"The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.gcePersistentDisk.withPdName

withPdName(pdName)

"Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.gcePersistentDisk.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.gitRepo

"GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.gitRepo.withDirectory

withDirectory(directory)

"Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.gitRepo.withRepository

withRepository(repository)

"Repository URL"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.gitRepo.withRevision

withRevision(revision)

"Commit hash for the specified revision."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.glusterfs

"Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.glusterfs.withEndpoints

withEndpoints(endpoints)

"EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.glusterfs.withPath

withPath(path)

"Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.glusterfs.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.hostPath

"HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.hostPath.withPath

withPath(path)

"Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.hostPath.withType

withType(type)

"Type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi

"ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withChapAuthDiscovery

withChapAuthDiscovery(chapAuthDiscovery)

"whether support iSCSI Discovery CHAP authentication"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withChapAuthSession

withChapAuthSession(chapAuthSession)

"whether support iSCSI Session CHAP authentication"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withFsType

withFsType(fsType)

"Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withInitiatorName

withInitiatorName(initiatorName)

"Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withIqn

withIqn(iqn)

"Target iSCSI Qualified Name."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withIscsiInterface

withIscsiInterface(iscsiInterface)

"iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp)."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withLun

withLun(lun)

"iSCSI Target Lun number."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withPortals

withPortals(portals)

"iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withPortalsMixin

withPortalsMixin(portals)

"iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.withTargetPortal

withTargetPortal(targetPortal)

"iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.secretRef

"CHAP Secret for iSCSI target and initiator authentication"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.iscsi.secretRef.withName

withName(name)

"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?"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.nfs

"NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.nfs.withPath

withPath(path)

"Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.nfs.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.nfs.withServer

withServer(server)

"Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.persistentVolumeClaim

"PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.persistentVolumeClaim.withClaimName

withClaimName(claimName)

"ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

"Will force the ReadOnly setting in VolumeMounts. Default false."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.photonPersistentDisk

"PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.photonPersistentDisk.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.photonPersistentDisk.withPdID

withPdID(pdID)

"ID that identifies Photon Controller persistent disk"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.portworxVolume

"PortworxVolume represents a portworx volume attached and mounted on kubelets host machine"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.portworxVolume.withFsType

withFsType(fsType)

"FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.portworxVolume.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.portworxVolume.withVolumeID

withVolumeID(volumeID)

"VolumeID uniquely identifies a Portworx volume"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected

"Items for all in one resources secrets, configmaps, and downward API"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.withDefaultMode

withDefaultMode(defaultMode)

"Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.withSources

withSources(sources)

"list of volume projections"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.withSourcesMixin

withSourcesMixin(sources)

"list of volume projections"

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources

"list of volume projections"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.configMap

"information about the configMap data to project"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.configMap.withItems

withItems(items)

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.configMap.withItemsMixin

withItemsMixin(items)

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.configMap.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its keys must be defined"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.configMap.items

"If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.configMap.items.withKey

withKey(key)

"The key to project."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.configMap.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.configMap.items.withPath

withPath(path)

"The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI

"information about the downwardAPI data to project"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.withItems

withItems(items)

"Items is a list of DownwardAPIVolume file"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of DownwardAPIVolume file"

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items

"Items is a list of DownwardAPIVolume file"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items.withPath

withPath(path)

"Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items.fieldRef

"Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items.resourceFieldRef

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

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.secret

"information about the secret data to project"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.secret.withItems

withItems(items)

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.secret.withItemsMixin

withItemsMixin(items)

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.secret.withName

withName(name)

"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?"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.secret.items

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.secret.items.withKey

withKey(key)

"The key to project."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.secret.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.secret.items.withPath

withPath(path)

"The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.serviceAccountToken

"information about the serviceAccountToken data to project"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.serviceAccountToken.withAudience

withAudience(audience)

"Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.serviceAccountToken.withExpirationSeconds

withExpirationSeconds(expirationSeconds)

"ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.projected.sources.serviceAccountToken.withPath

withPath(path)

"Path is the path relative to the mount point of the file to project the token into."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.quobyte

"Quobyte represents a Quobyte mount on the host that shares a pod's lifetime"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.quobyte.withGroup

withGroup(group)

"Group to map volume access to Default is no group"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.quobyte.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.quobyte.withRegistry

withRegistry(registry)

"Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.quobyte.withTenant

withTenant(tenant)

"Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.quobyte.withUser

withUser(user)

"User to map volume access to Defaults to serivceaccount user"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.quobyte.withVolume

withVolume(volume)

"Volume is a string that references an already created Quobyte volume by name."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd

"RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.withFsType

withFsType(fsType)

"Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.withImage

withImage(image)

"The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.withKeyring

withKeyring(keyring)

"Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.withMonitors

withMonitors(monitors)

"A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.withMonitorsMixin

withMonitorsMixin(monitors)

"A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.withPool

withPool(pool)

"The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.withReadOnly

withReadOnly(readOnly)

"ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.withUser

withUser(user)

"The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.secretRef

"SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.rbd.secretRef.withName

withName(name)

"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?"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO

"ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\"."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.withGateway

withGateway(gateway)

"The host address of the ScaleIO API Gateway."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.withProtectionDomain

withProtectionDomain(protectionDomain)

"The name of the ScaleIO Protection Domain for the configured storage."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.withSslEnabled

withSslEnabled(sslEnabled)

"Flag to enable/disable SSL communication with Gateway, default false"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.withStorageMode

withStorageMode(storageMode)

"Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.withStoragePool

withStoragePool(storagePool)

"The ScaleIO Storage Pool associated with the protection domain."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.withSystem

withSystem(system)

"The name of the storage system as configured in ScaleIO."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.withVolumeName

withVolumeName(volumeName)

"The name of a volume already created in the ScaleIO system that is associated with this volume source."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.secretRef

"SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.scaleIO.secretRef.withName

withName(name)

"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?"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret

"Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret.withDefaultMode

withDefaultMode(defaultMode)

"Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret.withItems

withItems(items)

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret.withItemsMixin

withItemsMixin(items)

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its keys must be defined"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret.withSecretName

withSecretName(secretName)

"Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret.items

"If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret.items.withKey

withKey(key)

"The key to project."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret.items.withMode

withMode(mode)

"Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.secret.items.withPath

withPath(path)

"The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.storageos

"StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.storageos.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.storageos.withReadOnly

withReadOnly(readOnly)

"Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.storageos.withVolumeName

withVolumeName(volumeName)

"VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.storageos.withVolumeNamespace

withVolumeNamespace(volumeNamespace)

"VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created."

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.storageos.secretRef

"SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.storageos.secretRef.withName

withName(name)

"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?"

obj spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.vsphereVolume

"VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.vsphereVolume.withFsType

withFsType(fsType)

"Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.vsphereVolume.withStoragePolicyID

withStoragePolicyID(storagePolicyID)

"Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.vsphereVolume.withStoragePolicyName

withStoragePolicyName(storagePolicyName)

"Storage Policy Based Management (SPBM) profile name."

fn spec.engineTemplateSpec.experiments.spec.probe.cmdProbe/inputs.source.volumes.vsphereVolume.withVolumePath

withVolumePath(volumePath)

"Path that identifies vSphere volume vmdk"

obj spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs

fn spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

fn spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.withUrl

withUrl(url)

obj spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method

obj spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method.get

fn spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method.get.withCriteria

withCriteria(criteria)

fn spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method.get.withResponseCode

withResponseCode(responseCode)

obj spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method.post

fn spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method.post.withBody

withBody(body)

fn spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method.post.withBodyPath

withBodyPath(bodyPath)

fn spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method.post.withContentType

withContentType(contentType)

fn spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method.post.withCriteria

withCriteria(criteria)

fn spec.engineTemplateSpec.experiments.spec.probe.httpProbe/inputs.method.post.withResponseCode

withResponseCode(responseCode)

obj spec.engineTemplateSpec.experiments.spec.probe.k8sProbe/inputs

fn spec.engineTemplateSpec.experiments.spec.probe.k8sProbe/inputs.withFieldSelector

withFieldSelector(fieldSelector)

fn spec.engineTemplateSpec.experiments.spec.probe.k8sProbe/inputs.withGroup

withGroup(group)

fn spec.engineTemplateSpec.experiments.spec.probe.k8sProbe/inputs.withLabelSelector

withLabelSelector(labelSelector)

fn spec.engineTemplateSpec.experiments.spec.probe.k8sProbe/inputs.withNamespace

withNamespace(namespace)

fn spec.engineTemplateSpec.experiments.spec.probe.k8sProbe/inputs.withOperation

withOperation(operation)

fn spec.engineTemplateSpec.experiments.spec.probe.k8sProbe/inputs.withResource

withResource(resource)

fn spec.engineTemplateSpec.experiments.spec.probe.k8sProbe/inputs.withResourceNames

withResourceNames(resourceNames)

fn spec.engineTemplateSpec.experiments.spec.probe.k8sProbe/inputs.withVersion

withVersion(version)

obj spec.engineTemplateSpec.experiments.spec.probe.promProbe/inputs

fn spec.engineTemplateSpec.experiments.spec.probe.promProbe/inputs.withEndpoint

withEndpoint(endpoint)

fn spec.engineTemplateSpec.experiments.spec.probe.promProbe/inputs.withQuery

withQuery(query)

fn spec.engineTemplateSpec.experiments.spec.probe.promProbe/inputs.withQueryPath

withQueryPath(queryPath)

obj spec.engineTemplateSpec.experiments.spec.probe.promProbe/inputs.comparator

fn spec.engineTemplateSpec.experiments.spec.probe.promProbe/inputs.comparator.withCriteria

withCriteria(criteria)

fn spec.engineTemplateSpec.experiments.spec.probe.promProbe/inputs.comparator.withValue

withValue(value)

obj spec.engineTemplateSpec.experiments.spec.probe.runProperties

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withAttempt

withAttempt(attempt)

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withEvaluationTimeout

withEvaluationTimeout(evaluationTimeout)

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withInitialDelay

withInitialDelay(initialDelay)

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withInterval

withInterval(interval)

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withProbePollingInterval

withProbePollingInterval(probePollingInterval)

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withProbeTimeout

withProbeTimeout(probeTimeout)

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withRetry

withRetry(retry)

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withStopOnFailure

withStopOnFailure(stopOnFailure)

fn spec.engineTemplateSpec.experiments.spec.probe.runProperties.withVerbosity

withVerbosity(verbosity)

obj spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs

"inputs needed for the SLO probe"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"InsecureSkipVerify flag to skip certificate checks"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.withPlatformEndpoint

withPlatformEndpoint(platformEndpoint)

"PlatformEndpoint for the monitoring service endpoint"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.withSloIdentifier

withSloIdentifier(sloIdentifier)

"SLOIdentifier for fetching the details of the SLO"

obj spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.comparator

"Comparator check for the correctness of the probe output"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.comparator.withCriteria

withCriteria(criteria)

"Criteria for matching data it supports >=, <=, ==, >, <, != for int and float it supports equal, notEqual, contains for string"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.comparator.withType

withType(type)

"Type of data it can be int, float, string"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.comparator.withValue

withValue(value)

"Value contains relative value for criteria"

obj spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.evaluationWindow

"EvaluationWindow is the time period for which the metrics will be evaluated"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.evaluationWindow.withEvaluationEndTime

withEvaluationEndTime(evaluationEndTime)

"End time of evaluation"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.evaluationWindow.withEvaluationStartTime

withEvaluationStartTime(evaluationStartTime)

"Start time of evaluation"

obj spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.sloSourceMetadata

"SLOSourceMetadata consists of required metadata details to fetch metric data"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.sloSourceMetadata.withApiTokenSecret

withApiTokenSecret(apiTokenSecret)

"APITokenSecret for authenticating with the platform service"

obj spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.sloSourceMetadata.scope

"Scope required for fetching details"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.sloSourceMetadata.scope.withAccountIdentifier

withAccountIdentifier(accountIdentifier)

"AccountIdentifier for account ID"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.sloSourceMetadata.scope.withOrgIdentifier

withOrgIdentifier(orgIdentifier)

"OrgIdentifier for organization ID"

fn spec.engineTemplateSpec.experiments.spec.probe.sloProbe/inputs.sloSourceMetadata.scope.withProjectIdentifier

withProjectIdentifier(projectIdentifier)

"ProjectIdentifier for project ID"

obj spec.engineTemplateSpec.selectors

fn spec.engineTemplateSpec.selectors.withPods

withPods(pods)

fn spec.engineTemplateSpec.selectors.withPodsMixin

withPodsMixin(pods)

Note: This function appends passed data to existing values

fn spec.engineTemplateSpec.selectors.withWorkloads

withWorkloads(workloads)

fn spec.engineTemplateSpec.selectors.withWorkloadsMixin

withWorkloadsMixin(workloads)

Note: This function appends passed data to existing values

obj spec.engineTemplateSpec.selectors.pods

fn spec.engineTemplateSpec.selectors.pods.withNames

withNames(names)

fn spec.engineTemplateSpec.selectors.pods.withNamespace

withNamespace(namespace)

obj spec.engineTemplateSpec.selectors.workloads

fn spec.engineTemplateSpec.selectors.workloads.withKind

withKind(kind)

fn spec.engineTemplateSpec.selectors.workloads.withLabels

withLabels(labels)

fn spec.engineTemplateSpec.selectors.workloads.withNames

withNames(names)

fn spec.engineTemplateSpec.selectors.workloads.withNamespace

withNamespace(namespace)

obj spec.schedule

fn spec.schedule.withNow

withNow(now)

obj spec.schedule.once

fn spec.schedule.once.withExecutionTime

withExecutionTime(executionTime)

obj spec.schedule.repeat

obj spec.schedule.repeat.properties

fn spec.schedule.repeat.properties.withRandom

withRandom(random)

obj spec.schedule.repeat.properties.minChaosInterval

obj spec.schedule.repeat.properties.minChaosInterval.hour

fn spec.schedule.repeat.properties.minChaosInterval.hour.withEveryNthHour

withEveryNthHour(everyNthHour)

fn spec.schedule.repeat.properties.minChaosInterval.hour.withMinuteOfTheHour

withMinuteOfTheHour(minuteOfTheHour)

obj spec.schedule.repeat.properties.minChaosInterval.minute

fn spec.schedule.repeat.properties.minChaosInterval.minute.withEveryNthMinute

withEveryNthMinute(everyNthMinute)

obj spec.schedule.repeat.timeRange

fn spec.schedule.repeat.timeRange.withEndTime

withEndTime(endTime)

fn spec.schedule.repeat.timeRange.withStartTime

withStartTime(startTime)

obj spec.schedule.repeat.workDays

fn spec.schedule.repeat.workDays.withIncludedDays

withIncludedDays(includedDays)

obj spec.schedule.repeat.workHours

fn spec.schedule.repeat.workHours.withIncludedHours

withIncludedHours(includedHours)