object

Documentation

Overview

Package object for the Ceph object store.

Index

• Constants
• func Add(mgr manager.Manager, context *clusterd.Context) error
• func DeleteBucket(c *Context, bucketName string, purge bool) (int, error)
• func DeleteUser(c *Context, id string, opts ...string) (string, error)
• func GetBucketsStats(c *Context) (map[string]ObjectBucketStats, error)
• func GetObjectBucketProvisioner(c *clusterd.Context, namespace string) string
• func LinkUser(c *Context, id, bucket string) (string, int, error)
• func ListUsers(c *Context) ([]string, int, error)
• func SetQuotaUserBucketMax(c *Context, id string, max int) (string, int, error)
• func UnlinkUser(c *Context, id, bucket string) (string, int, error)
• type Context
  • func NewContext(context *clusterd.Context, name, clusterName string) *Context
• type ObjectBucket
  • func GetBucket(c *Context, bucket string) (*ObjectBucket, int, error)
  • func ListBuckets(c *Context) ([]ObjectBucket, error)
• type ObjectBucketMetadata
• type ObjectBucketStats
  • func GetBucketStats(c *Context, bucketName string) (*ObjectBucketStats, bool, error)
• type ObjectBuckets
  • func (slice ObjectBuckets) Len() int
  • func (slice ObjectBuckets) Less(i, j int) bool
  • func (slice ObjectBuckets) Swap(i, j int)
• type ObjectUser
  • func CreateUser(c *Context, user ObjectUser) (*ObjectUser, int, error)
  • func GetUser(c *Context, id string) (*ObjectUser, int, error)
  • func UpdateUser(c *Context, user ObjectUser) (*ObjectUser, int, error)
• type ReconcileCephObjectStore
  • func (r *ReconcileCephObjectStore) Reconcile(request reconcile.Request) (reconcile.Result, error)

Constants

const (
	RGWErrorNone = iota
	RGWErrorUnknown
	RGWErrorNotFound
	RGWErrorBadData
	RGWErrorParse
	ErrorCodeFileExists = 17
)

const (

	// AppName is the name Rook uses for the object store's application
	AppName = "rook-ceph-rgw"
)

Functions

func Add

func Add(mgr manager.Manager, context *clusterd.Context) error

Add creates a new cephObjectStore Controller and adds it to the Manager. The Manager will set fields on the Controller and Start it when the Manager is Started.

func DeleteBucket

func DeleteBucket(c *Context, bucketName string, purge bool) (int, error)

func DeleteUser

func DeleteUser(c *Context, id string, opts ...string) (string, error)

DeleteUser deletes the user with the given ID.

func GetBucketsStats

func GetBucketsStats(c *Context) (map[string]ObjectBucketStats, error)

func GetObjectBucketProvisioner

func GetObjectBucketProvisioner(c *clusterd.Context, namespace string) string

GetObjectBucketProvisioner returns the bucket provisioner name appended with operator namespace if OBC is watching on it

func LinkUser

func LinkUser(c *Context, id, bucket string) (string, int, error)

func ListUsers

func ListUsers(c *Context) ([]string, int, error)

ListUsers lists the object pool users.

func SetQuotaUserBucketMax

func SetQuotaUserBucketMax(c *Context, id string, max int) (string, int, error)

func UnlinkUser

func UnlinkUser(c *Context, id, bucket string) (string, int, error)

Types

type Context

type Context struct {
	Context     *clusterd.Context
	Name        string
	ClusterName string
	RunAsUser   string
}

Context holds the context for the object store.

func NewContext

func NewContext(context *clusterd.Context, name, clusterName string) *Context

NewContext creates a new object store context.

type ObjectBucket

type ObjectBucket struct {
	Name string `json:"name"`
	ObjectBucketMetadata
	ObjectBucketStats
}

func GetBucket

func GetBucket(c *Context, bucket string) (*ObjectBucket, int, error)

func ListBuckets

func ListBuckets(c *Context) ([]ObjectBucket, error)

type ObjectBucketMetadata

type ObjectBucketMetadata struct {
	Owner     string    `json:"owner"`
	CreatedAt time.Time `json:"createdAt"`
}

type ObjectBucketStats

type ObjectBucketStats struct {
	Size            uint64 `json:"size"`
	NumberOfObjects uint64 `json:"numberOfObjects"`
}

func GetBucketStats

func GetBucketStats(c *Context, bucketName string) (*ObjectBucketStats, bool, error)

type ObjectBuckets

type ObjectBuckets []ObjectBucket

func (ObjectBuckets) Len

func (slice ObjectBuckets) Len() int

func (ObjectBuckets) Less

func (slice ObjectBuckets) Less(i, j int) bool

func (ObjectBuckets) Swap

func (slice ObjectBuckets) Swap(i, j int)

type ObjectUser

type ObjectUser struct {
	UserID      string  `json:"userId"`
	DisplayName *string `json:"displayName"`
	Email       *string `json:"email"`
	AccessKey   *string `json:"accessKey"`
	SecretKey   *string `json:"secretKey"`
}

An ObjectUser defines the details of an object store user.

func CreateUser

func CreateUser(c *Context, user ObjectUser) (*ObjectUser, int, error)

CreateUser creates a new user with the information given.

func GetUser

func GetUser(c *Context, id string) (*ObjectUser, int, error)

GetUser returns the user with the given ID.

func UpdateUser

func UpdateUser(c *Context, user ObjectUser) (*ObjectUser, int, error)

UpdateUser updates the user whose ID matches the user.

type ReconcileCephObjectStore

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

ReconcileCephObjectStore reconciles a cephObjectStore object

func (*ReconcileCephObjectStore) Reconcile

func (r *ReconcileCephObjectStore) Reconcile(request reconcile.Request) (reconcile.Result, error)

Reconcile reads that state of the cluster for a cephObjectStore object and makes changes based on the state read and what is in the cephObjectStore.Spec The Controller will requeue the Request to be processed again if the returned error is non-nil or Result.Requeue is true, otherwise upon completion it will remove the work from the queue.