obc

Documentation

Index

• func CheckPhase(obc *nbv1.ObjectBucketClaim)
• func Cmd() *cobra.Command
• func CmdCreate() *cobra.Command
• func CmdDelete() *cobra.Command
• func CmdList() *cobra.Command
• func CmdRegenerate() *cobra.Command
• func CmdStatus() *cobra.Command
• func GenerateAccountKeys(name string, accountName string) error
• func RunCreate(cmd *cobra.Command, args []string)
• func RunDelete(cmd *cobra.Command, args []string)
• func RunList(cmd *cobra.Command, args []string)
• func RunProvisioner(client client.Client, scheme *runtime.Scheme, recorder record.EventRecorder) error
• func RunRegenerate(cmd *cobra.Command, args []string)
• func RunStatus(cmd *cobra.Command, args []string)
• func ValidateOB(ob *nbv1.ObjectBucket) error
• func ValidateOBC(obc *nbv1.ObjectBucketClaim) error
• func WaitReady(obc *nbv1.ObjectBucketClaim) bool
• type BucketRequest
  • func NewBucketRequest(p *Provisioner, ob *nbv1.ObjectBucket, bucketOptions *obAPI.BucketOptions) (*BucketRequest, error)
  • func (r *BucketRequest) CreateAccount() error
  • func (r *BucketRequest) CreateAndUpdateBucket(p *Provisioner, bucketOptions *obAPI.BucketOptions) error
  • func (r *BucketRequest) DeleteAccount() error
  • func (r *BucketRequest) DeleteBucket() error
  • func (r *BucketRequest) LogAndGetError(format string, a ...interface{}) error
  • func (r *BucketRequest) UpdateBucket() error
• type Provisioner
  • func (p *Provisioner) Delete(ob *nbv1.ObjectBucket) error
  • func (p *Provisioner) Grant(bucketOptions *obAPI.BucketOptions) (*nbv1.ObjectBucket, error)
  • func (p *Provisioner) Provision(bucketOptions *obAPI.BucketOptions) (*nbv1.ObjectBucket, error)
  • func (p *Provisioner) Revoke(ob *nbv1.ObjectBucket) error
  • func (p *Provisioner) Update(ob *nbv1.ObjectBucket) error

Functions

func CheckPhase

func CheckPhase(obc *nbv1.ObjectBucketClaim)

CheckPhase prints the phase and reason for it

func Cmd

func Cmd() *cobra.Command

Cmd returns a CLI command

func CmdCreate

func CmdCreate() *cobra.Command

CmdCreate returns a CLI command

func CmdDelete

func CmdDelete() *cobra.Command

CmdDelete returns a CLI command

func CmdList

func CmdList() *cobra.Command

CmdList returns a CLI command

func CmdRegenerate

func CmdRegenerate() *cobra.Command

CmdRegenerate returns a CLI command

func CmdStatus

func CmdStatus() *cobra.Command

CmdStatus returns a CLI command

func GenerateAccountKeys

func GenerateAccountKeys(name string, accountName string) error

GenerateAccountKeys regenerate noobaa OBC account S3 keys

func RunCreate

func RunCreate(cmd *cobra.Command, args []string)

RunCreate runs a CLI command

func RunDelete

func RunDelete(cmd *cobra.Command, args []string)

RunDelete runs a CLI command

func RunList

func RunList(cmd *cobra.Command, args []string)

RunList runs a CLI command

func RunProvisioner

func RunProvisioner(client client.Client, scheme *runtime.Scheme, recorder record.EventRecorder) error

RunProvisioner will run OBC provisioner

func RunRegenerate

func RunRegenerate(cmd *cobra.Command, args []string)

RunRegenerate runs a CLI command

func RunStatus

func RunStatus(cmd *cobra.Command, args []string)

RunStatus runs a CLI command

func ValidateOB

func ValidateOB(ob *nbv1.ObjectBucket) error

ValidateOB validate object bucket

func ValidateOBC

func ValidateOBC(obc *nbv1.ObjectBucketClaim) error

ValidateOBC validate object bucket claim

func WaitReady

func WaitReady(obc *nbv1.ObjectBucketClaim) bool

WaitReady waits until the obc phase changes to bound by the operator

Types

type BucketRequest

type BucketRequest struct {
	Provisioner *Provisioner
	OB          *nbv1.ObjectBucket
	OBC         *nbv1.ObjectBucketClaim
	BucketName  string
	AccountName string
	SysClient   *system.Client
	BucketClass *nbv1.BucketClass
}

BucketRequest is the context of handling a single bucket request

func NewBucketRequest

func NewBucketRequest(
	p *Provisioner,
	ob *nbv1.ObjectBucket,
	bucketOptions *obAPI.BucketOptions,
) (*BucketRequest, error)

NewBucketRequest initializes an obc bucket request

func (*BucketRequest) CreateAccount

func (r *BucketRequest) CreateAccount() error

CreateAccount creates the obc account

func (*BucketRequest) CreateAndUpdateBucket

func (r *BucketRequest) CreateAndUpdateBucket(
	p *Provisioner,
	bucketOptions *obAPI.BucketOptions,
) error

CreateAndUpdateBucket creates the obc bucket and update

func (*BucketRequest) DeleteAccount

func (r *BucketRequest) DeleteAccount() error

DeleteAccount deletes the obc account

func (*BucketRequest) DeleteBucket

func (r *BucketRequest) DeleteBucket() error

DeleteBucket deletes the obc bucket **including data**

func (*BucketRequest) LogAndGetError

func (r *BucketRequest) LogAndGetError(format string, a ...interface{}) error

LogAndGetError error handler. prints error message to log and returns error

func (*BucketRequest) UpdateBucket

func (r *BucketRequest) UpdateBucket() error

UpdateBucket update obc bucket

type Provisioner

type Provisioner struct {
	Logger    *logrus.Entry
	Namespace string
	// contains filtered or unexported fields
}

Provisioner implements lib-bucket-provisioner callbacks

func (*Provisioner) Delete

func (p *Provisioner) Delete(ob *nbv1.ObjectBucket) error

Delete implements lib-bucket-provisioner callback to delete a bucket

func (*Provisioner) Grant

func (p *Provisioner) Grant(bucketOptions *obAPI.BucketOptions) (*nbv1.ObjectBucket, error)

Grant implements lib-bucket-provisioner callback to use an existing bucket

func (*Provisioner) Provision

func (p *Provisioner) Provision(bucketOptions *obAPI.BucketOptions) (*nbv1.ObjectBucket, error)

Provision implements lib-bucket-provisioner callback to create a new bucket

func (*Provisioner) Revoke

func (p *Provisioner) Revoke(ob *nbv1.ObjectBucket) error

Revoke implements lib-bucket-provisioner callback to stop using an existing bucket

func (*Provisioner) Update

func (p *Provisioner) Update(ob *nbv1.ObjectBucket) error

Update implements lib-bucket-provisioner callback to stop using an existing bucket additional config of OBC