package
2.1.0-alpha1+incompatible
Repository: https://github.com/sagansystems/argo.git
Documentation: pkg.go.dev

# Functions

AddPodAnnotation adds an annotation to pod.
AddPodLabel adds an label to pod.
DefaultConfigMapName returns a formulated name for a configmap name based on the workflow-controller deployment name.
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).
FormulateResubmitWorkflow formulate a new workflow from a previous workflow, optionally re-using successful nodes.
GetExecutorOutput returns the output of an remotecommand.Executor.
GetTaskAncestry returns a list of taskNames which are ancestors of this task.
IsPodTemplate returns whether the template corresponds to a pod.
IsValidWorkflowFieldName : workflow field name must consist of alpha-numeric characters or '-', and must start with an alpha-numeric character.
IsWorkflowCompleted returns whether or not a workflow is considered completed.
IsWorkflowSuspended returns whether or not a workflow is considered suspended.
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.
ProcessArgs sets in the inputs, the values either passed via arguments, or the hardwired values It also substitutes parameters in the template from the arguments It will also substitute any global variables referenced in template (e.g.
Replace executes basic string substitution of a template with replacement values.
ResumeWorkflow resumes a workflow by setting spec.suspend to nil and any suspended nodes to Successful.
RunCommand is a convenience function to run/log a command and log the stderr upon failure.
SuspendWorkflow suspends a workflow by setting spec.suspend to true.
ValidateWorkflow accepts a workflow and performs validation against it.

# 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.
DefaultControllerDeploymentName is the default deployment name of the workflow controller.
DefaultControllerNamespace is the default namespace where the workflow controller is installed.
DockerLibHostPath is the host directory path containing docker runtime state.
DockerLibVolumeName is the volume name for the /var/lib/docker host path volume.
DockerSockVolumeName is the volume name for the /var/run/docker.sock host path volume.
EnvVarNamespace contains the namespace of the pod (currently unused).
EnvVarPodIP contains the IP of the pod (currently unused).
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.
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.
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.
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.
InitContainerMainFilesystemDir is a path made available to the init container such that the init container can access the same volume mounts used in the main container.
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.
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
WorkflowControllerConfigMapKey is the key in the configmap to retrieve workflow configuration from.

# Structs

ExecutionControl contains execution control parameters for executor to decide how to execute the container.