config

Documentation

Overview

Package config provides methods for generating the Ceph config for a Ceph cluster and for producing a "ceph.conf" compatible file from the config as well as Ceph command line-compatible flags.

Package config provides a shared way of referring to data storage locations for Ceph Daemons, including both the in-container location and on-host location as well as whether the data is persisted to the host.

Package config provides default configurations which Rook will set in Ceph clusters.

Package config allows a ceph config file to be stored in Kubernetes and mounted as volumes into Ceph daemon containers.

Index

• Constants
• Variables
• func DefaultFlags(fsid, mountedKeyringPath string, cephVersion version.CephVersion) []string
• func NewFlag(key, value string) string
• func SetDefaultConfigs(context *clusterd.Context, namespace string, ...) error
• func StoredMonHostEnvVarFlags() []string
• func StoredMonHostEnvVars() []v1.EnvVar
• type DaemonType
• type DataPathMap
  • func NewDatalessDaemonDataPathMap(namespace, dataDirHostPath string) *DataPathMap
  • func NewStatefulDaemonDataPathMap(dataDirHostPath, daemonDataDirHostRelativePath string, daemonType DaemonType, ...) *DataPathMap
  • func NewStatelessDaemonDataPathMap(daemonType DaemonType, daemonID, namespace, dataDirHostPath string) *DataPathMap
• type MonStore
  • func GetMonStore(context *clusterd.Context, namespace string) *MonStore
  • func (m *MonStore) Set(who, option, value string) error
  • func (m *MonStore) SetAll(options ...Option) error
• type Option
  • func DefaultCentralizedConfigs(cephVersion version.CephVersion) []Option
  • func DefaultLegacyConfigs() []Option
• type Store
  • func GetStore(context *clusterd.Context, namespace string, ownerRef *metav1.OwnerReference) *Store
  • func (s *Store) CreateOrUpdate(clusterInfo *cephconfig.ClusterInfo) error

Constants

const (
	// StoreName is the name of the configmap containing ceph configuration options
	StoreName = "rook-ceph-config"

	// Msgr2port is the listening port of the messenger v2 protocol
	Msgr2port = 3300
)

Variables

var (
	// VarLibCephDir is simply "/var/lib/ceph". It is made overwriteable only for unit tests where it
	// may be needed to send data intended for /var/lib/ceph to a temporary test dir.
	VarLibCephDir = "/var/lib/ceph"

	// EtcCephDir is simply "/etc/ceph". It is made overwriteable only for unit tests where it
	// may be needed to send data intended for /etc/ceph to a temporary test dir.
	EtcCephDir = "/etc/ceph"

	// VarLogCephDir defines Ceph logging directory. It is made overwriteable only for unit tests where it
	// may be needed to send data intended for /var/log/ceph to a temporary test dir.
	VarLogCephDir = "/var/log/ceph"

	// ContainerPostStartCmd is the command we run before starting any Ceph daemon
	// It makes sure Ceph directories are owned by 'ceph'
	ContainerPostStartCmd = []string{"chown", "--recursive", chownUserGroup, VarLogCephDir}
)

Functions

func DefaultFlags

func DefaultFlags(fsid, mountedKeyringPath string, cephVersion version.CephVersion) []string

DefaultFlags returns the default configuration flags Rook will set on the command line for all calls to Ceph daemons and tools. Values specified here will not be able to be overridden using the mon's central KV store, and that is (and should be) by intent.

func NewFlag

func NewFlag(key, value string) string

NewFlag returns the key-value pair in the format of a Ceph command line-compatible flag.

func SetDefaultConfigs

func SetDefaultConfigs(
	context *clusterd.Context,
	namespace string,
	clusterInfo *cephconfig.ClusterInfo,
) error

SetDefaultConfigs sets Rook's desired default configs in the centralized monitor database. This cannot be called before at least one monitor is established.

func StoredMonHostEnvVarFlags

func StoredMonHostEnvVarFlags() []string

StoredMonHostEnvVarFlags returns Ceph commandline flag references to "mon_host" and "mon_initial_members" sourced from the StoredMonHostEnvVars.

func StoredMonHostEnvVars

func StoredMonHostEnvVars() []v1.EnvVar

StoredMonHostEnvVars returns a container environment variable defined by the most updated stored "mon_host" and "mon_initial_members" information.

Types

type DaemonType

type DaemonType string

DaemonType defines the type of a daemon. e.g., mon, mgr, osd, mds, rgw

const (
	// MonType defines the mon DaemonType
	MonType DaemonType = "mon"

	// MgrType defines the mgr DaemonType
	MgrType DaemonType = "mgr"

	// OsdType defines the osd DaemonType
	OsdType DaemonType = "osd"

	// MdsType defines the mds DaemonType
	MdsType DaemonType = "mds"

	// RgwType defines the rgw DaemonType
	RgwType DaemonType = "rgw"

	// RbdMirrorType defines the rbd-mirror DaemonType
	RbdMirrorType DaemonType = "rbd-mirror"

	// CephUser is the Linux Ceph username
	CephUser = "ceph"

	// CephGroup is the Linux Ceph groupname
	CephGroup = "ceph"
)

type DataPathMap

type DataPathMap struct {
	// HostDataDir should be set to the path on the host where the specific daemon's data is stored.
	// If this is empty, the daemon does not persist data to the host, but data may still be shared
	// between containers in a pod via an empty dir.
	HostDataDir string

	// ContainerDataDir should be set to the path in the container where the specific daemon's data
	// is stored. If this is empty, the daemon does not store data at all, even in the container,
	// and data is not shared between container in a pod via empty dir.
	ContainerDataDir string

	// HostLogDir represents Ceph's logging directory on the host. If this is empty, logs are not
	// persisted to the host. The log dir is always /var/log/ceph. If logs are not persisted to the
	// host, logs are not shared between containers via empty dir or any other mechanism.
	HostLogDir string
}

A DataPathMap is a struct which contains information about where Ceph daemon data is stored in containers and whether the data should be persisted to the host. If it is persisted to the host, directory on the host where the specific daemon's data is stored is given.

func NewDatalessDaemonDataPathMap

func NewDatalessDaemonDataPathMap(namespace, dataDirHostPath string) *DataPathMap

NewDatalessDaemonDataPathMap returns a new DataPathMap for a daemon which does not utilize a data dir in the container as the mon, mgr, osd, mds, and rgw daemons do.

func NewStatefulDaemonDataPathMap

func NewStatefulDaemonDataPathMap(
	dataDirHostPath, daemonDataDirHostRelativePath string,
	daemonType DaemonType, daemonID, namespace string,
) *DataPathMap

NewStatefulDaemonDataPathMap returns a new DataPathMap for a daemon which requires a persistent config (mons, osds). daemonDataDirHostRelativePath is the path relative to the dataDirHostPath where the daemon's data is stored on the host's filesystem. Daemons which use a DataPathMap created by this method will only have access to their own data and not the entire dataDirHostPath which may include data from other daemons.

func NewStatelessDaemonDataPathMap

func NewStatelessDaemonDataPathMap(
	daemonType DaemonType, daemonID, namespace, dataDirHostPath string,
) *DataPathMap

NewStatelessDaemonDataPathMap returns a new DataPathMap for a daemon which does not persist data to the host (mgrs, mdses, rgws)

type MonStore

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

MonStore provides methods for setting Ceph configurations in the centralized mon configuration database.

func GetMonStore

func GetMonStore(context *clusterd.Context, namespace string) *MonStore

GetMonStore returns a new MonStore for the cluster.

func (*MonStore) Set

func (m *MonStore) Set(who, option, value string) error

Set sets a config in the centralized mon configuration database. https://docs.ceph.com/docs/master/rados/configuration/ceph-conf/#monitor-configuration-database

func (*MonStore) SetAll

func (m *MonStore) SetAll(options ...Option) error

SetAll sets all configs from the overrides in the centralized mon configuration database. See MonStore.Set for more.

type Option

type Option struct {
	// Who is the entity(-ies) the option should apply to.
	Who string

	// Option is the option key
	Option string

	// Value is the value for the option
	Value string
}

Option defines the pieces of information relevant to Ceph configuration options.

func DefaultCentralizedConfigs

func DefaultCentralizedConfigs(cephVersion version.CephVersion) []Option

DefaultCentralizedConfigs returns the default configuration options Rook will set in Ceph's centralized config store.

func DefaultLegacyConfigs

func DefaultLegacyConfigs() []Option

DefaultLegacyConfigs need to be added to the Ceph config file until the integration tests can be made to override these options for the Ceph clusters it creates.

type Store

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

Store manages storage of the Ceph config file shared by all daemons (if applicable) as well as an updated 'mon_host' which can be mapped to daemon containers and referenced in daemon command line arguments.

func GetStore

func GetStore(context *clusterd.Context, namespace string, ownerRef *metav1.OwnerReference) *Store

GetStore returns the Store for the cluster.

func (*Store) CreateOrUpdate

func (s *Store) CreateOrUpdate(clusterInfo *cephconfig.ClusterInfo) error

CreateOrUpdate creates or updates the stored Ceph config based on the cluster info.