spec

Documentation

Overview

Package spec provides Kubernetes controller/pod/container spec items used for many Ceph daemons

Index

• Constants
• func AddCephVersionLabelToDaemonSet(cephVersion version.CephVersion, d *apps.DaemonSet)
• func AddCephVersionLabelToDeployment(cephVersion version.CephVersion, d *apps.Deployment)
• func AddCephVersionLabelToJob(cephVersion version.CephVersion, j *batch.Job)
• func AddCephVersionLabelToObjectMeta(cephVersion version.CephVersion, meta *metav1.ObjectMeta)
• func AddVolumeMountSubPath(podSpec *v1.PodSpec, volumeMountName string)
• func AdminFlags(cluster *cephconfig.ClusterInfo) []string
• func AppLabels(appName, namespace string) map[string]string
• func CephVolumeMounts(confGeneratedInPod bool) []v1.VolumeMount
• func CheckPodMemory(resources v1.ResourceRequirements, cephPodMinimumMemory uint64) error
• func ContainerEnvVarReference(envVarName string) string
• func DaemonEnvVars(image string) []v1.EnvVar
• func DaemonFlags(cluster *cephconfig.ClusterInfo, daemonID string) []string
• func DaemonVolumeMounts(dataPaths *config.DataPathMap, keyringResourceName string) []v1.VolumeMount
• func DaemonVolumes(dataPaths *config.DataPathMap, keyringResourceName string) []v1.Volume
• func DaemonVolumesBase(dataPaths *config.DataPathMap, keyringResourceName string) []v1.Volume
• func DaemonVolumesContainsPVC(volumes []v1.Volume) bool
• func DaemonVolumesDataHostPath(dataPaths *config.DataPathMap) []v1.Volume
• func DaemonVolumesDataPVC(pvcName string) v1.Volume
• func PodLabels(appName, namespace, daemonType, daemonID string) map[string]string
• func PodLifeCycle(dataDirHostPath string) *v1.Lifecycle
• func PodVolumes(dataDirHostPath, namespace string, confGeneratedInPod bool) []v1.Volume
• func RookVolumeMounts(confGeneratedInPod bool) []v1.VolumeMount
• func StoredLogVolume(HostLogDir string) v1.Volume
• func StoredLogVolumeMount() v1.VolumeMount
• func ValidateCephVersionsBetweenLocalAndExternalClusters(context *clusterd.Context, namespace string, localVersion cephver.CephVersion) (cephver.CephVersion, error)

Constants

const (
	// CephVersionLabelKey is the key used for reporting the Ceph version which Rook has detected is
	// configured for the labeled resource.
	CephVersionLabelKey = "ceph-version"
)

const (
	// ConfigInitContainerName is the name which is given to the config initialization container
	// in all Ceph pods.
	ConfigInitContainerName = "config-init"
)

Functions

func AddCephVersionLabelToDaemonSet

func AddCephVersionLabelToDaemonSet(cephVersion version.CephVersion, d *apps.DaemonSet)

AddCephVersionLabelToDaemonSet adds a label reporting the Ceph version which Rook has detected is running in the DaemonSet's pods.

func AddCephVersionLabelToDeployment

func AddCephVersionLabelToDeployment(cephVersion version.CephVersion, d *apps.Deployment)

AddCephVersionLabelToDeployment adds a label reporting the Ceph version which Rook has detected is running in the Deployment's pods.

func AddCephVersionLabelToJob

func AddCephVersionLabelToJob(cephVersion version.CephVersion, j *batch.Job)

AddCephVersionLabelToJob adds a label reporting the Ceph version which Rook has detected is running in the Job's pods.

func AddCephVersionLabelToObjectMeta

func AddCephVersionLabelToObjectMeta(cephVersion version.CephVersion, meta *metav1.ObjectMeta)

func AddVolumeMountSubPath

func AddVolumeMountSubPath(podSpec *v1.PodSpec, volumeMountName string)

AddVolumeMountSubPath updates each init and regular container of the podspec such that each volume mount attached to a container is mounted under a subpath in the source volume. This is important because some daemons may not start if the volume mount directory is non-empty. When the volume is the root of an ext4 file system, one may find a "lost+found" directory.

func AdminFlags

func AdminFlags(cluster *cephconfig.ClusterInfo) []string

AdminFlags returns the command line flags used for Ceph commands requiring admin authentication.

func AppLabels

func AppLabels(appName, namespace string) map[string]string

AppLabels returns labels common for all Rook-Ceph applications which may be useful for admins. App name is the name of the application: e.g., 'rook-ceph-mon', 'rook-ceph-mgr', etc.

func CephVolumeMounts

func CephVolumeMounts(confGeneratedInPod bool) []v1.VolumeMount

CephVolumeMounts returns the common list of Kubernetes volume mounts for Ceph containers. This function is only used for OSDs.

func CheckPodMemory

func CheckPodMemory(resources v1.ResourceRequirements, cephPodMinimumMemory uint64) error

CheckPodMemory verify pod's memory limit is valid

func ContainerEnvVarReference

func ContainerEnvVarReference(envVarName string) string

ContainerEnvVarReference returns a reference to a Kubernetes container env var of the given name which can be used in command or argument fields.

func DaemonEnvVars

func DaemonEnvVars(image string) []v1.EnvVar

DaemonEnvVars returns the container environment variables used by all Ceph daemons.

func DaemonFlags

func DaemonFlags(cluster *cephconfig.ClusterInfo, daemonID string) []string

DaemonFlags returns the command line flags used by all Ceph daemons.

func DaemonVolumeMounts

func DaemonVolumeMounts(dataPaths *config.DataPathMap, keyringResourceName string) []v1.VolumeMount

DaemonVolumeMounts returns volume mounts which correspond to the DaemonVolumes. These volume mounts are shared by most all Ceph daemon containers, both init and standard. If keyring resource name is empty, there will be no keyring mounted in the container.

func DaemonVolumes

func DaemonVolumes(dataPaths *config.DataPathMap, keyringResourceName string) []v1.Volume

DaemonVolumes returns the pod volumes used by all Ceph daemons. If keyring resource name is empty, there will be no keyring volume created from a secret.

func DaemonVolumesBase

func DaemonVolumesBase(dataPaths *config.DataPathMap, keyringResourceName string) []v1.Volume

DaemonVolumesBase returns the common / static set of volumes.

func DaemonVolumesContainsPVC

func DaemonVolumesContainsPVC(volumes []v1.Volume) bool

DaemonVolumesContainsPVC returns true if a volume exists with a volume source configured with a persistent volume claim.

func DaemonVolumesDataHostPath

func DaemonVolumesDataHostPath(dataPaths *config.DataPathMap) []v1.Volume

DaemonVolumesDataHostPath returns HostPath volume source for daemon container data.

func DaemonVolumesDataPVC

func DaemonVolumesDataPVC(pvcName string) v1.Volume

DaemonVolumesDataPVC returns a PVC volume source for daemon container data.

func PodLabels

func PodLabels(appName, namespace, daemonType, daemonID string) map[string]string

PodLabels returns pod labels common to all Rook-Ceph pods which may be useful for admins. App name is the name of the application: e.g., 'rook-ceph-mon', 'rook-ceph-mgr', etc. Daemon type is the Ceph daemon type: "mon", "mgr", "osd", "mds", "rgw" Daemon ID is the ID portion of the Ceph daemon name: "a" for "mon.a"; "c" for "mds.c"

func PodLifeCycle

func PodLifeCycle(dataDirHostPath string) *v1.Lifecycle

PodLifeCycle returns a pod lifecycle resource to execute actions before a pod starts

func PodVolumes

func PodVolumes(dataDirHostPath, namespace string, confGeneratedInPod bool) []v1.Volume

PodVolumes fills in the volumes parameter with the common list of Kubernetes volumes for use in Ceph pods. This function is only used for OSDs.

func RookVolumeMounts

func RookVolumeMounts(confGeneratedInPod bool) []v1.VolumeMount

RookVolumeMounts returns the common list of Kubernetes volume mounts for Rook containers. This function is only used by OSDs.

func StoredLogVolume

func StoredLogVolume(HostLogDir string) v1.Volume

StoredLogVolume returns a pod volume sourced from the stored log files.

func StoredLogVolumeMount

func StoredLogVolumeMount() v1.VolumeMount

StoredLogVolumeMount returns a pod volume sourced from the stored log files.

func ValidateCephVersionsBetweenLocalAndExternalClusters

func ValidateCephVersionsBetweenLocalAndExternalClusters(context *clusterd.Context, namespace string, localVersion cephver.CephVersion) (cephver.CephVersion, error)

ValidateCephVersionsBetweenLocalAndExternalClusters makes sure an external cluster can be connected by checking the external ceph versions available and comparing it with the local image provided