config

Documentation

Overview

Package config provides methods for creating and formatting Ceph configuration files for daemons.

Index

• Constants
• Variables
• func AdminKeyring(c *ClusterInfo) string
• func CreateKeyring(context *clusterd.Context, clusterName, username, keyringPath string, ...) error
• func DefaultConfigFilePath() string
• func ExternalUserKeyring(userName, keyring string) string
• func GenerateAdminConnectionConfig(context *clusterd.Context, cluster *ClusterInfo) (string, error)
• func GenerateAdminConnectionConfigWithSettings(context *clusterd.Context, cluster *ClusterInfo, settings *CephConfig) (string, error)
• func GenerateConfigFile(context *clusterd.Context, cluster *ClusterInfo, ...) (string, error)
• func GetConfFilePath(root, clusterName string) string
• func IsKeyringBase64Encoded(keyring string) bool
• func PopulateMonHostMembers(monitors map[string]*MonInfo) ([]string, []string)
• func WriteKeyring(keyringPath, authKey string, generateContents func(string) string) error
• type CephConfig
  • func CreateDefaultCephConfig(context *clusterd.Context, cluster *ClusterInfo) (*CephConfig, error)
• type ClusterInfo
  • func (c *ClusterInfo) IsInitialized() bool
  • func (c *ClusterInfo) IsInitializedExternalCred(logError bool) bool
  • func (c *ClusterInfo) Log(logger *capnslog.PackageLogger)
• type ExternalCred
• type GlobalConfig
• type MonInfo
  • func NewMonInfo(name, ip string, port int32) *MonInfo

Constants

const (
	// DefaultKeyringFile is the default name of the file where Ceph stores its keyring info
	DefaultKeyringFile = "keyring"
	// Msgr2port is the listening port of the messenger v2 protocol
	Msgr2port = 3300
)

const (
	// AdminKeyringTemplate is a string template of Ceph keyring settings which allow connection
	// as admin. The key value must be filled in by the admin auth key for the cluster.
	AdminKeyringTemplate = `
[client.admin]
	key = %s
	caps mds = "allow *"
	caps mon = "allow *"
	caps osd = "allow *"
	caps mgr = "allow *"
`

	// ExternalUserKeyringTemplate is a string template of Ceph keyring settings which allow connection
	// as admin. The key value must be filled in by the admin auth key for the cluster.
	ExternalUserKeyringTemplate = `
[%s]
	key = %s
`
)

Variables

var (
	// DefaultConfigDir is the default dir where Ceph stores its configs. Can be overridden for unit
	// tests.
	DefaultConfigDir = "/etc/ceph"

	// DefaultConfigFile is the default name of the file where Ceph stores its configs. Can be
	// overridden for unit tests.
	DefaultConfigFile = "ceph.conf"
)

Functions

func AdminKeyring

func AdminKeyring(c *ClusterInfo) string

AdminKeyring returns the filled-out admin keyring

func CreateKeyring

func CreateKeyring(context *clusterd.Context, clusterName, username, keyringPath string, access []string, generateContents func(string) string) error

CreateKeyring creates a keyring for access to the cluster with the desired set of privileges and writes it to disk at the keyring path

func DefaultConfigFilePath

func DefaultConfigFilePath() string

DefaultConfigFilePath returns the full path to Ceph's default config file

func ExternalUserKeyring

func ExternalUserKeyring(userName, keyring string) string

ExternalUserKeyring returns the filled-out external checker user keyring

func GenerateAdminConnectionConfig

func GenerateAdminConnectionConfig(context *clusterd.Context, cluster *ClusterInfo) (string, error)

GenerateAdminConnectionConfig calls GenerateAdminConnectionConfigWithSettings with no settings overridden.

func GenerateAdminConnectionConfigWithSettings

func GenerateAdminConnectionConfigWithSettings(context *clusterd.Context, cluster *ClusterInfo, settings *CephConfig) (string, error)

GenerateAdminConnectionConfigWithSettings generates a Ceph config and keyring which will allow the daemon to connect as an admin. Default config file settings can be overridden by specifying some subset of settings.

func GenerateConfigFile

func GenerateConfigFile(context *clusterd.Context, cluster *ClusterInfo, pathRoot, user, keyringPath string, globalConfig *CephConfig, clientSettings map[string]string) (string, error)

GenerateConfigFile generates and writes a config file to disk.

func GetConfFilePath

func GetConfFilePath(root, clusterName string) string

GetConfFilePath gets the path of a given cluster's config file

func IsKeyringBase64Encoded

func IsKeyringBase64Encoded(keyring string) bool

IsKeyringBase64Encoded returns whether the keyring is valid

func PopulateMonHostMembers

func PopulateMonHostMembers(monitors map[string]*MonInfo) ([]string, []string)

PopulateMonHostMembers extracts a list of just the monitor names, which will populate the "mon initial members" and "mon hosts" global config field

func WriteKeyring

func WriteKeyring(keyringPath, authKey string, generateContents func(string) string) error

WriteKeyring calls the generate contents function with auth key as an argument then saves the output of the generateContents function to disk at the keyring path TODO: Kludgey; can keyring files be generated w/ go-ini package or using the '-o' option to 'ceph auth get-or-create ...'?

Types

type CephConfig

type CephConfig struct {
	*GlobalConfig `ini:"global,omitempty"`
}

CephConfig represents an entire Ceph config including all sections.

func CreateDefaultCephConfig

func CreateDefaultCephConfig(context *clusterd.Context, cluster *ClusterInfo) (*CephConfig, error)

CreateDefaultCephConfig creates a default ceph config file.

type ClusterInfo

type ClusterInfo struct {
	FSID          string
	MonitorSecret string
	AdminSecret   string
	ExternalCred  ExternalCred
	Name          string
	Monitors      map[string]*MonInfo
	CephVersion   cephver.CephVersion
}

ClusterInfo is a collection of information about a particular Ceph cluster. Rook uses information about the cluster to configure daemons to connect to the desired cluster.

func (*ClusterInfo) IsInitialized

func (c *ClusterInfo) IsInitialized() bool

IsInitialized returns true if the critical information in the ClusterInfo struct has been filled in. This method exists less out of necessity than the desire to be explicit about the lifecycle of the ClusterInfo struct during startup, specifically that it is expected to exist after the Rook operator has started up or connected to the first components of the Ceph cluster.

func (*ClusterInfo) IsInitializedExternalCred

func (c *ClusterInfo) IsInitializedExternalCred(logError bool) bool

IsInitializedExternalCred returns true if the critical information in the ExternalCred struct has been filled in for the external cluster connection

func (*ClusterInfo) Log

func (c *ClusterInfo) Log(logger *capnslog.PackageLogger)

Log writes the cluster info struct to the logger

type ExternalCred

type ExternalCred struct {
	Username string `json:"name"`
	Secret   string `json:"secret"`
}

ExternalCred represents the external cluster username and key

type GlobalConfig

type GlobalConfig struct {
	FSID           string `ini:"fsid,omitempty"`
	MonMembers     string `ini:"mon initial members,omitempty"`
	MonHost        string `ini:"mon host"`
	PublicAddr     string `ini:"public addr,omitempty"`
	PublicNetwork  string `ini:"public network,omitempty"`
	ClusterAddr    string `ini:"cluster addr,omitempty"`
	ClusterNetwork string `ini:"cluster network,omitempty"`
}

GlobalConfig represents the [global] sections of Ceph's config file.

type MonInfo

type MonInfo struct {
	Name     string `json:"name"`
	Endpoint string `json:"endpoint"`
}

MonInfo is a collection of information about a Ceph mon.

func NewMonInfo

func NewMonInfo(name, ip string, port int32) *MonInfo

NewMonInfo returns a new Ceph mon info struct from the given inputs.