package
1.2.0
Repository: https://github.com/caicloud/cyclone.git
Documentation: pkg.go.dev

# Functions

AllContainers selects all containers, it returns true regardless of the container name.
ArtifactPath gets the path of a artifact in PV.
ArtifactsPath gets the path of artifacts in PV.
GetEventRecorder get the event recorder object.
GetExecutionClusterClient gets execution cluster client with the WorkflowRun.
GetResourceResolver gets resource resolver for a given resource type.
GetResourceTypes gets supported types of resources.
InputResourceVolumeName ...
NonCoordinator selects all containers except coordinator.
NonDockerInDocker selects all containers except docker:dind.
NonWorkloadSidecar selects all containers except workload sidecars.
OnlyCustomContainer judges whether a container is a custom container based on container name.
OnlyWorkload selects only workload containers.
OutputResourceVolumeName ...
Pass check whether the given container name passes the given selectors.
PresetVolumeName ...
ResolveProjectName finds project name in the workflowRun's label, if found returns the value, otherwise returns empty.
ResolveWorkflowName finds workflow name in the workflowRun's filed in order - WorkflowRef - OwnerReference - Label workflow if found returns the value, otherwise returns empty.
ResourcePath gets the path of a resource in PV.
ResultSubPath returns the subPath in the volume according to the containerName.
StagePath gets the path of a stage in PV.
WorkflowRunsPath indicates WorkflowRuns data path in PV.

# Constants

ContainerStateInitialized represents container is Running or Stopped, not Init or Creating.
ContainerStateTerminated represents container is stopped.
CoordinatorArtifactsPath ...
CoordinatorResolverNotifyOkPath ...
CoordinatorResolverNotifyPath ...
CoordinatorResolverPath ...
CoordinatorResultsPath is the directory that contains __result__ files written by other containers.
CoordinatorSidecarName defines name of coordinator container.
CoordinatorSidecarVolumeName is name of the emptyDir volume shared between coordinator and sidecar containers, e.g.
CoordinatorWorkspacePath is path of artifacts in coordinator container.
CycloneSidecarPrefix defines container name prefixes for sidecar.
DefaultCycloneServerAddr defines default Cyclone Server address.
DefaultPvVolumeName is name of the default PV used by all workflow stages.
DefaultServiceAccountName is service account name used by stage pod.
DockerConfigJSONVolume is volume for config.json in secret.
DockerInDockerSidecarName defines name of docker in docker container.
DockerInDockerSockVolume is volume used for docker-in-docker to share it's sock file with other containers.
DockerSockPath is path of docker socket file in container.
EnvCycloneServerAddr is an environment which represents cyclone server address.
EnvLogCollectorURL is URL to send logs.
EnvMetadataNamespace is an environment which represents namespace of workflows/workflowRuns/stages.
EnvNamespace is an environment which represents namespace of workflow execution context.
EnvOutputResourcesInfo is an environment which represents output resources information.
EnvStageInfo is an environment which represents stage information.
EnvStageName is an environment which represents stage name.
EnvStagePodName is an environment which represents pod name.
EnvWorkflowName is an environment which represents workflow name.
EnvWorkflowRunInfo is an environment which represents workflowrun information.
EnvWorkflowrunName is an environment which represents workflowrun name.
EnvWorkloadContainerName is an environment which represents the workload container name.
EventSourceWfrController represents events send from workflowrun controller.
GCContainerName is name of GC container.
GCDataPath is parent folder holding data to be cleaned by GC pod.
OutputResourcesDir contains the output resources generated by workload container.
OutputResourcesVolume is the name of the volume that contains resources generated by users.
ResolverDefaultDataPath is data path in resource resolver containers.
ResolverDefaultWorkspacePath is workspace path in resource resolver containers.
ResolverNotifyDir is name of the notify directory where coordinator would create ok file there.
ResolverNotifyDirPath is notify directory path in resource resolver container.
ResourcePullCommand indicates pull resource.
ResourcePushCommand indicates push resource.
ResultDirSubPath defines the subPath of ResultFileDir in coordinator sidecar volume.
ResultFileDir contains the file `__result__` to hold execution result of a container that need to be synced to WorkflowRun status.
StageMountPath is path that we will mount PV on in container.
ToolboxPath is path of cyclone tools in containers.
ToolboxVolumeMountPath is mount path of the toolbox emptyDir volume mounted in container.
ToolsVolume is name of the volume to inject cyclone tools to containers.
WorkloadSidecarPrefix defines workload sidecar container name prefix.

# Type aliases

ContainerSelector is a function to select containers.
ContainerState represents container state.