rgw

Documentation

Index

• Variables
• func AssumeRole(ctx context.Context, stsClient backendstore.STSClient, ...) (*sts.AssumeRoleOutput, error)
• func BucketExists(ctx context.Context, s3Backend backendstore.S3Client, bucketName string, ...) (bool, error)
• func BucketToCreateBucketInput(bucket *v1alpha1.Bucket) *s3.CreateBucketInput
• func BucketToPutBucketACLInput(bucket *v1alpha1.Bucket) *s3.PutBucketAclInput
• func BucketToPutBucketOwnershipControlsInput(bucket *v1alpha1.Bucket) *s3.PutBucketOwnershipControlsInput
• func CreateBucket(ctx context.Context, s3Backend backendstore.S3Client, ...) (*awss3.CreateBucketOutput, error)
• func DeleteBucket(ctx context.Context, s3Backend backendstore.S3Client, bucketName *string, ...) error
• func DeleteBucketLifecycle(ctx context.Context, s3Backend backendstore.S3Client, bucketName *string) error
• func DeleteObject(ctx context.Context, s3Backend backendstore.S3Client, ...) error
• func GenerateLifecycleConfigurationInput(name string, config *v1alpha1.BucketLifecycleConfiguration) *awss3.PutBucketLifecycleConfigurationInput
• func GenerateLifecycleRules(in []v1alpha1.LifecycleRule) []types.LifecycleRule
• func GetBucketLifecycleConfiguration(ctx context.Context, s3Backend backendstore.S3Client, bucketName *string) (*awss3.GetBucketLifecycleConfigurationOutput, error)
• func GetObject(ctx context.Context, s3Backend backendstore.S3Client, ...) (*awss3.GetObjectOutput, error)
• func IsAlreadyExists(err error) bool
• func IsAlreadyOwnedByYou(err error) bool
• func IsBucketNotFound(err error) bool
• func IsNotEmpty(err error) bool
• func IsNotFound(err error) bool
• func LifecycleConfigurationNotFound(err error) bool
• func ListObjectVersions(ctx context.Context, s3Backend backendstore.S3Client, ...) (*awss3.ListObjectVersionsOutput, error)
• func ListObjectsV2(ctx context.Context, s3Backend backendstore.S3Client, ...) (*awss3.ListObjectsV2Output, error)
• func NewS3Client(ctx context.Context, data map[string][]byte, ...) (*s3.Client, error)
• func NewSTSClient(ctx context.Context, data map[string][]byte, ...) (*sts.Client, error)
• func NoSuchBucket(err error) bool
• func PutBucketLifecycleConfiguration(ctx context.Context, s3Backend backendstore.S3Client, b *v1alpha1.Bucket) (*awss3.PutBucketLifecycleConfigurationOutput, error)
• func PutObject(ctx context.Context, s3Backend backendstore.S3Client, ...) error
• func SortFilterTags(rules []types.LifecycleRule)
• type BucketNotEmptyError
  • func (e BucketNotEmptyError) Error() string
  • func (e BucketNotEmptyError) ErrorCode() string
  • func (e BucketNotEmptyError) ErrorFault() smithy.ErrorFault
  • func (e BucketNotEmptyError) ErrorMessage() string

Variables

var (
	// Define this error as an error type because bucket controller checks it
	ErrBucketNotEmpty = errors.New("bucket is not empty")
)

var LifecycleNotFoundErrCode = "NoSuchLifecycleConfiguration"

LifecycleNotFoundErrCode is the error code sent by Ceph when the lifecycle config does not exist

var NoSuchBucketErrCode = "NoSuchBucket"

NoSuchBucketErrCode is the error code sent by Ceph when the bucket does not exist

Functions

func AssumeRole

func AssumeRole(ctx context.Context, stsClient backendstore.STSClient, input *sts.AssumeRoleInput) (*sts.AssumeRoleOutput, error)

func BucketExists

func BucketExists(ctx context.Context, s3Backend backendstore.S3Client, bucketName string, o ...func(*awss3.Options)) (bool, error)

func BucketToCreateBucketInput

func BucketToCreateBucketInput(bucket *v1alpha1.Bucket) *s3.CreateBucketInput

func BucketToPutBucketACLInput

func BucketToPutBucketACLInput(bucket *v1alpha1.Bucket) *s3.PutBucketAclInput

func BucketToPutBucketOwnershipControlsInput

func BucketToPutBucketOwnershipControlsInput(bucket *v1alpha1.Bucket) *s3.PutBucketOwnershipControlsInput

func CreateBucket

func CreateBucket(ctx context.Context, s3Backend backendstore.S3Client, bucket *awss3.CreateBucketInput, o ...func(*awss3.Options)) (*awss3.CreateBucketOutput, error)

func DeleteBucket

func DeleteBucket(ctx context.Context, s3Backend backendstore.S3Client, bucketName *string, healthCheck bool, o ...func(*awss3.Options)) error

func DeleteBucketLifecycle

func DeleteBucketLifecycle(ctx context.Context, s3Backend backendstore.S3Client, bucketName *string) error

func DeleteObject

func DeleteObject(ctx context.Context, s3Backend backendstore.S3Client, input *awss3.DeleteObjectInput, o ...func(*awss3.Options)) error

func GenerateLifecycleConfigurationInput

func GenerateLifecycleConfigurationInput(name string, config *v1alpha1.BucketLifecycleConfiguration) *awss3.PutBucketLifecycleConfigurationInput

GenerateLifecycleConfiguration creates the PutBucketLifecycleConfigurationInput for the AWS SDK

func GenerateLifecycleRules

func GenerateLifecycleRules(in []v1alpha1.LifecycleRule) []types.LifecycleRule

GenerateLifecycleRules creates the list of LifecycleRules for the AWS SDK

func GetBucketLifecycleConfiguration

func GetBucketLifecycleConfiguration(ctx context.Context, s3Backend backendstore.S3Client, bucketName *string) (*awss3.GetBucketLifecycleConfigurationOutput, error)

func GetObject

func GetObject(ctx context.Context, s3Backend backendstore.S3Client, input *awss3.GetObjectInput, o ...func(*awss3.Options)) (*awss3.GetObjectOutput, error)

func IsAlreadyExists

func IsAlreadyExists(err error) bool

IsAlreadyExists helper function to test for ErrCodeBucketAlreadyExists error

func IsAlreadyOwnedByYou

func IsAlreadyOwnedByYou(err error) bool

IsAlreadyOwnedByYou helper function to test for ErrCodeBucketAlreadyOwnedByYou error

func IsBucketNotFound

func IsBucketNotFound(err error) bool

BucketNotFound parses the error and validates if the bucket does not exist

func IsNotEmpty

func IsNotEmpty(err error) bool

func IsNotFound

func IsNotFound(err error) bool

IsNotFound helper function to test for NotFound error

func LifecycleConfigurationNotFound

func LifecycleConfigurationNotFound(err error) bool

LifecycleConfigurationNotFound is parses the error and validates if the lifecycle configuration does not exist

func ListObjectVersions

func ListObjectVersions(ctx context.Context, s3Backend backendstore.S3Client, input *awss3.ListObjectVersionsInput, o ...func(*awss3.Options)) (*awss3.ListObjectVersionsOutput, error)

func ListObjectsV2

func ListObjectsV2(ctx context.Context, s3Backend backendstore.S3Client, input *awss3.ListObjectsV2Input, o ...func(*awss3.Options)) (*awss3.ListObjectsV2Output, error)

func NewS3Client

func NewS3Client(ctx context.Context, data map[string][]byte, pcSpec *apisv1alpha1.ProviderConfigSpec, s3Timeout time.Duration, sessionToken *string) (*s3.Client, error)

func NewSTSClient

func NewSTSClient(ctx context.Context, data map[string][]byte, pcSpec *apisv1alpha1.ProviderConfigSpec, s3Timeout time.Duration) (*sts.Client, error)

func NoSuchBucket

func NoSuchBucket(err error) bool

NoSuchBucket helper function to test for NoSuchBucket error

func PutBucketLifecycleConfiguration

func PutBucketLifecycleConfiguration(ctx context.Context, s3Backend backendstore.S3Client, b *v1alpha1.Bucket) (*awss3.PutBucketLifecycleConfigurationOutput, error)

func PutObject

func PutObject(ctx context.Context, s3Backend backendstore.S3Client, input *awss3.PutObjectInput, o ...func(*awss3.Options)) error

func SortFilterTags

func SortFilterTags(rules []types.LifecycleRule)

Types

type BucketNotEmptyError

type BucketNotEmptyError struct{}

Unlike NoSuchBucket error or others, aws-sdk-go-v2 doesn't have a specific struct definition for BucketNotEmpty error. So we should define ourselves. This is currently only for testing.

func (BucketNotEmptyError) Error

func (e BucketNotEmptyError) Error() string

func (BucketNotEmptyError) ErrorCode

func (e BucketNotEmptyError) ErrorCode() string

func (BucketNotEmptyError) ErrorFault

func (e BucketNotEmptyError) ErrorFault() smithy.ErrorFault

func (BucketNotEmptyError) ErrorMessage

func (e BucketNotEmptyError) ErrorMessage() string