s3

Documentation

Index

• Constants
• type Backend
  • func NewBackend(creds *Credentials, connOpts ...ConnOpt) (*Backend, error)
  • func (b *Backend) CheckWritePermissions(ctx context.Context) error
  • func (b *Backend) Describe(ctx context.Context, digest string) (*pb.CASResource, error)
  • func (b *Backend) Download(ctx context.Context, w io.Writer, digest string) error
  • func (b *Backend) Exists(ctx context.Context, digest string) (bool, error)
  • func (b *Backend) Upload(ctx context.Context, r io.Reader, resource *pb.CASResource) error
• type BackendProvider
  • func NewBackendProvider(cReader credentials.Reader) *BackendProvider
  • func (p *BackendProvider) FromCredentials(ctx context.Context, secretName string) (backend.UploaderDownloader, error)
  • func (p *BackendProvider) ID() string
  • func (p *BackendProvider) ValidateAndExtractCredentials(location string, credsJSON []byte) (any, error)
• type ConnOpt
  • func WithEndpoint(endpoint string) ConnOpt
  • func WithForcedS3PathStyle(force bool) ConnOpt
• type Credentials
  • func (c *Credentials) Validate() error

Constants

const ProviderID = "AWS-S3"

Types

type Backend

type Backend struct {
	// contains filtered or unexported fields
}

func NewBackend

func NewBackend(creds *Credentials, connOpts ...ConnOpt) (*Backend, error)

func (*Backend) CheckWritePermissions

func (b *Backend) CheckWritePermissions(ctx context.Context) error

CheckWritePermissions performs an actual write to the repository to check that the credentials

func (*Backend) Describe

func (b *Backend) Describe(ctx context.Context, digest string) (*pb.CASResource, error)

func (*Backend) Download

func (b *Backend) Download(ctx context.Context, w io.Writer, digest string) error

func (*Backend) Exists

func (b *Backend) Exists(ctx context.Context, digest string) (bool, error)

Exists check that the artifact is already present in the repository

func (*Backend) Upload

func (b *Backend) Upload(ctx context.Context, r io.Reader, resource *pb.CASResource) error

type BackendProvider

type BackendProvider struct {
	// contains filtered or unexported fields
}

func NewBackendProvider

func NewBackendProvider(cReader credentials.Reader) *BackendProvider

func (*BackendProvider) FromCredentials

func (p *BackendProvider) FromCredentials(ctx context.Context, secretName string) (backend.UploaderDownloader, error)

func (*BackendProvider) ID

func (p *BackendProvider) ID() string

func (*BackendProvider) ValidateAndExtractCredentials

func (p *BackendProvider) ValidateAndExtractCredentials(location string, credsJSON []byte) (any, error)

type ConnOpt

type ConnOpt func(*aws.Config)

func WithEndpoint

func WithEndpoint(endpoint string) ConnOpt

Optional endpoint configuration

func WithForcedS3PathStyle

func WithForcedS3PathStyle(force bool) ConnOpt

type Credentials

type Credentials struct {
	// AWS Access Key ID
	AccessKeyID string
	// AWS Secret Access Key
	SecretAccessKey string
	// Bucket name
	BucketName string
	// Region ID, i.e us-east-1
	Region string
}

func (*Credentials) Validate

func (c *Credentials) Validate() error

Validate that the APICreds has all its properties set