ostor

README

ostor

Package ostor wraps around the object storage management API provided by Virtuozzo Hybrid Infrastructure (VHI) and Acronis Cyber Infrastructure (ACI). You can use this as a library if you wish.

In order to use this code, you need to provision a system user account, to create one, follow the links below.

Further reading:

• ACI: Integration via REST API
• VHI: Integration via REST API

Documentation

Index

• type AccessKeyList
• type AccessKeyPair
• type Bucket
• type BucketSize
• type ItemCountersNet
• type ItemCountersOps
• type ItemKey
• type OStorObjectUsageResponse
• type OStorResponse
• type Ostor
  • func New(endpoint, accessKeyID, secretKeyID string) (*Ostor, error)
  • func (o *Ostor) CreateUser(email string) (*OstorCreateUserResponse, *resty.Response, error)
  • func (o *Ostor) DeleteUser(email string) (*resty.Response, error)
  • func (o *Ostor) GenerateCredentials(email string) (*OstorCreateUserResponse, *resty.Response, error)
  • func (o *Ostor) GetBuckets(email string) (*OstorBucketListResponse, *resty.Response, error)
  • func (o *Ostor) GetUser(email string) (*OstorUser, *resty.Response, error)
  • func (o *Ostor) GetUserLimits(email string) (*OstorUserLimits, *resty.Response, error)
  • func (o *Ostor) List(after *string) (*OStorResponse, *resty.Response, error)
  • func (o *Ostor) ListUsers(usage bool) (*OstorUsersListResponse, *resty.Response, error)
  • func (o *Ostor) LockUnlockUser(email string, lock bool) (*resty.Response, error)
  • func (o *Ostor) ObjectUsage(object string) (*OStorObjectUsageResponse, *resty.Response, error)
  • func (o *Ostor) RevokeKey(email, accessKeyID string) (*resty.Response, error)
  • func (o *Ostor) RotateKey(email, accessKeyID string) (*AccessKeyPair, *resty.Response, error)
• type OstorBucketListResponse
• type OstorCreateUserResponse
• type OstorUser
• type OstorUserLimits
• type OstorUsersListResponse
• type UserSpaceStat

Types

type AccessKeyList

type AccessKeyList []AccessKeyPair

type AccessKeyPair

type AccessKeyPair struct {
	AccessKeyID     string `json:"AWSAccessKeyId"`
	SecretAccessKey string `json:"AWSSecretAccessKey"`
}

type Bucket

type Bucket struct {
	Name      string     `json:"name"`
	Epoch     int        `json:"epoc"`
	CreatedAt string     `json:"creation_date"`
	OwnerID   string     `json:"owner_id"`
	Size      BucketSize `json:"size"`
}

type BucketSize

type BucketSize struct {
	Current   int64 `json:"current"`
	HMax      int64 `json:"hmax"`
	HIntegral int64 `json:"h_integral"`
	LastTS    int64 `json:"last_ts"`
}

type ItemCountersNet

type ItemCountersNet struct {
	Uploaded   int64 `json:"uploaded"`
	Downloaded int64 `json:"downloaded"`
}

type ItemCountersOps

type ItemCountersOps struct {
	Put   int64 `json:"put"`
	Get   int64 `json:"get"`
	List  int64 `json:"list"`
	Other int64 `json:"other"`
}

type ItemKey

type ItemKey struct {
	Bucket string `json:"bucket"`
	// identifier for the item/record
	Epoch  int    `json:"epoch"`
	UserID string `json:"user_id"`
	Tag    string `json:"tag"`
}

type OStorObjectUsageResponse

type OStorObjectUsageResponse struct {
	// probably an API version of some kind
	Version int `json:"fmt_version"`
	// volume ID (ostor-ctl get-config)
	ServiceID string `json:"service_id"`
	// start time of the object you are looking at
	StartTS int64 `json:"start_ts"`
	// sample interval of the object (usually ~30 seconds)
	Period int `json:"period"`
	// number of items in the response
	Count int `json:"nr_items"`
	// the actual items
	Items []struct {
		Key      ItemKey `json:"key"`
		Counters struct {
			Operations ItemCountersOps `json:"ops"`
			Net        ItemCountersNet `json:"net_io"`
		} `json:"counters"`
	} `json:"items"`
}

type OStorResponse

type OStorResponse struct {
	Count     int      `json:"nr_items"`
	Truncated bool     `json:"truncated"`
	Items     []string `json:"items"`
}

type Ostor

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

func New

func New(endpoint, accessKeyID, secretKeyID string) (*Ostor, error)

func (*Ostor) CreateUser

func (o *Ostor) CreateUser(email string) (*OstorCreateUserResponse, *resty.Response, error)

func (*Ostor) DeleteUser

func (o *Ostor) DeleteUser(email string) (*resty.Response, error)

func (*Ostor) GenerateCredentials

func (o *Ostor) GenerateCredentials(email string) (*OstorCreateUserResponse, *resty.Response, error)

func (*Ostor) GetBuckets

func (o *Ostor) GetBuckets(email string) (*OstorBucketListResponse, *resty.Response, error)

func (*Ostor) GetUser

func (o *Ostor) GetUser(email string) (*OstorUser, *resty.Response, error)

func (*Ostor) GetUserLimits

func (o *Ostor) GetUserLimits(email string) (*OstorUserLimits, *resty.Response, error)

func (*Ostor) List

func (o *Ostor) List(after *string) (*OStorResponse, *resty.Response, error)

func (*Ostor) ListUsers

func (o *Ostor) ListUsers(usage bool) (*OstorUsersListResponse, *resty.Response, error)

func (*Ostor) LockUnlockUser

func (o *Ostor) LockUnlockUser(email string, lock bool) (*resty.Response, error)

func (*Ostor) ObjectUsage

func (o *Ostor) ObjectUsage(object string) (*OStorObjectUsageResponse, *resty.Response, error)

func (*Ostor) RevokeKey

func (o *Ostor) RevokeKey(email, accessKeyID string) (*resty.Response, error)

func (*Ostor) RotateKey

func (o *Ostor) RotateKey(email, accessKeyID string) (*AccessKeyPair, *resty.Response, error)

RotateKey attempts to rotate the accessKeyID for the given user (email).

This feature is not a native feature in the APIs, so we build around it using our own methods, by checking the user account and verifying what can happen.

type OstorBucketListResponse

type OstorBucketListResponse struct {
	Buckets []Bucket `json:"Buckets"`
}

type OstorCreateUserResponse

type OstorCreateUserResponse struct {
	Email      string        `json:"UserEmail"`
	ID         string        `json:"UserId"`
	AccessKeys AccessKeyList `json:"AWSAccessKeys"`
}

type OstorUser

type OstorUser struct {
	Email        string         `json:"UserEmail"`
	ID           string         `json:"UserId"`
	State        string         `json:"State"`
	Owner        string         `json:"OwnerId"`
	Flags        []string       `json:"Flags"`
	AccessKeys   AccessKeyList  `json:"AWSAccessKeys,omitempty"`
	AccountCount string         `json:"AccountCount,omitempty"`
	Accounts     []interface{}  `json:"Accounts,omitempty"`
	Space        *UserSpaceStat `json:"SpaceStat,omitempty"`
}

type OstorUserLimits

type OstorUserLimits struct {
	OpsDefault   string `json:"ops:default"`
	OpsGet       string `json:"ops:get"`
	OpsPut       string `json:"ops:put"`
	OpsList      string `json:"ops:list"`
	OpsDelete    string `json:"ops:delete"`
	BandwidthOut string `json:"bandwidth:out"`
}

limits in ops/second bandwidth in kb/second

type OstorUsersListResponse

type OstorUsersListResponse struct {
	Users []OstorUser `json:"users"`
}

type UserSpaceStat

type UserSpaceStat struct {
	LastUpdated int   `json:"LastTs"`
	Current     int64 `json:"SizeCurr"`
	SizeHMax    int64 `json:"SizeHMax"` // FIXME: what is it?
	SizeHInt    int64 `json:"SizeHInt"` // FIXME: what is it?
}