rgw

Documentation

Overview

Copyright 2016 The Rook Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2016 The Rook Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2017 The Rook Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2016 The Rook Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2016 The Rook Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2016 The Rook Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2016 The Rook Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func CreateObjectStore(context *Context, metadataSpec, dataSpec model.Pool, serviceIP string, ...) error
• func DeleteBucket(c *Context, bucketName string, purge bool) (int, error)
• func DeleteObjectStore(context *Context) error
• func DeleteUser(c *Context, id string) (string, int, error)
• func GetBucketsStats(c *Context) (map[string]ObjectBucketStats, error)
• func GetObjectStores(context *Context) ([]string, error)
• func ListUsers(c *Context) ([]string, int, error)
• func Run(context *clusterd.Context, config *Config) error
• type Config
• 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)

Constants

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

const (
	DNSName = "rook-ceph-rgw"
)

Functions

func CreateObjectStore

func CreateObjectStore(context *Context, metadataSpec, dataSpec model.Pool, serviceIP string, port int32) error

func DeleteBucket

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

func DeleteObjectStore

func DeleteObjectStore(context *Context) error

func DeleteUser

func DeleteUser(c *Context, id string) (string, int, error)

func GetBucketsStats

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

func GetObjectStores

func GetObjectStores(context *Context) ([]string, error)

func ListUsers

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

func Run

func Run(context *clusterd.Context, config *Config) error

Types

type Config

type Config struct {
	Name            string
	Host            string
	Port            int
	SecurePort      int
	Keyring         string
	CertificatePath string
	ClusterInfo     *mon.ClusterInfo
}

type Context

type Context struct {
	Name        string
	ClusterName string
	// contains filtered or unexported fields
}

func NewContext

func NewContext(context *clusterd.Context, name, clusterName string) *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"`
}

func CreateUser

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

func GetUser

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

func UpdateUser

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