validate

Documentation

Index

• func LintWorkflowDir(dirPath string, strict bool) error
• func LintWorkflowFile(filePath string, strict bool) error
• func ValidateWorkflow(wf *wfv1.Workflow, opts ValidateOpts) error
• type ValidateOpts

Functions

func LintWorkflowDir

func LintWorkflowDir(dirPath string, strict bool) error

LintWorkflowDir validates all workflow manifests in a directory. Ignores non-workflow manifests

func LintWorkflowFile

func LintWorkflowFile(filePath string, strict bool) error

LintWorkflowFile lints a json file, or multiple workflow manifest in a single yaml file. Ignores non-workflow manifests

func ValidateWorkflow

func ValidateWorkflow(wf *wfv1.Workflow, opts ValidateOpts) error

ValidateWorkflow accepts a workflow and performs validation against it.

Types

type ValidateOpts

type ValidateOpts struct {
	// Lint indicates if this is performing validation in the context of linting. If true, will
	// skip some validations which is permissible during linting but not submission (e.g. missing
	// input parameters to the workflow)
	Lint bool
	// ContainerRuntimeExecutor will trigger additional validation checks specific to different
	// types of executors. For example, the inability of kubelet/k8s executors to copy artifacts
	// out of the base image layer. If unspecified, will use docker executor validation
	ContainerRuntimeExecutor string
}

ValidateOpts provides options when linting