Documentation
¶
Index ¶
- Constants
- func CleanupArtifactStorage(pr *v1alpha1.PipelineRun, c kubernetes.Interface, logger *zap.SugaredLogger) error
- func ConfigMapNeedsPVC(configMap *corev1.ConfigMap, err error, logger *zap.SugaredLogger) (bool, error)
- func GetPVCName(pr *v1alpha1.PipelineRun) string
- func GetPVCSpec(pr *v1alpha1.PipelineRun, pvcSize resource.Quantity) *corev1.PersistentVolumeClaim
- func NewArtifactBucketConfigFromConfigMap(configMap *corev1.ConfigMap) (*v1alpha1.ArtifactBucket, error)
- type ArtifactStorageInterface
- type ArtifactStorageNone
- func (a *ArtifactStorageNone) GetCopyFromStorageToContainerSpec(name, sourcePath, destinationPath string) []corev1.Container
- func (a *ArtifactStorageNone) GetCopyToStorageFromContainerSpec(name, sourcePath, destinationPath string) []corev1.Container
- func (a *ArtifactStorageNone) GetSecretsVolumes() []corev1.Volume
- func (a *ArtifactStorageNone) GetType() string
- func (a *ArtifactStorageNone) StorageBasePath(pr *v1alpha1.PipelineRun) string
Constants ¶
const ( // PvcConfigName is the name of the configmap containing all // customizations for the storage PVC. PvcConfigName = "config-artifact-pvc" // PvcSizeKey is the name of the configmap entry that specifies the size of the PVC to create PvcSizeKey = "size" // DefaultPvcSize is the default size of the PVC to create DefaultPvcSize = "5Gi" )
Variables ¶
This section is empty.
Functions ¶
func CleanupArtifactStorage ¶ added in v0.4.0
func CleanupArtifactStorage(pr *v1alpha1.PipelineRun, c kubernetes.Interface, logger *zap.SugaredLogger) 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 ConfigMapNeedsPVC ¶ added in v0.5.0
func ConfigMapNeedsPVC(configMap *corev1.ConfigMap, err error, logger *zap.SugaredLogger) (bool, error)
ConfigMapNeedsPVC checks if the possibly-nil config map passed to it is configured to use a bucket for artifact storage, returning true if instead a PVC is needed.
func GetPVCName ¶ added in v0.4.0
func GetPVCName(pr *v1alpha1.PipelineRun) 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 *v1alpha1.PipelineRun, pvcSize resource.Quantity) *corev1.PersistentVolumeClaim
GetPVCSpec returns the PVC to create for a given PipelineRun
func NewArtifactBucketConfigFromConfigMap ¶
func NewArtifactBucketConfigFromConfigMap(configMap *corev1.ConfigMap) (*v1alpha1.ArtifactBucket, error)
NewArtifactBucketConfigFromConfigMap creates a Bucket from the supplied ConfigMap
Types ¶
type ArtifactStorageInterface ¶
type ArtifactStorageInterface interface {
GetCopyToStorageFromContainerSpec(name, sourcePath, destinationPath string) []corev1.Container
GetCopyFromStorageToContainerSpec(name, sourcePath, destinationPath string) []corev1.Container
GetSecretsVolumes() []corev1.Volume
GetType() string
StorageBasePath(pr *v1alpha1.PipelineRun) string
}
ArtifactStorageInterface is an interface to define the steps to copy an pipeline artifact to/from temporary storage
func GetArtifactStorage ¶
func GetArtifactStorage(prName string, c kubernetes.Interface, logger *zap.SugaredLogger) (ArtifactStorageInterface, error)
GetArtifactStorage returns the storage interface to enable consumer code to get a container step for copy to/from storage
func InitializeArtifactStorage ¶
func InitializeArtifactStorage(pr *v1alpha1.PipelineRun, ts []v1alpha1.PipelineTask, c kubernetes.Interface, logger *zap.SugaredLogger) (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) GetCopyFromStorageToContainerSpec ¶ added in v0.5.0
func (a *ArtifactStorageNone) GetCopyFromStorageToContainerSpec(name, sourcePath, destinationPath string) []corev1.Container
GetCopyFromStorageToContainerSpec returns no containers because none are needed.
func (*ArtifactStorageNone) GetCopyToStorageFromContainerSpec ¶ added in v0.5.0
func (a *ArtifactStorageNone) GetCopyToStorageFromContainerSpec(name, sourcePath, destinationPath string) []corev1.Container
GetCopyToStorageFromContainerSpec 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 *v1alpha1.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.
Source Files