meta

Documentation

Index

• Constants
• func AddSchedulableClusterLabel(labels map[string]string) map[string]string
• func AddStageTemplateLabel(labels map[string]string) map[string]string
• func BuiltinLabelSelector() string
• func LabelExistsSelector(key string) string
• func ProjectSelector(project string) string
• func SchedulableClusterSelector() string
• func StageTemplateSelector() string
• func WorkflowSelector(workflow string) string
• type PodKind
  • func (pk PodKind) String() string

Constants

const (
	// AnnotationAlias is the annotation key used to indicate the alias of resources
	AnnotationAlias = "cyclone.dev/alias"

	// AnnotationDescription is the annotation key used to describe resources
	AnnotationDescription = "cyclone.dev/description"

	// AnnotationOwner is the annotation key used to indicate the owner of resources.
	AnnotationOwner = "cyclone.dev/owner"

	// AnnotationStageName is annotation applied to pod to indicate which stage it related to
	AnnotationStageName = "stage.cyclone.dev/name"

	// AnnotationWorkflowRunName is annotation applied to pod to specify WorkflowRun the pod belongs to
	AnnotationWorkflowRunName = "workflowrun.cyclone.dev/name"

	// AnnotationWorkflowRunTrigger is the annotation key used to indicate the trigger of workflowruns.
	AnnotationWorkflowRunTrigger = "workflowrun.cyclone.dev/trigger"

	// AnnotationTenantInfo is the annotation key used for namespace to relate tenant information
	AnnotationTenantInfo = "tenant.cyclone.dev/info"

	// AnnotationTenantStorageUsage is annotation to store storage usuage information
	AnnotationTenantStorageUsage = "tenant.cyclone.dev/storage-usage"

	// AnnotationMetaNamespace is annotation applied to pod to specify the namespace where Workflow, WorkflowRun etc belong to.
	AnnotationMetaNamespace = "cyclone.dev/meta-namespace"
)

const (
	// LabelTenantName is the label key used to indicate the tenant which the resources belongs to
	LabelTenantName = "tenant.cyclone.dev/name"

	// LabelProjectName is the label key used to indicate the project which the resources belongs to
	LabelProjectName = "project.cyclone.dev/name"

	// LabelWorkflowName is the label key used to indicate the workflow which the resources belongs to
	LabelWorkflowName = "workflow.cyclone.dev/name"

	// LabelWorkflowRunName is the label key used to indicate the workflowrun which the resources belongs to
	LabelWorkflowRunName = "workflowrun.cyclone.dev/name"

	// LabelWorkflowRunAcceleration is the label key used to indicate a workflowrun turned on acceleration
	LabelWorkflowRunAcceleration = "workflowrun.cyclone.dev/acceleration"

	// LabelStageTemplate is the label key used to represent a stage is a stage template
	LabelStageTemplate = "stage.cyclone.dev/template"

	// LabelIntegrationType is the label key used to indicate type of integration
	LabelIntegrationType = "integration.cyclone.dev/type"

	// LabelIntegrationSchedulableCluster is the label key used to indicate the cluster is schedulable for workflowruns in this tenant
	LabelIntegrationSchedulableCluster = "integration.cyclone.dev/schedulable-cluster"

	// LabelPodKind is the label key applied to pod to indicate whether the pod is used for GC purpose.
	LabelPodKind = "pod.kubernetes.io/kind"

	// LabelPodCreatedBy is the label key applied to pod to indicate who the pod is created by.
	LabelPodCreatedBy = "pod.kubernetes.io/created-by"

	// LabelBuiltin is the label key used to represent cyclone built in resources
	LabelBuiltin = "cyclone.dev/builtin"

	// LabelScene is the label key used to indicate cyclone scenario
	LabelScene = "cyclone.dev/scene"

	// TrueValue is the label value used to represent true
	TrueValue = "true"

	// FalseValue is the label value used to represent false
	FalseValue = "false"

	// CycloneCreator is the label value used to represent the resources created by Cyclone.
	CycloneCreator = "cyclone"
)

Functions

func AddSchedulableClusterLabel

func AddSchedulableClusterLabel(labels map[string]string) map[string]string

AddSchedulableClusterLabel adds schedulable label for integrated cluster to run workload.

func AddStageTemplateLabel

func AddStageTemplateLabel(labels map[string]string) map[string]string

AddStageTemplateLabel adds template label for stages.

func BuiltinLabelSelector

func BuiltinLabelSelector() string

BuiltinLabelSelector returns a label selector to query cyclone built-in resources.

func LabelExistsSelector

func LabelExistsSelector(key string) string

LabelExistsSelector returns a label selector to query resources with label key exists.

func ProjectSelector

func ProjectSelector(project string) string

ProjectSelector is a selector for cyclone CRD resources which have corresponding project label

func SchedulableClusterSelector

func SchedulableClusterSelector() string

SchedulableClusterSelector is a selector for clusters which are use to perform workload

func StageTemplateSelector

func StageTemplateSelector() string

StageTemplateSelector returns a label selector to query stage templates.

func WorkflowSelector

func WorkflowSelector(workflow string) string

WorkflowSelector is a selector for cyclone CRD resources which have corresponding workflow label

Types

type PodKind

type PodKind string

PodKind represents the type of pods created by Cyclone.

const (
	// PodKindGC represents the pod is used for GC purpose.
	PodKindGC PodKind = "gc"
)

func (PodKind) String

func (pk PodKind) String() string