spec

package
v1.2.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 12, 2020 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source 
const (
	// CephVersionLabelKey is the key used for reporting the Ceph version which Rook has detected is
	// configured for the labeled resource.
	CephVersionLabelKey = "ceph-version"
)
View Source 
const (
	// ConfigInitContainerName is the name which is given to the config initialization container
	// in all Ceph pods.
	ConfigInitContainerName = "config-init"
)

Variables

This section is empty.

Functions

func AddCephVersionLabelToDaemonSet added in v1.0.0 

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 added in v1.0.0 

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 added in v1.0.0 

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 added in v1.1.0 

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

func AddVolumeMountSubPath added in v1.1.0 

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 added in v1.0.0 

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(dataPaths *config.DataPathMap, 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 added in v1.0.0 

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

CheckPodMemory verify pod's memory limit is valid

func ChownCephDataDirsInitContainer added in v1.2.0 

func ChownCephDataDirsInitContainer(
	dpm config.DataPathMap,
	containerImage string,
	volumeMounts []v1.VolumeMount,
	resources v1.ResourceRequirements,
	securityContext *v1.SecurityContext,
) v1.Container

ChownCephDataDirsInitContainer returns an init container which `chown`s the given data directories as the `ceph:ceph` user in the container. It also `chown`s the Ceph log dir in the container automatically. Doing a chown in a post start lifecycle hook does not reliably complete before the OSD process starts, which can cause the pod to fail without the lifecycle hook's chown command completing. It can take an arbitrarily long time for a pod restart to successfully chown the directory. This is a race condition for all daemons; therefore, do this in an init container. See more discussion here: https://github.com/rook/rook/pull/3594#discussion_r312279176

func ContainerEnvVarReference added in v1.0.0 

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 added in v1.0.0 

func DaemonEnvVars(image string) []v1.EnvVar

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

func DaemonFlags added in v1.0.0 

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

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

func DaemonVolumeMounts added in v1.0.0 

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 added in v1.0.0 

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 added in v1.1.0 

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

DaemonVolumesBase returns the common / static set of volumes.

func DaemonVolumesContainsPVC added in v1.1.0 

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 added in v1.1.0 

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

DaemonVolumesDataHostPath returns HostPath volume source for daemon container data.

func DaemonVolumesDataPVC added in v1.1.0 

func DaemonVolumesDataPVC(pvcName string) v1.Volume

DaemonVolumesDataPVC returns a PVC volume source for daemon container data.

func ExtractCephVersionFromLabel added in v1.2.3 

func ExtractCephVersionFromLabel(labelVersion string) (*version.CephVersion, error)

ExtractCephVersionFromLabel returns a CephVersion struct deserialized from a provided version label.

func GetCephVersionLabel added in v1.2.3 

func GetCephVersionLabel(cephVersion version.CephVersion) string

GetCephVersionLabel returns a formatted serialization of a provided CephVersion for use in resource labels.

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 PodVolumes 

func PodVolumes(dataPaths *config.DataPathMap, dataDirHostPath 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(dataPaths *config.DataPathMap, confGeneratedInPod bool) []v1.VolumeMount

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

func StoredLogAndCrashVolume added in v1.2.0 

func StoredLogAndCrashVolume(hostLogDir, hostCrashDir string) []v1.Volume

StoredLogAndCrashVolume returns a pod volume sourced from the stored log and crashes files.

func StoredLogAndCrashVolumeMount added in v1.2.0 

func StoredLogAndCrashVolumeMount(varLogCephDir, varLibCephCrashDir string) []v1.VolumeMount

StoredLogAndCrashVolumeMount returns a pod volume sourced from the stored log and crashes files.

func ValidateCephVersionsBetweenLocalAndExternalClusters added in v1.1.0 

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

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.