/* 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. */ // Package osd for the Ceph OSDs. package osd import ( "fmt" "os" "path" "path/filepath" "strconv" "strings" rookalpha "github.com/rook/rook/pkg/apis/rook.io/v1alpha2" opmon "github.com/rook/rook/pkg/operator/ceph/cluster/mon" "github.com/rook/rook/pkg/operator/ceph/cluster/osd/config" opspec "github.com/rook/rook/pkg/operator/ceph/spec" "github.com/rook/rook/pkg/operator/ceph/version" "github.com/rook/rook/pkg/operator/k8sutil" apps "k8s.io/api/apps/v1" batch "k8s.io/api/batch/v1" v1 "k8s.io/api/core/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" ) const ( dataDirsEnvVarName = "ROOK_DATA_DIRECTORIES" osdStoreEnvVarName = "ROOK_OSD_STORE" osdDatabaseSizeEnvVarName = "ROOK_OSD_DATABASE_SIZE" osdWalSizeEnvVarName = "ROOK_OSD_WAL_SIZE" osdJournalSizeEnvVarName = "ROOK_OSD_JOURNAL_SIZE" osdsPerDeviceEnvVarName = "ROOK_OSDS_PER_DEVICE" encryptedDeviceEnvVarName = "ROOK_ENCRYPTED_DEVICE" osdMetadataDeviceEnvVarName = "ROOK_METADATA_DEVICE" rookBinariesMountPath = "/rook" rookBinariesVolumeName = "rook-binaries" osdMemoryTargetSafetyFactor float32 = 0.8 ) func (c *Cluster) makeJob(nodeName string, devices []rookalpha.Device, selection rookalpha.Selection, resources v1.ResourceRequirements, storeConfig config.StoreConfig, metadataDevice, location string) (*batch.Job, error) { podSpec, err := c.provisionPodTemplateSpec(devices, selection, resources, storeConfig, metadataDevice, nodeName, location, v1.RestartPolicyOnFailure) if err != nil { return nil, err } podSpec.Spec.NodeSelector = map[string]string{v1.LabelHostname: nodeName} job := &batch.Job{ ObjectMeta: metav1.ObjectMeta{ Name: k8sutil.TruncateNodeName(prepareAppNameFmt, nodeName), Namespace: c.Namespace, Labels: map[string]string{ k8sutil.AppAttr: prepareAppName, k8sutil.ClusterAttr: c.Namespace, }, }, Spec: batch.JobSpec{ Template: *podSpec, }, } k8sutil.AddRookVersionLabelToJob(job) opspec.AddCephVersionLabelToJob(c.clusterInfo.CephVersion, job) k8sutil.SetOwnerRef(c.context.Clientset, c.Namespace, &job.ObjectMeta, &c.ownerRef) return job, nil } func (c *Cluster) makeDeployment(nodeName string, selection rookalpha.Selection, resources v1.ResourceRequirements, storeConfig config.StoreConfig, metadataDevice, location string, osd OSDInfo) (*apps.Deployment, error) { replicaCount := int32(1) volumeMounts := opspec.CephVolumeMounts() configVolumeMounts := opspec.RookVolumeMounts() volumes := opspec.PodVolumes(c.dataDirHostPath, c.Namespace) var dataDir string if osd.IsDirectory { // Mount the path to the directory-based osd // osd.DataPath includes the osd subdirectory, so we want to mount the parent directory parentDir := filepath.Dir(osd.DataPath) dataDir = parentDir // Skip the mount if this is the default directory being mounted. Inside the container, the path // will be mounted at "/var/lib/rook" even if the dataDirHostPath is a different path on the host. if parentDir != k8sutil.DataDir { volumeName := k8sutil.PathToVolumeName(parentDir) dataDirSource := v1.VolumeSource{HostPath: &v1.HostPathVolumeSource{Path: parentDir}} volumes = append(volumes, v1.Volume{Name: volumeName, VolumeSource: dataDirSource}) configVolumeMounts = append(configVolumeMounts, v1.VolumeMount{Name: volumeName, MountPath: parentDir}) volumeMounts = append(volumeMounts, v1.VolumeMount{Name: volumeName, MountPath: parentDir}) } } else { dataDir = k8sutil.DataDir // Create volume config for /dev so the pod can access devices on the host devVolume := v1.Volume{Name: "devices", VolumeSource: v1.VolumeSource{HostPath: &v1.HostPathVolumeSource{Path: "/dev"}}} volumes = append(volumes, devVolume) devMount := v1.VolumeMount{Name: "devices", MountPath: "/dev"} volumeMounts = append(volumeMounts, devMount) } if len(volumes) == 0 { return nil, fmt.Errorf("empty volumes") } storeType := config.Bluestore if osd.IsFileStore { storeType = config.Filestore } osdID := strconv.Itoa(osd.ID) tiniEnvVar := v1.EnvVar{Name: "TINI_SUBREAPER", Value: ""} envVars := []v1.EnvVar{ nodeNameEnvVar(nodeName), k8sutil.PodIPEnvVar(k8sutil.PrivateIPEnvVar), k8sutil.PodIPEnvVar(k8sutil.PublicIPEnvVar), tiniEnvVar, } envVars = append(envVars, k8sutil.ClusterDaemonEnvVars(c.cephVersion.Image)...) envVars = append(envVars, []v1.EnvVar{ {Name: "ROOK_OSD_UUID", Value: osd.UUID}, {Name: "ROOK_OSD_ID", Value: osdID}, {Name: "ROOK_OSD_STORE_TYPE", Value: storeType}, }...) configEnvVars := append(c.getConfigEnvVars(storeConfig, dataDir, nodeName, location), []v1.EnvVar{ tiniEnvVar, {Name: "ROOK_OSD_ID", Value: osdID}, {Name: "ROOK_CEPH_VERSION", Value: c.clusterInfo.CephVersion.CephVersionFormatted()}, }...) if !osd.IsDirectory { configEnvVars = append(configEnvVars, v1.EnvVar{Name: "ROOK_IS_DEVICE", Value: "true"}) } commonArgs := []string{ "--foreground", "--id", osdID, "--conf", osd.Config, "--osd-data", osd.DataPath, "--keyring", osd.KeyringPath, "--cluster", osd.Cluster, "--osd-uuid", osd.UUID, } // Set osd memory target to the best appropriate value if !osd.IsFileStore { // As of Nautilus Ceph auto-tunes its osd_memory_target on the fly so we don't need to force it if !c.clusterInfo.CephVersion.IsAtLeastNautilus() && !c.resources.Limits.Memory().IsZero() { osdMemoryTargetValue := float32(c.resources.Limits.Memory().Value()) * osdMemoryTargetSafetyFactor commonArgs = append(commonArgs, fmt.Sprintf("--osd-memory-target=%f", osdMemoryTargetValue)) } } if osd.IsFileStore { commonArgs = append(commonArgs, fmt.Sprintf("--osd-journal=%s", osd.Journal)) } if c.clusterInfo.CephVersion.IsAtLeast(version.CephVersion{Major: 14, Minor: 2, Extra: 1}) { commonArgs = append(commonArgs, "--default-log-to-file", "false") } // Add the volume to the spec and the mount to the daemon container copyBinariesVolume, copyBinariesContainer := c.getCopyBinariesContainer() volumes = append(volumes, copyBinariesVolume) volumeMounts = append(volumeMounts, copyBinariesContainer.VolumeMounts[0]) var command []string var args []string if !osd.IsDirectory && osd.IsFileStore && !osd.CephVolumeInitiated { // All scenarios except one can call the ceph-osd daemon directly. The one different scenario is when // filestore is running on a device. Rook needs to mount the device, run the ceph-osd daemon, and then // when the daemon exits, rook needs to unmount the device. Since rook needs to be in the container // for this scenario, we will copy the binaries necessary to a mount, which will then be mounted // to the daemon container. sourcePath := path.Join("/dev/disk/by-partuuid", osd.DevicePartUUID) command = []string{path.Join(k8sutil.BinariesMountPath, "tini")} args = append([]string{ "--", path.Join(k8sutil.BinariesMountPath, "rook"), "ceph", "osd", "filestore-device", "--source-path", sourcePath, "--mount-path", osd.DataPath, "--"}, commonArgs...) } else if osd.CephVolumeInitiated { // if the osd was provisioned by ceph-volume, we need to launch it with rook as the parent process command = []string{path.Join(rookBinariesMountPath, "tini")} args = []string{ "--", path.Join(rookBinariesMountPath, "rook"), "ceph", "osd", "start", "--", "--foreground", "--id", osdID, "--osd-uuid", osd.UUID, "--conf", osd.Config, "--cluster", "ceph", } // Set osd memory target to the best appropriate value if !osd.IsFileStore { // As of Nautilus Ceph auto-tunes its osd_memory_target on the fly so we don't need to force it if !c.clusterInfo.CephVersion.IsAtLeastNautilus() && !c.resources.Limits.Memory().IsZero() { osdMemoryTargetValue := float32(c.resources.Limits.Memory().Value()) * osdMemoryTargetSafetyFactor commonArgs = append(commonArgs, fmt.Sprintf("--osd-memory-target=%f", osdMemoryTargetValue)) } } if c.clusterInfo.CephVersion.IsAtLeast(version.CephVersion{Major: 14, Minor: 2, Extra: 1}) { args = append(args, "--default-log-to-file", "false") } // mount /run/udev in the container so ceph-volume (via `lvs`) // can access the udev database volumes = append(volumes, v1.Volume{ Name: "run-udev", VolumeSource: v1.VolumeSource{ HostPath: &v1.HostPathVolumeSource{Path: "/run/udev"}}}) volumeMounts = append(volumeMounts, v1.VolumeMount{ Name: "run-udev", MountPath: "/run/udev"}) } else { // other osds can launch the osd daemon directly command = []string{"ceph-osd"} args = commonArgs } privileged := true runAsUser := int64(0) readOnlyRootFilesystem := false securityContext := &v1.SecurityContext{ Privileged: &privileged, RunAsUser: &runAsUser, ReadOnlyRootFilesystem: &readOnlyRootFilesystem, } // needed for luksOpen synchronization when devices are encrypted hostIPC := storeConfig.EncryptedDevice DNSPolicy := v1.DNSClusterFirst if c.HostNetwork { DNSPolicy = v1.DNSClusterFirstWithHostNet } deployment := &apps.Deployment{ ObjectMeta: metav1.ObjectMeta{ Name: fmt.Sprintf(osdAppNameFmt, osd.ID), Namespace: c.Namespace, Labels: map[string]string{ k8sutil.AppAttr: appName, k8sutil.ClusterAttr: c.Namespace, osdLabelKey: fmt.Sprintf("%d", osd.ID), }, }, Spec: apps.DeploymentSpec{ Selector: &metav1.LabelSelector{ MatchLabels: map[string]string{ k8sutil.AppAttr: appName, k8sutil.ClusterAttr: c.Namespace, osdLabelKey: fmt.Sprintf("%d", osd.ID), }, }, Strategy: apps.DeploymentStrategy{ Type: apps.RecreateDeploymentStrategyType, }, Template: v1.PodTemplateSpec{ ObjectMeta: metav1.ObjectMeta{ Name: appName, Labels: map[string]string{ k8sutil.AppAttr: appName, k8sutil.ClusterAttr: c.Namespace, osdLabelKey: fmt.Sprintf("%d", osd.ID), }, }, Spec: v1.PodSpec{ NodeSelector: map[string]string{v1.LabelHostname: nodeName}, RestartPolicy: v1.RestartPolicyAlways, ServiceAccountName: serviceAccountName, HostNetwork: c.HostNetwork, HostPID: true, HostIPC: hostIPC, DNSPolicy: DNSPolicy, InitContainers: []v1.Container{ { Args: []string{"ceph", "osd", "init"}, Name: opspec.ConfigInitContainerName, Image: k8sutil.MakeRookImage(c.rookVersion), VolumeMounts: configVolumeMounts, Env: configEnvVars, SecurityContext: securityContext, }, *copyBinariesContainer, }, Containers: []v1.Container{ { Command: command, Args: args, Name: "osd", Image: c.cephVersion.Image, VolumeMounts: volumeMounts, Env: envVars, Resources: resources, SecurityContext: securityContext, }, }, Volumes: volumes, }, }, Replicas: &replicaCount, }, } k8sutil.AddRookVersionLabelToDeployment(deployment) c.annotations.ApplyToObjectMeta(&deployment.ObjectMeta) c.annotations.ApplyToObjectMeta(&deployment.Spec.Template.ObjectMeta) opspec.AddCephVersionLabelToDeployment(c.clusterInfo.CephVersion, deployment) opspec.AddCephVersionLabelToDeployment(c.clusterInfo.CephVersion, deployment) k8sutil.SetOwnerRef(c.context.Clientset, c.Namespace, &deployment.ObjectMeta, &c.ownerRef) c.placement.ApplyToPodSpec(&deployment.Spec.Template.Spec) return deployment, nil } // To get rook inside the container, the config init container needs to copy "tini" and "rook" binaries into a volume. // Get the config flag so rook will copy the binaries and create the volume and mount that will be shared between // the init container and the daemon container func (c *Cluster) getCopyBinariesContainer() (v1.Volume, *v1.Container) { volume := v1.Volume{Name: rookBinariesVolumeName, VolumeSource: v1.VolumeSource{EmptyDir: &v1.EmptyDirVolumeSource{}}} mount := v1.VolumeMount{Name: rookBinariesVolumeName, MountPath: rookBinariesMountPath} return volume, &v1.Container{ Args: []string{"ceph", "osd", "copybins"}, Name: "copy-bins", Image: k8sutil.MakeRookImage(c.rookVersion), VolumeMounts: []v1.VolumeMount{mount}, Env: []v1.EnvVar{{Name: "ROOK_PATH", Value: rookBinariesMountPath}}, } } func (c *Cluster) provisionPodTemplateSpec(devices []rookalpha.Device, selection rookalpha.Selection, resources v1.ResourceRequirements, storeConfig config.StoreConfig, metadataDevice, nodeName, location string, restart v1.RestartPolicy) (*v1.PodTemplateSpec, error) { copyBinariesVolume, copyBinariesContainer := c.getCopyBinariesContainer() volumes := append(opspec.PodVolumes(c.dataDirHostPath, c.Namespace), copyBinariesVolume) // by default, don't define any volume config unless it is required if len(devices) > 0 || selection.DeviceFilter != "" || selection.GetUseAllDevices() || metadataDevice != "" { // create volume config for the data dir and /dev so the pod can access devices on the host devVolume := v1.Volume{Name: "devices", VolumeSource: v1.VolumeSource{HostPath: &v1.HostPathVolumeSource{Path: "/dev"}}} volumes = append(volumes, devVolume) udevVolume := v1.Volume{Name: "udev", VolumeSource: v1.VolumeSource{HostPath: &v1.HostPathVolumeSource{Path: "/run/udev"}}} volumes = append(volumes, udevVolume) } // add each OSD directory as another host path volume source for _, d := range selection.Directories { if c.skipVolumeForDirectory(d.Path) { // the dataDirHostPath has already been added as a volume continue } dirVolume := v1.Volume{ Name: k8sutil.PathToVolumeName(d.Path), VolumeSource: v1.VolumeSource{HostPath: &v1.HostPathVolumeSource{Path: d.Path}}, } volumes = append(volumes, dirVolume) } if len(volumes) == 0 { return nil, fmt.Errorf("empty volumes") } podSpec := v1.PodSpec{ ServiceAccountName: serviceAccountName, Containers: []v1.Container{ *copyBinariesContainer, c.provisionOSDContainer(devices, selection, resources, storeConfig, metadataDevice, nodeName, location, copyBinariesContainer.VolumeMounts[0]), }, RestartPolicy: restart, Volumes: volumes, HostNetwork: c.HostNetwork, } if c.HostNetwork { podSpec.DNSPolicy = v1.DNSClusterFirstWithHostNet } c.placement.ApplyToPodSpec(&podSpec) podMeta := metav1.ObjectMeta{ Name: appName, Labels: map[string]string{ k8sutil.AppAttr: prepareAppName, k8sutil.ClusterAttr: c.Namespace, }, Annotations: map[string]string{}, } c.annotations.ApplyToObjectMeta(&podMeta) // ceph-volume --dmcrypt uses cryptsetup that synchronizes with udev on // host through semaphore podSpec.HostIPC = storeConfig.EncryptedDevice return &v1.PodTemplateSpec{ ObjectMeta: podMeta, Spec: podSpec, }, nil } func (c *Cluster) getConfigEnvVars(storeConfig config.StoreConfig, dataDir, nodeName, location string) []v1.EnvVar { envVars := []v1.EnvVar{ nodeNameEnvVar(nodeName), {Name: "ROOK_CLUSTER_ID", Value: string(c.ownerRef.UID)}, k8sutil.PodIPEnvVar(k8sutil.PrivateIPEnvVar), k8sutil.PodIPEnvVar(k8sutil.PublicIPEnvVar), opmon.ClusterNameEnvVar(c.Namespace), opmon.EndpointEnvVar(), opmon.SecretEnvVar(), opmon.AdminSecretEnvVar(), k8sutil.ConfigDirEnvVar(dataDir), k8sutil.ConfigOverrideEnvVar(), {Name: "ROOK_FSID", ValueFrom: &v1.EnvVarSource{ SecretKeyRef: &v1.SecretKeySelector{ LocalObjectReference: v1.LocalObjectReference{Name: "rook-ceph-mon"}, Key: "fsid", }, }}, } if storeConfig.StoreType != "" { envVars = append(envVars, v1.EnvVar{Name: osdStoreEnvVarName, Value: storeConfig.StoreType}) } if storeConfig.DatabaseSizeMB != 0 { envVars = append(envVars, v1.EnvVar{Name: osdDatabaseSizeEnvVarName, Value: strconv.Itoa(storeConfig.DatabaseSizeMB)}) } if storeConfig.WalSizeMB != 0 { envVars = append(envVars, v1.EnvVar{Name: osdWalSizeEnvVarName, Value: strconv.Itoa(storeConfig.WalSizeMB)}) } if storeConfig.JournalSizeMB != 0 { envVars = append(envVars, v1.EnvVar{Name: osdJournalSizeEnvVarName, Value: strconv.Itoa(storeConfig.JournalSizeMB)}) } if storeConfig.OSDsPerDevice != 0 { envVars = append(envVars, v1.EnvVar{Name: osdsPerDeviceEnvVarName, Value: strconv.Itoa(storeConfig.OSDsPerDevice)}) } if storeConfig.EncryptedDevice { envVars = append(envVars, v1.EnvVar{Name: encryptedDeviceEnvVarName, Value: "true"}) } if location != "" { envVars = append(envVars, rookalpha.LocationEnvVar(location)) } return envVars } func (c *Cluster) provisionOSDContainer(devices []rookalpha.Device, selection rookalpha.Selection, resources v1.ResourceRequirements, storeConfig config.StoreConfig, metadataDevice, nodeName, location string, copyBinariesMount v1.VolumeMount) v1.Container { envVars := c.getConfigEnvVars(storeConfig, k8sutil.DataDir, nodeName, location) devMountNeeded := false privileged := false // only 1 of device list, device filter and use all devices can be specified. We prioritize in that order. if len(devices) > 0 { deviceNames := make([]string, len(devices)) for i, device := range devices { countSuffix := "" if count, ok := device.Config[config.OSDsPerDeviceKey]; ok { logger.Infof("%s osds requested on device %s (node %s)", count, device.Name, nodeName) countSuffix = ":" + count } deviceNames[i] = device.Name + countSuffix } envVars = append(envVars, dataDevicesEnvVar(strings.Join(deviceNames, ","))) devMountNeeded = true } else if selection.DeviceFilter != "" { envVars = append(envVars, deviceFilterEnvVar(selection.DeviceFilter)) devMountNeeded = true } else if selection.GetUseAllDevices() { envVars = append(envVars, deviceFilterEnvVar("all")) devMountNeeded = true } if metadataDevice != "" { envVars = append(envVars, metadataDeviceEnvVar(metadataDevice)) devMountNeeded = true } volumeMounts := append(opspec.CephVolumeMounts(), copyBinariesMount) if devMountNeeded { devMount := v1.VolumeMount{Name: "devices", MountPath: "/dev"} volumeMounts = append(volumeMounts, devMount) udevMount := v1.VolumeMount{Name: "udev", MountPath: "/run/udev"} volumeMounts = append(volumeMounts, udevMount) } if len(selection.Directories) > 0 { // for each directory the user has specified, create a volume mount and pass it to the pod via cmd line arg dirPaths := make([]string, len(selection.Directories)) for i := range selection.Directories { dpath := selection.Directories[i].Path dirPaths[i] = dpath if c.skipVolumeForDirectory(dpath) { // the dataDirHostPath has already been added as a volume mount continue } volumeMounts = append(volumeMounts, v1.VolumeMount{Name: k8sutil.PathToVolumeName(dpath), MountPath: dpath}) } if !IsRemovingNode(selection.DeviceFilter) { envVars = append(envVars, dataDirectoriesEnvVar(strings.Join(dirPaths, ","))) } } // elevate to be privileged if it is going to mount devices or if running in a restricted environment such as openshift if devMountNeeded || os.Getenv("ROOK_HOSTPATH_REQUIRES_PRIVILEGED") == "true" { privileged = true } runAsUser := int64(0) runAsNonRoot := false readOnlyRootFilesystem := false return v1.Container{ Command: []string{path.Join(rookBinariesMountPath, "tini")}, Args: []string{"--", path.Join(rookBinariesMountPath, "rook"), "ceph", "osd", "provision"}, Name: "provision", Image: c.cephVersion.Image, VolumeMounts: volumeMounts, Env: envVars, SecurityContext: &v1.SecurityContext{ Privileged: &privileged, RunAsUser: &runAsUser, RunAsNonRoot: &runAsNonRoot, ReadOnlyRootFilesystem: &readOnlyRootFilesystem, }, Resources: resources, } } func (c *Cluster) skipVolumeForDirectory(path string) bool { // If attempting to add both a directory at /var/lib/rook, we need to skip the volume and volume mount // since the dataDirHostPath is always mounting at /var/lib/rook return path == k8sutil.DataDir } func nodeNameEnvVar(name string) v1.EnvVar { return v1.EnvVar{Name: "ROOK_NODE_NAME", Value: name} } func dataDevicesEnvVar(dataDevices string) v1.EnvVar { return v1.EnvVar{Name: "ROOK_DATA_DEVICES", Value: dataDevices} } func deviceFilterEnvVar(filter string) v1.EnvVar { return v1.EnvVar{Name: "ROOK_DATA_DEVICE_FILTER", Value: filter} } func metadataDeviceEnvVar(metadataDevice string) v1.EnvVar { return v1.EnvVar{Name: osdMetadataDeviceEnvVarName, Value: metadataDevice} } func dataDirectoriesEnvVar(dataDirectories string) v1.EnvVar { return v1.EnvVar{Name: dataDirsEnvVarName, Value: dataDirectories} } func getDirectoriesFromContainer(osdContainer v1.Container) []rookalpha.Directory { var dirsArg string for _, envVar := range osdContainer.Env { if envVar.Name == dataDirsEnvVarName { dirsArg = envVar.Value } } var dirsList []string if dirsArg != "" { dirsList = strings.Split(dirsArg, ",") } dirs := make([]rookalpha.Directory, len(dirsList)) for dirNum, dir := range dirsList { dirs[dirNum] = rookalpha.Directory{Path: dir} } return dirs } func getConfigFromContainer(osdContainer v1.Container) map[string]string { cfg := map[string]string{} for _, envVar := range osdContainer.Env { switch envVar.Name { case osdStoreEnvVarName: cfg[config.StoreTypeKey] = envVar.Value case osdDatabaseSizeEnvVarName: cfg[config.DatabaseSizeMBKey] = envVar.Value case osdWalSizeEnvVarName: cfg[config.WalSizeMBKey] = envVar.Value case osdJournalSizeEnvVarName: cfg[config.JournalSizeMBKey] = envVar.Value case osdMetadataDeviceEnvVarName: cfg[config.MetadataDeviceKey] = envVar.Value } } return cfg }