Documentation
¶
Index ¶
- func CleanupArtifactStorage(ctx context.Context, pr *v1beta1.PipelineRun, c kubernetes.Interface) error
- func GetPVCName(n named) string
- func GetPVCSpec(pr *v1beta1.PipelineRun, pvcSize resource.Quantity, storageClassName *string) *corev1.PersistentVolumeClaim
- func NeedsPVC(ctx context.Context) bool
- func NewArtifactBucketFromConfig(ctx context.Context, images pipeline.Images) *storage.ArtifactBucket
- type ArtifactStorageInterface
- type ArtifactStorageNone
- func (a *ArtifactStorageNone) GetCopyFromStorageToSteps(name, sourcePath, destinationPath string) []v1beta1.Step
- func (a *ArtifactStorageNone) GetCopyToStorageFromSteps(name, sourcePath, destinationPath string) []v1beta1.Step
- func (a *ArtifactStorageNone) GetSecretsVolumes() []corev1.Volume
- func (a *ArtifactStorageNone) GetType() string
- func (a *ArtifactStorageNone) StorageBasePath(pr *v1beta1.PipelineRun) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CleanupArtifactStorage ¶ added in v0.4.0
func CleanupArtifactStorage(ctx context.Context, pr *v1beta1.PipelineRun, c kubernetes.Interface) error
CleanupArtifactStorage will delete the PipelineRun's artifact storage PVC if it exists. The PVC is created for using an output workspace or artifacts from one Task to another Task. No other PVCs will be impacted by this cleanup.
func GetPVCName ¶ added in v0.4.0
func GetPVCName(n named) string
GetPVCName returns the name that should be used for the PVC for a PipelineRun
func GetPVCSpec ¶ added in v0.4.0
func GetPVCSpec(pr *v1beta1.PipelineRun, pvcSize resource.Quantity, storageClassName *string) *corev1.PersistentVolumeClaim
GetPVCSpec returns the PVC to create for a given PipelineRun
func NeedsPVC ¶ added in v0.4.0
NeedsPVC checks if the Tekton is is configured to use a bucket for artifact storage, returning true if instead a PVC is needed.
func NewArtifactBucketFromConfig ¶ added in v0.15.0
func NewArtifactBucketFromConfig(ctx context.Context, images pipeline.Images) *storage.ArtifactBucket
NewArtifactBucketFromConfig creates a Bucket from the supplied ConfigMap
Types ¶
type ArtifactStorageInterface ¶
type ArtifactStorageInterface interface { GetCopyToStorageFromSteps(name, sourcePath, destinationPath string) []v1beta1.Step GetCopyFromStorageToSteps(name, sourcePath, destinationPath string) []v1beta1.Step GetSecretsVolumes() []corev1.Volume GetType() string StorageBasePath(pr *v1beta1.PipelineRun) string }
ArtifactStorageInterface is an interface to define the steps to copy an pipeline artifact to/from temporary storage
func GetArtifactStorage ¶
func GetArtifactStorage(ctx context.Context, images pipeline.Images, prName string, c kubernetes.Interface) ArtifactStorageInterface
GetArtifactStorage returns the storage interface to enable consumer code to get a container step for copy to/from storage
func InitializeArtifactStorage ¶
func InitializeArtifactStorage(ctx context.Context, images pipeline.Images, pr *v1beta1.PipelineRun, ps *v1beta1.PipelineSpec, c kubernetes.Interface) (ArtifactStorageInterface, error)
InitializeArtifactStorage will check if there is there is a bucket configured, create a PVC or return nil if no storage is required.
type ArtifactStorageNone ¶ added in v0.5.0
type ArtifactStorageNone struct{}
ArtifactStorageNone is used when no storage is needed.
func (*ArtifactStorageNone) GetCopyFromStorageToSteps ¶ added in v0.9.0
func (a *ArtifactStorageNone) GetCopyFromStorageToSteps(name, sourcePath, destinationPath string) []v1beta1.Step
GetCopyFromStorageToSteps returns no containers because none are needed.
func (*ArtifactStorageNone) GetCopyToStorageFromSteps ¶ added in v0.9.0
func (a *ArtifactStorageNone) GetCopyToStorageFromSteps(name, sourcePath, destinationPath string) []v1beta1.Step
GetCopyToStorageFromSteps returns no containers because none are needed.
func (*ArtifactStorageNone) GetSecretsVolumes ¶ added in v0.5.0
func (a *ArtifactStorageNone) GetSecretsVolumes() []corev1.Volume
GetSecretsVolumes returns no volumes because none are needed.
func (*ArtifactStorageNone) GetType ¶ added in v0.5.0
func (a *ArtifactStorageNone) GetType() string
GetType returns the string "none" to indicate this is the None storage type.
func (*ArtifactStorageNone) StorageBasePath ¶ added in v0.5.0
func (a *ArtifactStorageNone) StorageBasePath(pr *v1beta1.PipelineRun) string
StorageBasePath returns an empty string because no storage is being used and so there is no path that resources should be copied from / to.