validate

Documentation

Index

• func LintWorkflowTemplateDir(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, ...) error
• func LintWorkflowTemplateFile(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, ...) error
• func ParseCWfTmplFromFile(filePath string, strict bool) ([]wfv1.ClusterWorkflowTemplate, error)
• func ParseCronWorkflowsFromFile(filePath string, strict bool) ([]wfv1.CronWorkflow, error)
• func ParseWfFromFile(filePath string, strict bool) ([]wfv1.Workflow, error)
• func ParseWfTmplFromFile(filePath string, strict bool) ([]wfv1.WorkflowTemplate, error)
• func ValidateClusterWorkflowTemplate(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, ...) (*wfv1.Conditions, error)
• func ValidateCronWorkflow(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, ...) error
• func ValidateWorkflow(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, ...) (*wfv1.Conditions, error)
• func ValidateWorkflowTemplate(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, ...) (*wfv1.Conditions, error)
• func ValidateWorkflowTemplateRefFields(wfSpec wfv1.WorkflowSpec) error
• type FakeArguments
  • func (args *FakeArguments) GetArtifactByName(name string) *wfv1.Artifact
  • func (args *FakeArguments) GetParameterByName(name string) *wfv1.Parameter
• type ValidateOpts

Functions

func LintWorkflowTemplateDir

func LintWorkflowTemplateDir(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, cwftmplGetter templateresolution.ClusterWorkflowTemplateGetter, dirPath string, strict bool) error

LintWorkflowTemplateDir validates all workflow manifests in a directory. Ignores non-workflow template manifests

func LintWorkflowTemplateFile

func LintWorkflowTemplateFile(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, cwftmplGetter templateresolution.ClusterWorkflowTemplateGetter, filePath string, strict bool) error

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

func ParseCWfTmplFromFile

func ParseCWfTmplFromFile(filePath string, strict bool) ([]wfv1.ClusterWorkflowTemplate, error)

func ParseCronWorkflowsFromFile

func ParseCronWorkflowsFromFile(filePath string, strict bool) ([]wfv1.CronWorkflow, error)

func ParseWfFromFile

func ParseWfFromFile(filePath string, strict bool) ([]wfv1.Workflow, error)

func ParseWfTmplFromFile

func ParseWfTmplFromFile(filePath string, strict bool) ([]wfv1.WorkflowTemplate, error)

func ValidateClusterWorkflowTemplate

func ValidateClusterWorkflowTemplate(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, cwftmplGetter templateresolution.ClusterWorkflowTemplateGetter, cwftmpl *wfv1.ClusterWorkflowTemplate) (*wfv1.Conditions, error)

ValidateClusterWorkflowTemplate accepts a cluster workflow template and performs validation against it.

func ValidateCronWorkflow

func ValidateCronWorkflow(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, cwftmplGetter templateresolution.ClusterWorkflowTemplateGetter, cronWf *wfv1.CronWorkflow) error

ValidateCronWorkflow validates a CronWorkflow

func ValidateWorkflow

func ValidateWorkflow(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, cwftmplGetter templateresolution.ClusterWorkflowTemplateGetter, wf *wfv1.Workflow, opts ValidateOpts) (*wfv1.Conditions, error)

ValidateWorkflow accepts a workflow and performs validation against it.

func ValidateWorkflowTemplate

func ValidateWorkflowTemplate(wftmplGetter templateresolution.WorkflowTemplateNamespacedGetter, cwftmplGetter templateresolution.ClusterWorkflowTemplateGetter, wftmpl *wfv1.WorkflowTemplate) (*wfv1.Conditions, error)

ValidateWorkflowTemplate accepts a workflow template and performs validation against it.

func ValidateWorkflowTemplateRefFields

func ValidateWorkflowTemplateRefFields(wfSpec wfv1.WorkflowSpec) error

Types

type FakeArguments

type FakeArguments struct{}

func (*FakeArguments) GetArtifactByName

func (args *FakeArguments) GetArtifactByName(name string) *wfv1.Artifact

func (*FakeArguments) GetParameterByName

func (args *FakeArguments) GetParameterByName(name string) *wfv1.Parameter

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

	// IgnoreEntrypoint indicates to skip/ignore the EntryPoint validation on workflow spec.
	// Entrypoint is optional for WorkflowTemplate and ClusterWorkflowTemplate
	IgnoreEntrypoint bool

	// WorkflowTemplateValidation indicates that the current context is validating a WorkflowTemplate or ClusterWorkflowTemplate
	WorkflowTemplateValidation bool
}

ValidateOpts provides options when linting