package
2.4.0-rc1+incompatible
Repository: https://github.com/benjaminws/argo.git
Documentation: pkg.go.dev
# Functions
AddPodAnnotation adds an annotation to pod.
AddPodLabel adds an label to pod.
ContainerLogStream returns an io.ReadCloser for a container's log stream using the websocket interface.
DeletePod deletes a pod.
ExecPodContainer runs a command in a container in a pod and returns the remotecommand.Executor.
FindOverlappingVolume looks an artifact path, checks if it overlaps with any user specified volumeMounts in the template, and returns the deepest volumeMount (if any).
GetExecutorOutput returns the output of an remotecommand.Executor.
GetTaskAncestry returns a list of taskNames which are ancestors of this task.
GetTemplateGetterString returns string of TemplateGetter.
GetTemplateHolderString returns string of TemplateHolder.
IsPodTemplate returns whether the template corresponds to a pod.
KillPodContainer is a convenience function to issue a kill signal to a container in a pod It gives a 15 second grace period before issuing SIGKILL NOTE: this only works with containers that have sh.
MergeReferredTemplate merges a referred template to the receiver template.
ProcessArgs sets in the inputs, the values either passed via arguments, or the hardwired values It substitutes: * parameters in the template from the arguments * global parameters (e.g.
Replace executes basic string substitution of a template with replacement values.
RunCommand is a convenience function to run/log a command and log the stderr upon failure.
SplitWorkflowTemplateYAMLFile is a helper to split a body into multiple workflow template objects.
SplitWorkflowYAMLFile is a helper to split a body into multiple workflow objects.
# Constants
AnnotationKeyExecutionControl is the pod metadata annotation key containing execution control parameters set by the controller and obeyed by the executor.
AnnotationKeyNodeMessage is the pod metadata annotation key the executor will use to communicate errors encountered by the executor during artifact load/save, etc...
AnnotationKeyNodeName is the pod metadata annotation key containing the workflow node name.
AnnotationKeyOutputs is the pod metadata annotation key containing the container outputs.
AnnotationKeyTemplate is the pod metadata annotation key containing the container template as JSON.
ContainerRuntimeExecutorDocker to use docker as container runtime executor.
ContainerRuntimeExecutorK8sAPI to use the Kubernetes API server as container runtime executor.
ContainerRuntimeExecutorKubelet to use the kubelet as container runtime executor.
ContainerRuntimeExecutorPNS indicates to use process namespace sharing as the container runtime executor.
DefaultArchivePattern is the default pattern when storing artifacts in an archive repository.
DockerSockVolumeName is the volume name for the /var/run/docker.sock host path volume.
EnvVarContainerRuntimeExecutor contains the name of the container runtime executor to use, empty is equal to "docker".
EnvVarDownwardAPINodeIP is the envvar used to get the `status.hostIP`.
EnvVarKubeletInsecure is used to disable the TLS verification.
EnvVarKubeletPort is used to configure the kubelet api port.
EnvVarPodName contains the name of the pod (currently unused).
ExecutorArtifactBaseDir is the base directory in the init container in which artifacts will be copied to.
ExecutorMainFilesystemDir is a path made available to the init/wait containers such that they can access the same volume mounts used in the main container.
ExecutorResourceManifestPath is the path which init will write the a manifest file to for resource templates.
ExecutorScriptSourcePath is the path which init will write the script source file to for script templates.
ExecutorStagingEmptyDir is the path of the emptydir which is used as a staging area to transfer a file between init/main container for script/resource templates.
GlobalVarWorkflowCreationTimestamp is the workflow variable referencing the workflow's metadata.creationTimestamp field.
GlobalVarWorkflowName is a global workflow variable referencing the workflow's metadata.name field.
GlobalVarWorkflowNamespace is a global workflow variable referencing the workflow's metadata.namespace field.
GlobalVarWorkflowPriority is the workflow variable referencing the workflow's priority field.
GlobalVarWorkflowStatus is a global workflow variable referencing the workflow's status.phase field.
GlobalVarWorkflowUID is a global workflow variable referencing the workflow's metadata.uid field.
No description provided by the author
No description provided by the author
No description provided by the author
LabelKeyCompleted is the metadata label applied on worfklows and workflow pods to indicates if resource is completed Workflows and pods with a completed=true label will be ignored by the controller.
LabelKeyControllerInstanceID is the label the controller will carry forward to workflows/pod labels for the purposes of workflow segregation.
LabelKeyPhase is a label applied to workflows to indicate the current phase of the workflow (for filtering purposes).
LabelKeyWorkflow is the pod metadata label to indicate the associated workflow name.
LocalVarPodName is a step level variable that references the name of the pod.
Container names used in the workflow pod.
PodMetadataAnnotationsPath is the file path containing pod metadata annotations.
PodMetadataAnnotationsVolumePath is volume path for metadata.annotations in the downward API.
PodMetadataMountPath is the directory mount location for DownwardAPI volume containing pod metadata.
PodMetadataVolumeName is the volume name defined in a workflow pod spec to expose pod metadata via downward API.
No description provided by the author
No description provided by the author
WorkflowControllerConfigMapKey is the key in the configmap to retrieve workflow configuration from.
# Variables
GlobalVarWorkflowRootTags is a list of root tags in workflow which could be used for variable reference.
# Structs
ExecutionControl contains execution control parameters for executor to decide how to execute the container.
No description provided by the author
# Type aliases
No description provided by the author