common

Documentation

Index

• Constants
• Variables
• func AddPodAnnotation(c *kubernetes.Clientset, podName, namespace, key, value string) error
• func AddPodLabel(c *kubernetes.Clientset, podName, namespace, key, value string) error
• func DefaultConfigMapName(controllerName string) string
• func ExecPodContainer(restConfig *rest.Config, namespace string, pod string, container string, ...) (remotecommand.Executor, error)
• func FindOverlappingVolume(tmpl *wfv1.Template, path string) *apiv1.VolumeMount
• func GetExecutorOutput(exec remotecommand.Executor) (string, string, error)
• func KillPodContainer(restConfig *rest.Config, namespace string, pod string, container string) error
• func LogStack()
• func ProcessArgs(tmpl *wfv1.Template, args wfv1.Arguments, validateOnly bool) (*wfv1.Template, error)
• func RegisterStackDumper()
• func Replace(fstTmpl *fasttemplate.Template, replaceMap map[string]string, ...) (string, error)
• func RunCommand(name string, arg ...string) error
• func ValidateWorkflow(wf *wfv1.Workflow) error
• func VerifyUniqueNonEmptyNames(slice interface{}) error

Constants

const (
	// DefaultControllerDeploymentName is the default deployment name of the workflow controller
	DefaultControllerDeploymentName = "workflow-controller"
	DefaultUiDeploymentName         = "argo-ui"
	// DefaultControllerNamespace is the default namespace where the workflow controller is installed
	DefaultControllerNamespace = "kube-system"

	// WorkflowControllerConfigMapKey is the key in the configmap to retrieve workflow configuration from.
	// Content encoding is expected to be YAML.
	WorkflowControllerConfigMapKey = "config"

	// Container names used in the workflow pod
	MainContainerName = "main"
	InitContainerName = "init"
	WaitContainerName = "wait"

	// PodMetadataVolumeName is the volume name defined in a workflow pod spec to expose pod metadata via downward API
	PodMetadataVolumeName = "podmetadata"

	// PodMetadataAnnotationsVolumePath is volume path for metadata.annotations in the downward API
	PodMetadataAnnotationsVolumePath = "annotations"
	// PodMetadataMountPath is the directory mount location for DownwardAPI volume containing pod metadata
	PodMetadataMountPath = "/argo/" + PodMetadataVolumeName
	// PodMetadataAnnotationsPath is the file path containing pod metadata annotations. Examined by executor
	PodMetadataAnnotationsPath = PodMetadataMountPath + "/" + PodMetadataAnnotationsVolumePath

	// DockerLibVolumeName is the volume name for the /var/lib/docker host path volume
	DockerLibVolumeName = "docker-lib"
	// DockerLibHostPath is the host directory path containing docker runtime state
	DockerLibHostPath = "/var/lib/docker"
	// DockerSockVolumeName is the volume name for the /var/run/docker.sock host path volume
	DockerSockVolumeName = "docker-sock"

	// AnnotationKeyNodeName is the pod metadata annotation key containing the workflow node name
	AnnotationKeyNodeName = wfv1.CRDFullName + "/node-name"
	// AnnotationKeyNodeMessage is the pod metadata annotation key the executor will use to
	// communicate errors encountered by the executor during artifact load/save, etc...
	AnnotationKeyNodeMessage = wfv1.CRDFullName + "/node-message"
	// AnnotationKeyTemplate is the pod metadata annotation key containing the container template as JSON
	AnnotationKeyTemplate = wfv1.CRDFullName + "/template"
	// AnnotationKeyOutputs is the pod metadata annotation key containing the container outputs
	AnnotationKeyOutputs = wfv1.CRDFullName + "/outputs"

	// 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
	LabelKeyCompleted = wfv1.CRDFullName + "/completed"
	// LabelKeyWorkflow is the pod metadata label to indicate the associated workflow name
	LabelKeyWorkflow = wfv1.CRDFullName + "/workflow"
	// LabelKeyPhase is a label applied to workflows to indicate the current phase of the workflow (for filtering purposes)
	LabelKeyPhase = wfv1.CRDFullName + "/phase"

	// ExecutorArtifactBaseDir is the base directory in the init container in which artifacts will be copied to.
	// Each artifact will be named according to its input name (e.g: /argo/inputs/artifacts/CODE)
	ExecutorArtifactBaseDir = "/argo/inputs/artifacts"

	// 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. This is used for the purposes of artifact loading
	// (when there is overlapping paths between artifacts and volume mounts)
	InitContainerMainFilesystemDir = "/mainctrfs"

	// ScriptTemplateEmptyDir is the path of the emptydir which will be shared between init/main container for script templates
	ScriptTemplateEmptyDir = "/argo/script"
	// ScriptTemplateSourcePath is the path which init will write the source file to and the main container will execute
	ScriptTemplateSourcePath = "/argo/script/source"

	// EnvVarHostIP contains the host IP which the container is executing on.
	// Used to communicate with kubelet directly. Kubelet enables the wait sidecar
	// to query pod state without burdening the k8s apiserver.
	EnvVarHostIP = "ARGO_HOST_IP"
	// EnvVarPodIP contains the IP of the pod (currently unused)
	EnvVarPodIP = "ARGO_POD_IP"
	// EnvVarPodName contains the name of the pod (currently unused)
	EnvVarPodName = "ARGO_POD_NAME"
	// EnvVarNamespace contains the namespace of the pod (currently unused)
	EnvVarNamespace = "ARGO_NAMESPACE"
)

Variables

var (
	DefaultControllerImage = argo.ImageNamespace + "/workflow-controller:" + argo.ImageTag
	DefaultExecutorImage   = argo.ImageNamespace + "/argoexec:" + argo.ImageTag
	DefaultUiImage         = argo.ImageNamespace + "/argoui:" + argo.ImageTag
)

Functions

func AddPodAnnotation

func AddPodAnnotation(c *kubernetes.Clientset, podName, namespace, key, value string) error

func AddPodLabel

func AddPodLabel(c *kubernetes.Clientset, podName, namespace, key, value string) error

func DefaultConfigMapName

func DefaultConfigMapName(controllerName string) string

DefaultConfigMapName returns a formulated name for a configmap name based on the workflow-controller deployment name

func ExecPodContainer

func ExecPodContainer(restConfig *rest.Config, namespace string, pod string, container string, stdout bool, stderr bool, command ...string) (remotecommand.Executor, error)

ExecPodContainer runs a command in a container in a pod and returns the remotecommand.Executor

func FindOverlappingVolume

func FindOverlappingVolume(tmpl *wfv1.Template, path string) *apiv1.VolumeMount

FindOverlappingVolume looks an artifact path, checks if it overlaps with any user specified volumeMounts in the template, and returns the deepest volumeMount (if any).

func GetExecutorOutput

func GetExecutorOutput(exec remotecommand.Executor) (string, string, error)

GetExecutorOutput returns the output of an remotecommand.Executor

func KillPodContainer

func KillPodContainer(restConfig *rest.Config, namespace string, pod string, container string) error

KillPodContainer is a convenience funtion 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

func LogStack

func LogStack()

LogStack will log the current stack

func ProcessArgs

func ProcessArgs(tmpl *wfv1.Template, args wfv1.Arguments, validateOnly bool) (*wfv1.Template, error)

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

func RegisterStackDumper

func RegisterStackDumper()

RegisterStackDumper spawns a goroutine which dumps stack trace upon a SIGUSR1

func Replace

func Replace(fstTmpl *fasttemplate.Template, replaceMap map[string]string, allowUnresolved bool) (string, error)

Replace executes basic string substitution of a template with replacement values. allowUnresolved indicates whether or not it is acceptable to have unresolved variables remaining in the substituted template.

func RunCommand

func RunCommand(name string, arg ...string) error

func ValidateWorkflow

func ValidateWorkflow(wf *wfv1.Workflow) error

func VerifyUniqueNonEmptyNames

func VerifyUniqueNonEmptyNames(slice interface{}) error

VerifyUniqueNonEmptyNames accepts a slice of structs and verifies that the Name field of the structs are unique and non-empty