minio

Documentation

Index

• Variables
• type ArtifactClient
  • func NewMinIOArtifactClient(client storage.Client) *ArtifactClient
  • func (c *ArtifactClient) DownloadArchive(ctx context.Context, executionId string, masks []string) (io.Reader, error)
  • func (c *ArtifactClient) DownloadFile(ctx context.Context, file, executionId, testName, testSuiteName string) (io.Reader, error)
  • func (c *ArtifactClient) GetValidBucketName(parentType string, parentName string) string
  • func (c *ArtifactClient) ListFiles(ctx context.Context, executionId, testName, testSuiteName string) ([]testkube.Artifact, error)
  • func (c *ArtifactClient) PlaceFiles(ctx context.Context, bucketFolders []string, prefix string) error
  • func (c *ArtifactClient) UploadFile(ctx context.Context, bucketFolder, filePath string, reader io.Reader, ...) error
• type Client
  • func NewClient(endpoint, accessKeyID, secretAccessKey, region, token, bucket string, ...) *Client
  • func (c *Client) Connect() error
  • func (c *Client) CreateBucket(ctx context.Context, bucket string) error
  • func (c *Client) DeleteBucket(ctx context.Context, bucket string, force bool) error
  • func (c *Client) DeleteFile(ctx context.Context, bucketFolder, file string) error
  • func (c *Client) DeleteFileFromBucket(ctx context.Context, bucket, bucketFolder, file string) error
  • func (c *Client) DownloadArchive(ctx context.Context, bucketFolder string, masks []string) (io.Reader, error)
  • func (c *Client) DownloadArchiveFromBucket(ctx context.Context, bucket, bucketFolder string, masks []string) (io.Reader, error)
  • func (c *Client) DownloadFile(ctx context.Context, bucketFolder, file string) (*minio.Object, error)
  • func (c *Client) DownloadFileFromBucket(ctx context.Context, bucket, bucketFolder, file string) (io.Reader, error)
  • func (c *Client) GetValidBucketName(parentType string, parentName string) string
  • func (c *Client) IsConnectionPossible(ctx context.Context) (bool, error)
  • func (c *Client) ListBuckets(ctx context.Context) ([]string, error)
  • func (c *Client) ListFiles(ctx context.Context, bucketFolder string) ([]testkube.Artifact, error)
  • func (c *Client) PlaceFiles(ctx context.Context, bucketFolders []string, prefix string) error
  • func (c *Client) SaveFile(ctx context.Context, bucketFolder, filePath string) error
  • func (c *Client) SaveFileDirect(ctx context.Context, folder, file string, data io.Reader, size int64, ...) error
  • func (c *Client) ScrapeArtefacts(ctx context.Context, id string, directories ...string) error
  • func (c *Client) SetExpirationPolicy(expirationDays int) error
  • func (c *Client) UploadFile(ctx context.Context, bucketFolder, filePath string, reader io.Reader, ...) error
  • func (c *Client) UploadFileToBucket(ctx context.Context, bucket, bucketFolder, filePath string, reader io.Reader, ...) error
• type Option
  • func ClientCert(certFile, keyFile string) Option
  • func GetTLSOptions(ssl, skipVerify bool, certFile, keyFile, caFile string) []Option
  • func Insecure() Option
  • func RootCAs(file ...string) Option

Variables

var ErrArtifactsNotFound = errors.New("Execution doesn't have any artifacts associated with it")

ErrArtifactsNotFound contains error for not existing artifacts

Types

type ArtifactClient

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

func NewMinIOArtifactClient

func NewMinIOArtifactClient(client storage.Client) *ArtifactClient

NewMinIOArtifactClient returns new MinIO client

func (*ArtifactClient) DownloadArchive

func (c *ArtifactClient) DownloadArchive(ctx context.Context, executionId string, masks []string) (io.Reader, error)

DownloadArrchive downloads archive from bucket from the config

func (*ArtifactClient) DownloadFile

func (c *ArtifactClient) DownloadFile(ctx context.Context, file, executionId, testName, testSuiteName string) (io.Reader, error)

DownloadFile downloads file from bucket from the config

func (*ArtifactClient) GetValidBucketName

func (c *ArtifactClient) GetValidBucketName(parentType string, parentName string) string

func (*ArtifactClient) ListFiles

func (c *ArtifactClient) ListFiles(ctx context.Context, executionId, testName, testSuiteName string) ([]testkube.Artifact, error)

ListFiles lists available files in the bucket from the config

func (*ArtifactClient) PlaceFiles

func (c *ArtifactClient) PlaceFiles(ctx context.Context, bucketFolders []string, prefix string) error

PlaceFiles saves the content of the buckets to the filesystem

func (*ArtifactClient) UploadFile

func (c *ArtifactClient) UploadFile(ctx context.Context, bucketFolder, filePath string, reader io.Reader, objectSize int64) error

UploadFile saves a file to be copied into a running execution

type Client

type Client struct {
	Endpoint string

	Log *zap.SugaredLogger
	// contains filtered or unexported fields
}

Client for managing MinIO storage server

func NewClient

func NewClient(endpoint, accessKeyID, secretAccessKey, region, token, bucket string, opts ...Option) *Client

NewClient returns new MinIO client

func (*Client) Connect

func (c *Client) Connect() error

Connect connects to MinIO server

func (*Client) CreateBucket

func (c *Client) CreateBucket(ctx context.Context, bucket string) error

CreateBucket creates new S3 like bucket

func (*Client) DeleteBucket

func (c *Client) DeleteBucket(ctx context.Context, bucket string, force bool) error

DeleteBucket deletes bucket by name

func (*Client) DeleteFile

func (c *Client) DeleteFile(ctx context.Context, bucketFolder, file string) error

DeleteFile deletes a file from a bucket folder where bucket is provided by config

func (*Client) DeleteFileFromBucket

func (c *Client) DeleteFileFromBucket(ctx context.Context, bucket, bucketFolder, file string) error

DeleteFileFromBucket deletes a file from a bucket folder

func (*Client) DownloadArchive

func (c *Client) DownloadArchive(ctx context.Context, bucketFolder string, masks []string) (io.Reader, error)

DownloadArchive downloads archive from bucket from the config

func (*Client) DownloadArchiveFromBucket

func (c *Client) DownloadArchiveFromBucket(ctx context.Context, bucket, bucketFolder string, masks []string) (io.Reader, error)

DownloadArrchiveFromBucket downloads archive from given bucket

func (*Client) DownloadFile

func (c *Client) DownloadFile(ctx context.Context, bucketFolder, file string) (*minio.Object, error)

DownloadFile downloads file from bucket from the config

func (*Client) DownloadFileFromBucket

func (c *Client) DownloadFileFromBucket(ctx context.Context, bucket, bucketFolder, file string) (io.Reader, error)

DownloadFileFromBucket downloads file from given bucket

func (*Client) GetValidBucketName

func (c *Client) GetValidBucketName(parentType string, parentName string) string

GetValidBucketName returns a minio-compatible bucket name

func (*Client) IsConnectionPossible

func (c *Client) IsConnectionPossible(ctx context.Context) (bool, error)

IsConnectionPossible checks if the connection to minio is possible

func (*Client) ListBuckets

func (c *Client) ListBuckets(ctx context.Context) ([]string, error)

ListBuckets lists available buckets

func (*Client) ListFiles

func (c *Client) ListFiles(ctx context.Context, bucketFolder string) ([]testkube.Artifact, error)

ListFiles lists available files in the bucket from the config

func (*Client) PlaceFiles

func (c *Client) PlaceFiles(ctx context.Context, bucketFolders []string, prefix string) error

PlaceFiles saves the content of the buckets to the filesystem

func (*Client) SaveFile

func (c *Client) SaveFile(ctx context.Context, bucketFolder, filePath string) error

SaveFile saves file defined by local filePath to S3 bucket from the config

func (*Client) SaveFileDirect

func (c *Client) SaveFileDirect(ctx context.Context, folder, file string, data io.Reader, size int64, opts minio.PutObjectOptions) error

func (*Client) ScrapeArtefacts

func (c *Client) ScrapeArtefacts(ctx context.Context, id string, directories ...string) error

ScrapeArtefacts pushes local files located in directories to given folder with given id located in the configured bucket

func (*Client) SetExpirationPolicy

func (c *Client) SetExpirationPolicy(expirationDays int) error

func (*Client) UploadFile

func (c *Client) UploadFile(ctx context.Context, bucketFolder, filePath string, reader io.Reader, objectSize int64) error

UploadFile saves a file to be copied into a running execution

func (*Client) UploadFileToBucket

func (c *Client) UploadFileToBucket(ctx context.Context, bucket, bucketFolder, filePath string, reader io.Reader, objectSize int64) error

UploadFileToBucket saves a file to be copied into a running execution

type Option

type Option func(*Client) error

func ClientCert

func ClientCert(certFile, keyFile string) Option

ClientCert is a helper option to provide the client certificate from a file. If Secure is not already set this will set it as well.

func GetTLSOptions

func GetTLSOptions(ssl, skipVerify bool, certFile, keyFile, caFile string) []Option

func Insecure

func Insecure() Option

Insecure is an Option to enable TLS secure connections that skip server verification.

func RootCAs

func RootCAs(file ...string) Option

RootCAs is a helper option to provide the RootCAs pool from a list of filenames. If Secure is not already set this will set it as well.