osd

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 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.

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 AddDesiredDevice(etcdClient etcd.KeysAPI, nodeID, uuid string, osdID int) error
• func AddDesiredDir(etcdClient etcd.KeysAPI, dir, nodeID string) error
• func GetAppliedOSDs(nodeID string, etcdClient etcd.KeysAPI) (map[int]string, error)
• func PopulateCollocatedPerfSchemeEntry(entry *PerfSchemeEntry, device string, storeConfig StoreConfig) error
• func PopulateDistributedPerfSchemeEntry(entry *PerfSchemeEntry, device string, metadataInfo *MetadataDeviceInfo, ...) error
• func RemoveDesiredDevice(etcdClient etcd.KeysAPI, nodeID, uuid string) error
• func Run(context *clusterd.Context, agent *OsdAgent) error
• type Device
• type DeviceOsdIDEntry
• type DeviceOsdMapping
  • func NewDeviceOsdMapping() *DeviceOsdMapping
• type Leader
  • func NewLeader() *Leader
  • func (l *Leader) Configure(context *clusterd.Context, nodes []string) error
• type MetadataDeviceInfo
  • func NewMetadataDeviceInfo(device string) *MetadataDeviceInfo
  • func (m *MetadataDeviceInfo) GetPartitionArgs() []string
• type MetadataDevicePartition
• type OsdAgent
  • func NewAgent(devices string, usingDeviceFilter bool, metadataDevice, directories string, ...) *OsdAgent
  • func (a *OsdAgent) ConfigureLocalService(context *clusterd.Context) error
  • func (a *OsdAgent) DestroyLocalService(context *clusterd.Context) error
  • func (a *OsdAgent) Initialize(context *clusterd.Context) error
  • func (a *OsdAgent) Name() string
• type PartitionType
• type PerfScheme
  • func LoadScheme(configDir string) (*PerfScheme, error)
  • func NewPerfScheme() *PerfScheme
  • func (s *PerfScheme) Save(configDir string) error
• type PerfSchemeEntry
  • func NewPerfSchemeEntry(storeType string) *PerfSchemeEntry
  • func (e *PerfSchemeEntry) GetPartitionArgs() []string
  • func (e *PerfSchemeEntry) IsCollocated() bool
• type PerfSchemePartitionDetails
• type StoreConfig

Constants

const (
	DevicesValue     = "devices"
	ForceFormatValue = "forceFormat"
)

const (
	Filestore         = "filestore"
	Bluestore         = "bluestore"
	DefaultStore      = Filestore
	UseRemainingSpace = -1

	WalDefaultSizeMB     = 576
	DBDefaultSizeMB      = 20480
	JournalDefaultSizeMB = 5120
)

Functions

func AddDesiredDevice

func AddDesiredDevice(etcdClient etcd.KeysAPI, nodeID, uuid string, osdID int) error

add a device to the desired state

func AddDesiredDir

func AddDesiredDir(etcdClient etcd.KeysAPI, dir, nodeID string) error

add a device to the desired state

func GetAppliedOSDs

func GetAppliedOSDs(nodeID string, etcdClient etcd.KeysAPI) (map[int]string, error)

For all applied OSDs, gets a mapping of their osd IDs to their data device uuid

func PopulateCollocatedPerfSchemeEntry

func PopulateCollocatedPerfSchemeEntry(entry *PerfSchemeEntry, device string, storeConfig StoreConfig) error

populates a partition scheme entry for an OSD where all its partitions are collocated on a single device

func PopulateDistributedPerfSchemeEntry

func PopulateDistributedPerfSchemeEntry(entry *PerfSchemeEntry, device string, metadataInfo *MetadataDeviceInfo,
	storeConfig StoreConfig) error

populates a partition scheme entry for an OSD that will have distributed partitions: its metadata will live on a dedicated metadata device and its block data will live on a dedicated device

func RemoveDesiredDevice

func RemoveDesiredDevice(etcdClient etcd.KeysAPI, nodeID, uuid string) error

remove a device from the desired state

func Run

func Run(context *clusterd.Context, agent *OsdAgent) error

Types

type Device

type Device struct {
	Name   string `json:"name"`
	NodeID string `json:"nodeId"`
	Dir    bool   `json:"bool"`
}

type DeviceOsdIDEntry

type DeviceOsdIDEntry struct {
	Data     int   // OSD ID that has data stored here
	Metadata []int // OSD IDs (multiple) that have metadata stored here
}

type DeviceOsdMapping

type DeviceOsdMapping struct {
	Entries map[string]*DeviceOsdIDEntry // device name to OSD ID mapping entry
}

func NewDeviceOsdMapping

func NewDeviceOsdMapping() *DeviceOsdMapping

type Leader

type Leader struct {
}

func NewLeader

func NewLeader() *Leader

func (*Leader) Configure

func (l *Leader) Configure(context *clusterd.Context, nodes []string) error

Apply the desired state to the cluster. The context provides all the information needed to make changes to the service.

type MetadataDeviceInfo

type MetadataDeviceInfo struct {
	Device     string                     `json:"device"`
	DiskUUID   string                     `json:"diskUuid"`
	Partitions []*MetadataDevicePartition `json:"partitions"`
}

represents a dedicated metadata device and all of the partitions stored on it

func NewMetadataDeviceInfo

func NewMetadataDeviceInfo(device string) *MetadataDeviceInfo

func (*MetadataDeviceInfo) GetPartitionArgs

func (m *MetadataDeviceInfo) GetPartitionArgs() []string

type MetadataDevicePartition

type MetadataDevicePartition struct {
	ID            int           `json:"id"`
	OsdUUID       uuid.UUID     `json:"osdUuid"`
	Type          PartitionType `json:"type"`
	PartitionUUID string        `json:"partitionUuid"`
	SizeMB        int           `json:"sizeMB"`
	OffsetMB      int           `json:"offsetMB"`
}

representsa specific partition on a metadata device, including details about which OSD it belongs to

type OsdAgent

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

func NewAgent

func NewAgent(devices string, usingDeviceFilter bool, metadataDevice, directories string, forceFormat bool,
	location string, storeConfig StoreConfig, cluster *mon.ClusterInfo, nodeName string) *OsdAgent

func (*OsdAgent) ConfigureLocalService

func (a *OsdAgent) ConfigureLocalService(context *clusterd.Context) error

func (*OsdAgent) DestroyLocalService

func (a *OsdAgent) DestroyLocalService(context *clusterd.Context) error

func (*OsdAgent) Initialize

func (a *OsdAgent) Initialize(context *clusterd.Context) error

set the desired state in etcd

func (*OsdAgent) Name

func (a *OsdAgent) Name() string

type PartitionType

type PartitionType int

const (
	WalPartitionType PartitionType = iota
	DatabasePartitionType
	BlockPartitionType
	FilestoreDataPartitionType
	FilestoreJournalPartitionType
)

type PerfScheme

type PerfScheme struct {
	Metadata *MetadataDeviceInfo `json:"metadata"`
	Entries  []*PerfSchemeEntry  `json:"entries"`
}

top level representation of an overall performance oriented partition scheme, with a dedicated metadata device and entries for all OSDs that define where their partitions live

func LoadScheme

func LoadScheme(configDir string) (*PerfScheme, error)

Load the persistent partition info from the config directory.

func NewPerfScheme

func NewPerfScheme() *PerfScheme

func (*PerfScheme) Save

func (s *PerfScheme) Save(configDir string) error

Save the partition scheme to the config dir

type PerfSchemeEntry

type PerfSchemeEntry struct {
	ID         int                                           `json:"id"`
	OsdUUID    uuid.UUID                                     `json:"osdUuid"`
	Partitions map[PartitionType]*PerfSchemePartitionDetails `json:"partitions"` // mapping of partition name to its details
	StoreType  string                                        `json:"storeType,omitempty"`
}

represents an OSD and details about all of its partitions

func NewPerfSchemeEntry

func NewPerfSchemeEntry(storeType string) *PerfSchemeEntry

func (*PerfSchemeEntry) GetPartitionArgs

func (e *PerfSchemeEntry) GetPartitionArgs() []string

func (*PerfSchemeEntry) IsCollocated

func (e *PerfSchemeEntry) IsCollocated() bool

determines if the given partition scheme entry is for a collocated OSD (all partitions on 1 device)

type PerfSchemePartitionDetails

type PerfSchemePartitionDetails struct {
	Device        string `json:"device"`
	DiskUUID      string `json:"diskUuid"`
	PartitionUUID string `json:"partitionUuid"`
	SizeMB        int    `json:"sizeMB"`
	OffsetMB      int    `json:"offsetMB"`
}

details for 1 OSD partition

type StoreConfig

type StoreConfig struct {
	StoreType      string `json:"storeType,omitempty"`
	WalSizeMB      int    `json:"walSizeMB,omitempty"`
	DatabaseSizeMB int    `json:"databaseSizeMB,omitempty"`
	JournalSizeMB  int    `json:"journalSizeMB,omitempty"`
}