my-rook-config/pkg/operator/ceph/cluster/cluster.go

/*
Copyright 2018 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 cluster to manage a Ceph cluster.
package cluster

import (
	"context"
	"fmt"
	"math"
	"os"
	"os/exec"
	"path"
	"strconv"
	"sync"
	"syscall"

	"github.com/pkg/errors"

	cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
	"github.com/rook/rook/pkg/clusterd"
	"github.com/rook/rook/pkg/daemon/ceph/client"
	"github.com/rook/rook/pkg/daemon/ceph/osd/kms"
	"github.com/rook/rook/pkg/operator/ceph/cluster/mgr"
	"github.com/rook/rook/pkg/operator/ceph/cluster/mon"
	"github.com/rook/rook/pkg/operator/ceph/cluster/nodedaemon"
	"github.com/rook/rook/pkg/operator/ceph/cluster/osd"
	"github.com/rook/rook/pkg/operator/ceph/cluster/telemetry"
	"github.com/rook/rook/pkg/operator/ceph/config"
	"github.com/rook/rook/pkg/operator/ceph/config/keyring"
	"github.com/rook/rook/pkg/operator/ceph/controller"
	"github.com/rook/rook/pkg/operator/ceph/csi"
	"github.com/rook/rook/pkg/operator/ceph/reporting"
	cephver "github.com/rook/rook/pkg/operator/ceph/version"
	"github.com/rook/rook/pkg/operator/k8sutil"
	"github.com/rook/rook/pkg/util/log"
	rookversion "github.com/rook/rook/pkg/version"
	v1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/types"
	"k8s.io/client-go/util/retry"
)

const (
	detectVersionName             = "rook-ceph-detect-version"
	deleteUnusedCrushRulesSetting = "ROOK_DELETE_UNUSED_CRUSH_RULES"
)

var telemetryMutex sync.Mutex

type cluster struct {
	ClusterInfo        *client.ClusterInfo
	context            *clusterd.Context
	Namespace          string
	Spec               *cephv1.ClusterSpec
	clusterMetadata    metav1.ObjectMeta
	namespacedName     types.NamespacedName
	mons               *mon.Cluster
	ownerInfo          *k8sutil.OwnerInfo
	isUpgrade          bool
	monitoringRoutines sync.Map
	observedGeneration int64
}

func newCluster(ctx context.Context, c *cephv1.CephCluster, context *clusterd.Context, ownerInfo *k8sutil.OwnerInfo, rookImage string) *cluster {
	return &cluster{
		// at this phase of the cluster creation process, the identity components of the cluster are
		// not yet established. we reserve this struct which is filled in as soon as the cluster's
		// identity can be established.
		ClusterInfo:     client.AdminClusterInfo(ctx, c.Namespace, c.Name),
		Namespace:       c.Namespace,
		Spec:            &c.Spec,
		clusterMetadata: c.ObjectMeta,
		context:         context,
		namespacedName:  types.NamespacedName{Namespace: c.Namespace, Name: c.Name},
		ownerInfo:       ownerInfo,
		mons:            mon.New(ctx, context, c.Namespace, c.Spec, ownerInfo),
		// update observedGeneration with current generation value,
		// because generation can be changed before reconcile got completed
		// CR status will be updated at end of reconcile, so to reflect the reconcile has finished
		observedGeneration: c.ObjectMeta.Generation,
	}
}

func (c *cluster) reconcileCephDaemons(rookImage string, cephVersion cephver.CephVersion) error {
	// Create a configmap for overriding ceph config settings
	// These settings should only be modified by a user after they are initialized
	err := populateConfigOverrideConfigMap(c.context, c.Namespace, c.ownerInfo, c.clusterMetadata)
	if err != nil {
		return errors.Wrap(err, "failed to populate config override config map")
	}
	c.ClusterInfo.SetName(c.namespacedName.Name)

	// Execute actions before the monitors are up and running, if needed during upgrades.
	// These actions would be skipped in a new cluster.
	log.NamespacedDebug(c.Namespace, logger, "monitors are about to reconcile, executing pre actions")
	err = c.preMonStartupActions(cephVersion)
	if err != nil {
		return errors.Wrap(err, "failed to execute actions before reconciling the ceph monitors")
	}

	// Start the mon pods
	controller.UpdateCondition(c.ClusterInfo.Context, c.context, c.namespacedName, k8sutil.ObservedGenerationNotAvailable, cephv1.ConditionProgressing, v1.ConditionTrue, cephv1.ClusterProgressingReason, "Configuring Ceph Mons")
	clusterInfo, err := c.mons.Start(c.ClusterInfo, rookImage, cephVersion, *c.Spec)
	if err != nil {
		return errors.Wrap(err, "failed to start ceph monitors")
	}
	clusterInfo.OwnerInfo = c.ownerInfo
	clusterInfo.SetName(c.namespacedName.Name)
	clusterInfo.Context = c.ClusterInfo.Context
	c.ClusterInfo = clusterInfo
	c.ClusterInfo.NetworkSpec = c.Spec.Network

	// The cluster Identity must be established at this point
	if err := c.ClusterInfo.IsInitialized(); err != nil {
		return errors.Wrap(err, "the cluster identity was not established")
	}

	if c.ClusterInfo.Context.Err() != nil {
		return c.ClusterInfo.Context.Err()
	}

	// Execute actions after the monitors are up and running
	log.NamespacedDebug(c.Namespace, logger, "monitors are up and running, executing post actions")
	err = c.postMonStartupActions()
	if err != nil {
		return errors.Wrap(err, "failed to execute post actions after all the ceph monitors started")
	}

	// Start Ceph manager
	controller.UpdateCondition(c.ClusterInfo.Context, c.context, c.namespacedName, k8sutil.ObservedGenerationNotAvailable, cephv1.ConditionProgressing, v1.ConditionTrue, cephv1.ClusterProgressingReason, "Configuring Ceph Mgr(s)")
	mgrs := mgr.New(c.context, c.ClusterInfo, *c.Spec, rookImage)
	err = mgrs.Start()
	if err != nil {
		return errors.Wrap(err, "failed to start ceph mgr")
	}

	// Execute actions after the managers are up and running
	log.NamespacedDebug(c.Namespace, logger, "managers are up and running, executing post actions")
	err = c.postMgrStartupActions()
	if err != nil {
		return errors.Wrap(err, "failed to execute post actions after all the ceph managers started")
	}

	// Start the OSDs
	controller.UpdateCondition(c.ClusterInfo.Context, c.context, c.namespacedName, k8sutil.ObservedGenerationNotAvailable, cephv1.ConditionProgressing, v1.ConditionTrue, cephv1.ClusterProgressingReason, "Configuring Ceph OSDs")
	osds := osd.New(c.context, c.ClusterInfo, *c.Spec, rookImage)
	err = osds.Start()
	if err != nil {
		return errors.Wrap(err, "failed to start ceph osds")
	}

	// If a stretch cluster, enable the arbiter after the OSDs are created with the CRUSH map
	if c.Spec.IsStretchCluster() {
		if err := c.mons.ConfigureArbiter(); err != nil {
			return errors.Wrap(err, "failed to configure stretch arbiter")
		}
	}

	log.NamespacedInfo(c.Namespace, logger, "done reconciling ceph cluster")

	// We should be done updating by now
	if c.isUpgrade {
		c.printOverallCephVersion()

		// reset the isUpgrade flag
		c.isUpgrade = false
	}

	return nil
}

func (c *ClusterController) initializeCluster(cluster *cluster) error {
	// Check if the dataDirHostPath is located in the disallowed paths list
	cleanDataDirHostPath := path.Clean(cluster.Spec.DataDirHostPath)
	for _, b := range disallowedHostDirectories {
		if cleanDataDirHostPath == b {
			log.NamespacedError(cluster.Namespace, logger, "dataDirHostPath (given: %q) must not be used, conflicts with %q internal path", cluster.Spec.DataDirHostPath, b)
			return nil
		}
	}

	// Depending on the cluster type choose the correct orchestration
	if cluster.Spec.External.Enable {
		err := c.configureExternalCephCluster(cluster)
		if err != nil {
			controller.UpdateCondition(c.OpManagerCtx, c.context, cluster.namespacedName, k8sutil.ObservedGenerationNotAvailable, cephv1.ConditionProgressing, v1.ConditionFalse, cephv1.ClusterProgressingReason, err.Error())
			return errors.Wrap(err, "failed to configure external ceph cluster")
		}
	} else {
		clusterInfo, _, _, err := controller.LoadClusterInfo(c.context, c.OpManagerCtx, cluster.Namespace, cluster.Spec)
		if err != nil {
			if errors.Is(err, controller.ClusterInfoNoClusterNoSecret) {
				log.NamespacedInfo(cluster.Namespace, logger, "clusterInfo not yet found, must be a new cluster.")
				// ClusterInfoNoClusterNoSecret should return nil clusterInfo, but this is a
				// mandatory condition for recoverPriorAdminCephxKeyRotation() below, so ensure it
				clusterInfo = nil
			} else {
				return errors.Wrap(err, "failed to load cluster info")
			}
		} else {
			clusterInfo.OwnerInfo = cluster.ownerInfo
			clusterInfo.SetName(cluster.namespacedName.Name)
			cluster.ClusterInfo = clusterInfo
			if cluster.mons.ClusterInfo == nil {
				// ClusterInfo stored in cluster.mons can be lost from the object stored in the
				// clusterMap during admin key rotation corner cases. rehydrate it if needed
				log.NamespacedDebug(cluster.Namespace, logger, "applying missing ClusterInfo to tracked mons info")
				cluster.mons.ClusterInfo = clusterInfo
			}
		}

		// if necessary, recover from failed/interrupted admin key rotation
		// this must be done before any ceph cli commands are run
		err = recoverPriorAdminCephxKeyRotation(c.context, clusterInfo, cluster.ownerInfo, cluster.Namespace)
		if err != nil {
			return errors.Wrap(err, "failed to recover from prior admin cephx key rotation")
		}

		// If the local cluster has already been configured, immediately start monitoring the cluster.
		// Test if the cluster has already been configured if the mgr deployment has been created.
		// If the mgr does not exist, the mons have never been verified to be in quorum.
		opts := metav1.ListOptions{LabelSelector: fmt.Sprintf("%s=%s", k8sutil.AppAttr, mgr.AppName)}
		mgrDeployments, err := c.context.Clientset.AppsV1().Deployments(cluster.Namespace).List(c.OpManagerCtx, opts)
		if err == nil && len(mgrDeployments.Items) > 0 && cluster.ClusterInfo != nil {
			c.configureCephMonitoring(cluster, clusterInfo)
		}

		err = c.configureLocalCephCluster(cluster)
		if err != nil {
			controller.UpdateCondition(c.OpManagerCtx, c.context, cluster.namespacedName, k8sutil.ObservedGenerationNotAvailable, cephv1.ConditionProgressing, v1.ConditionFalse, cephv1.ClusterProgressingReason, err.Error())
			return errors.Wrap(err, "failed to configure local ceph cluster")
		}

		// Asynchronously report the telemetry to allow another reconcile to proceed if needed
		go cluster.reportTelemetry()
	}

	err := csi.SaveCSIDriverOptions(c.context.Clientset, cluster.Namespace, cluster.ClusterInfo)
	if err != nil {
		return errors.Wrap(err, "failed to save CSI driver options")
	}

	// Populate ClusterInfo with the last value
	cluster.mons.ClusterInfo = cluster.ClusterInfo
	cluster.mons.ClusterInfo.SetName(cluster.namespacedName.Name)

	// Start the monitoring if not already started
	c.configureCephMonitoring(cluster, cluster.ClusterInfo)

	return nil
}

func (c *ClusterController) configureLocalCephCluster(cluster *cluster) error {
	cluster.ClusterInfo.Context = c.OpManagerCtx
	// Cluster Spec validation
	err := preClusterStartValidation(cluster)
	if err != nil {
		return errors.Wrap(err, "failed to perform validation before cluster creation")
	}

	// Run image validation job
	controller.UpdateCondition(c.OpManagerCtx, c.context, cluster.namespacedName, k8sutil.ObservedGenerationNotAvailable, cephv1.ConditionProgressing, v1.ConditionTrue, cephv1.ClusterProgressingReason, "Detecting Ceph version")
	cephVersion, isUpgrade, err := c.detectAndValidateCephVersion(cluster)
	if err != nil {
		return errors.Wrap(err, "failed the ceph version check")
	}
	// Set the value of isUpgrade based on the image discovery done by detectAndValidateCephVersion()
	cluster.isUpgrade = isUpgrade

	if cluster.Spec.Network.MultiClusterService.Enabled {
		serviceExportVersion := cephver.CephVersion{Major: 17, Minor: 2, Extra: 6}
		if !cephVersion.IsAtLeast(serviceExportVersion) {
			return errors.Errorf("minimum ceph version to support multi cluster service is %q, but is running %s", serviceExportVersion.String(), cephVersion.String())
		}
	}

	controller.UpdateCondition(c.OpManagerCtx, c.context, cluster.namespacedName, k8sutil.ObservedGenerationNotAvailable, cephv1.ConditionProgressing, v1.ConditionTrue, cephv1.ClusterProgressingReason, "Configuring the Ceph cluster")
	// Run the orchestration
	err = cluster.reconcileCephDaemons(c.rookImage, *cephVersion)
	if err != nil {
		return errors.Wrap(err, "failed to create cluster")
	}

	// Set the condition to the cluster object
	controller.UpdateCondition(c.OpManagerCtx, c.context, cluster.namespacedName, cluster.observedGeneration, cephv1.ConditionReady, v1.ConditionTrue, cephv1.ClusterCreatedReason, "Cluster created successfully")
	return nil
}

// Validate the cluster Specs
func preClusterStartValidation(cluster *cluster) error {
	if cluster.Spec.Mon.Count == 0 {
		log.NamespacedWarning(cluster.Namespace, logger, "mon count should be at least 1, will use default value of %d", mon.DefaultMonCount)
		cluster.Spec.Mon.Count = mon.DefaultMonCount
	}
	if !cluster.Spec.Mon.AllowMultiplePerNode {
		// Check that there are enough nodes to have a chance of starting the requested number of mons
		monCountToSchedule := cluster.Spec.Mon.Count
		if cluster.Spec.Mon.FloatingMon.Name != "" {
			monCountToSchedule--
		}
		nodes, err := cluster.context.Clientset.CoreV1().Nodes().List(cluster.ClusterInfo.Context, metav1.ListOptions{})
		if err == nil && len(nodes.Items) < monCountToSchedule {
			return errors.Errorf("cannot start %d mons on %d node(s) when allowMultiplePerNode is false", cluster.Spec.Mon.Count, len(nodes.Items))
		}
	}
	if err := validateStretchCluster(cluster); err != nil {
		return err
	}

	if err := cephv1.ValidateNetworkSpec(cluster.Namespace, cluster.Spec.Network); err != nil {
		return errors.Wrapf(err, "failed to validate network spec for cluster in namespace %q", cluster.Namespace)
	}

	// Validate on-PVC cluster encryption KMS settings
	if cluster.Spec.Storage.IsOnPVCEncrypted() && cluster.Spec.Security.KeyManagementService.IsEnabled() {
		// Validate the KMS details
		err := kms.ValidateConnectionDetails(cluster.ClusterInfo.Context, cluster.context, &cluster.Spec.Security.KeyManagementService, cluster.Namespace)
		if err != nil {
			return errors.Wrap(err, "failed to validate kms connection details")
		}
	}

	log.NamespacedDebug(cluster.Namespace, logger, "cluster spec successfully validated")
	return nil
}

func validateStretchCluster(cluster *cluster) error {
	if !cluster.Spec.IsStretchCluster() {
		return nil
	}
	if len(cluster.Spec.Mon.StretchCluster.Zones) != 3 {
		return errors.Errorf("expecting exactly three zones for the stretch cluster, but found %d", len(cluster.Spec.Mon.StretchCluster.Zones))
	}
	if cluster.Spec.Mon.Count != 3 && cluster.Spec.Mon.Count != 5 {
		return errors.Errorf("invalid number of mons %d for a stretch cluster, expecting 5 (recommended) or 3 (minimal)", cluster.Spec.Mon.Count)
	}
	arbitersFound := 0
	for _, zone := range cluster.Spec.Mon.StretchCluster.Zones {
		if zone.Arbiter {
			arbitersFound++
		}
		if zone.Name == "" {
			return errors.New("missing zone name for the stretch cluster")
		}
	}
	if arbitersFound != 1 {
		return errors.Errorf("expecting to find exactly one arbiter zone, but found %d", arbitersFound)
	}
	return nil
}

func extractExitCode(err error) (int, bool) {
	exitErr, ok := err.(*exec.ExitError)
	if ok {
		return exitErr.ExitCode(), true
	}
	return 0, false
}

func (c *cluster) createCrushRoot(newRoot string) error {
	args := []string{"osd", "crush", "add-bucket", newRoot, "root"}
	cephCmd := client.NewCephCommand(c.context, c.ClusterInfo, args)
	_, err := cephCmd.Run()
	if err != nil {
		// returns zero if the bucket exists already, so any error is fatal
		return errors.Wrap(err, "failed to create CRUSH root")
	}

	return nil
}

func (c *cluster) replaceDefaultReplicationRule(newRoot string) error {
	args := []string{"osd", "crush", "rule", "rm", "replicated_rule"}
	cephCmd := client.NewCephCommand(c.context, c.ClusterInfo, args)
	_, err := cephCmd.Run()
	if err != nil {
		if code, ok := extractExitCode(err); ok && code == int(syscall.EBUSY) {
			// we do not want to delete the replicated_rule if it’s in use,
			// and we also do not care much. There are two possible causes:
			// - the user has created this rule with the non-default CRUSH
			//   root manually
			// - the user is using this rule despite the rule using the default
			//   CRUSH root
			// in both cases, we cannot do anything about it either way and
			// we’ll assume that the user knows what they’re doing.
			log.NamespacedWarning(c.Namespace, logger, "replicated_rule is in use, not replaced")
			return nil
		}
		// the error does not refer to EBUSY -> return as error
		return errors.Wrap(err, "failed to remove default replicated_rule")
	}

	args = []string{
		"osd", "crush", "rule", "create-replicated",
		"replicated_rule", newRoot, "host",
	}
	cephCmd = client.NewCephCommand(c.context, c.ClusterInfo, args)
	_, err = cephCmd.Run()
	if err != nil {
		// returns zero if the rule exists already, so any error is fatal
		return errors.Wrap(err, "failed to create new default replicated_rule")
	}

	return nil
}

func (c *cluster) removeDefaultCrushRoot() error {
	args := []string{"osd", "crush", "rm", "default"}
	cephCmd := client.NewCephCommand(c.context, c.ClusterInfo, args)
	_, err := cephCmd.Run()
	if err != nil {
		if code, ok := extractExitCode(err); ok {
			if code == int(syscall.ENOTEMPTY) || code == int(syscall.EBUSY) {
				// we do not want to delete the default node if it’s in use,
				// and we also do not care much. There are two more causes here:
				// - a (non-root?) CRUSH node with the default label was created
				//   automatically, e.g. from topology labels, and OSDs (or sub
				//   nodes) have been placed in there. In this case, the node
				//   obviously needs to be preserved.
				// - the root=default CRUSH node is in use by a non-default
				//   CRUSH rule
				// - OSDs or subnodes have been placed under the root=default
				//   CRUSH node
				//
				// in all cases, we cannot do anything about it either way and
				// we’ll assume that the user knows what they’re doing.
				log.NamespacedDebug(c.Namespace, logger, "default is not empty or is still in use, not removed")
				return nil
			}
		}
		// the error does not refer to EBUSY or ENOTEMPTY -> return as error
		return errors.Wrap(err, "failed to remove CRUSH node 'default'")
	}
	return nil
}

// Remove the default root=default and replicated_rule CRUSH objects which are created by Ceph on initial startup.
// Those objects may interfere with the normal operation of the cluster.
// Note that errors which indicate that the objects are in use are ignored and the objects will continue to exist in that case.
func (c *cluster) replaceDefaultCrushMap(newRoot string) (err error) {
	log.NamespacedInfo(c.Namespace, logger, "creating new CRUSH root if it does not exist")
	err = c.createCrushRoot(newRoot)
	if err != nil {
		return errors.Wrap(err, "failed to create CRUSH root")
	}

	log.NamespacedInfo(c.Namespace, logger, "replacing default replicated_rule CRUSH rule for use of non-default CRUSH root")
	err = c.replaceDefaultReplicationRule(newRoot)
	if err != nil {
		return errors.Wrap(err, "failed to replace default rule")
	}

	log.NamespacedInfo(c.Namespace, logger, "replacing default CRUSH node if applicable")
	err = c.removeDefaultCrushRoot()
	if err != nil {
		return errors.Wrap(err, "failed to remove default CRUSH root")
	}

	return nil
}

// preMonStartupActions is a collection of actions to run before the monitors are reconciled.
func (c *cluster) preMonStartupActions(cephVersion cephver.CephVersion) error {
	err := initClusterCephxStatus(c)
	if err != nil {
		return errors.Wrap(err, "failed to initialized cluster cephx status")
	}

	return nil
}

// postMonStartupActions is a collection of actions to run once the monitors are up and running
// It gets executed right after the main mon Start() method
// Basically, it is executed between the monitors and the manager sequence
func (c *cluster) postMonStartupActions() error {
	// full cluster spec/status will be used to inform various cephx rotations
	clusterObj := &cephv1.CephCluster{}
	if err := c.context.Client.Get(c.ClusterInfo.Context, c.ClusterInfo.NamespacedName(), clusterObj); err != nil {
		return errors.Wrapf(err, "failed to get cluster %v.", c.ClusterInfo.NamespacedName())
	}

	// rotate admin key first thing after mons are updated
	err := rotateAdminCephxKey(c.context, c.ClusterInfo, c.ownerInfo, clusterObj) // TODO: rename?
	if err != nil {
		return errors.Wrapf(err, "failed to rotate admin cephx key")
	}

	// rotate mon cephx keys if required
	didRotateMonCephxKeys, err := c.mons.RotateMonCephxKeys(clusterObj)
	if err != nil {
		return errors.Wrapf(err, "failed to rotate mon cephx keys in the namespace %q", c.ClusterInfo.Namespace)
	}
	err = c.mons.UpdateMonCephxStatus(didRotateMonCephxKeys)
	if err != nil {
		return errors.Wrapf(err, "failed to update cephx status for mon daemons in the namespace %q", c.ClusterInfo.Namespace)
	}

	// reconcile to restart the mons after cephx key rotation
	if didRotateMonCephxKeys {
		// reconcile the rook operator so that it will restart the mons after mon cephx key rotation
		return errors.New("triggering a new reconcile to restart the mon daemons after mon cephx key rotation")
	}

	// Create CSI Kubernetes Secrets
	if err := csi.CreateCSISecrets(c.context, c.ClusterInfo, c.namespacedName); err != nil {
		return errors.Wrap(err, "failed to create csi kubernetes secrets")
	}

	// Create crash collector Kubernetes Secret
	if err := nodedaemon.CreateCrashCollectorSecret(c.context, c.ClusterInfo); err != nil {
		return errors.Wrap(err, "failed to create crash collector kubernetes secret")
	}

	// Create exporter Kubernetes Secret
	if err := nodedaemon.CreateExporterSecret(c.context, c.ClusterInfo); err != nil {
		return errors.Wrap(err, "failed to create exporter kubernetes secret")
	}

	if err := c.configureMsgr2(); err != nil {
		return errors.Wrap(err, "failed to configure msgr2")
	}

	if err := c.configureStorageSettings(); err != nil {
		return errors.Wrap(err, "failed to configure storage settings")
	}

	// Mute the MON_NETSPLIT health warning in stretch clusters since ceph raises it incorrectly.
	// This can be removed once ceph fixes the health warning: https://tracker.ceph.com/issues/71344
	if c.Spec.IsStretchCluster() {
		logger.Debugf("stretch cluster detected, muting MON_NETSPLIT health warning")
		client.MuteHealthWarning(c.context, c.ClusterInfo, "MON_NETSPLIT")
	}

	crushRoot := client.GetCrushRootFromSpec(c.Spec)
	if crushRoot != "default" {
		// Remove the root=default and replicated_rule which are created by
		// default. Note that RemoveDefaultCrushMap ignores some types of errors
		// internally
		if err := c.replaceDefaultCrushMap(crushRoot); err != nil {
			return errors.Wrap(err, "failed to remove default CRUSH map")
		}
	}

	// Create cluster-wide RBD bootstrap peer token
	if _, err := controller.CreateBootstrapPeerSecret(c.context, c.ClusterInfo, &cephv1.CephCluster{ObjectMeta: metav1.ObjectMeta{Name: c.namespacedName.Name, Namespace: c.Namespace}}, c.ownerInfo); err != nil {
		return errors.Wrap(err, "failed to create cluster rbd bootstrap peer token")
	}

	// Delete the client.bootstrap-* keys. These keys are created automatically by Ceph and are unused.
	// Ceph might remove these keys in the future. It is safe for Rook to remove them if they exist.
	// client.bootstrap-osd is used by Rook and is not removed here.
	c.deleteBootstrapKeys()

	return nil
}

func (c *cluster) postMgrStartupActions() error {
	if err := c.updateConfigStoreFromCRD(); err != nil {
		return errors.Wrap(err, "failed to set config store options")
	}
	if !cleanupUnusedCrushRulesEnabled(c.Namespace) {
		log.NamespacedInfo(c.Namespace, logger, "skipping cleanup of unused crush rules because %s is disabled", deleteUnusedCrushRulesSetting)
		return nil
	}
	if err := client.CleanupUnusedCrushRules(c.context, c.ClusterInfo); err != nil {
		log.NamespacedError(c.Namespace, logger, "failed to clean up unused crush rules. %v", err)
	}
	return nil
}

func cleanupUnusedCrushRulesEnabled(namespace string) bool {
	setting := k8sutil.GetOperatorSetting(deleteUnusedCrushRulesSetting, "true")
	enabled, err := strconv.ParseBool(setting)
	if err != nil {
		log.NamespacedWarning(namespace, logger, "invalid value %q for %s, defaulting to true. %v", setting, deleteUnusedCrushRulesSetting, err)
		return true
	}

	return enabled
}

func (c *cluster) configureStorageSettings() error {
	if !c.shouldSetClusterFullSettings() {
		return nil
	}
	osdDump, err := client.GetOSDDump(c.context, c.ClusterInfo)
	if err != nil {
		return errors.Wrap(err, "failed to get osd dump for setting cluster full settings")
	}

	if err := c.setClusterFullRatio("set-full-ratio", c.Spec.Storage.FullRatio, osdDump.FullRatio); err != nil {
		return err
	}

	if err := c.setClusterFullRatio("set-backfillfull-ratio", c.Spec.Storage.BackfillFullRatio, osdDump.BackfillFullRatio); err != nil {
		return err
	}

	if err := c.setClusterFullRatio("set-nearfull-ratio", c.Spec.Storage.NearFullRatio, osdDump.NearFullRatio); err != nil {
		return err
	}

	return nil
}

func (c *cluster) setClusterFullRatio(ratioCommand string, desiredRatio *float64, actualRatio float64) error {
	if !shouldUpdateFloatSetting(desiredRatio, actualRatio) {
		if desiredRatio != nil {
			log.NamespacedInfo(c.Namespace, logger, "desired value %s=%.2f is already set", ratioCommand, *desiredRatio)
		}
		return nil
	}
	desiredStringVal := fmt.Sprintf("%.2f", *desiredRatio)
	log.NamespacedInfo(c.Namespace, logger, "updating %s from %.2f to %s", ratioCommand, actualRatio, desiredStringVal)
	args := []string{"osd", ratioCommand, desiredStringVal}
	cephCmd := client.NewCephCommand(c.context, c.ClusterInfo, args)
	output, err := cephCmd.Run()
	if err != nil {
		return errors.Wrapf(err, "failed to update %s to %q. %s", ratioCommand, desiredStringVal, output)
	}
	return nil
}

func shouldUpdateFloatSetting(desired *float64, actual float64) bool {
	if desired == nil {
		return false
	}
	if *desired == actual {
		return false
	}
	if actual != 0 && math.Abs(*desired-actual)/actual > 0.01 {
		return true
	}
	return false
}

func (c *cluster) shouldSetClusterFullSettings() bool {
	return c.Spec.Storage.FullRatio != nil || c.Spec.Storage.BackfillFullRatio != nil || c.Spec.Storage.NearFullRatio != nil
}

func (c *cluster) updateConfigStoreFromCRD() error {
	monStore := config.GetMonStore(c.context, c.ClusterInfo)
	cephConfigFromSecret, err := c.fetchCephConfigFromSecrets()
	if err != nil {
		return err
	}
	if err := monStore.SetAllMultiple(cephConfigFromSecret); err != nil {
		return err
	}
	if err := monStore.SetAllMultiple(c.Spec.CephConfig); err != nil {
		return err
	}
	return nil
}

func (c *cluster) reportTelemetry() {
	// In the corner case that reconciles are started in quick succession and the telemetry
	// hasn't had a chance to complete yet from a previous reconcile, simply allow
	// a single goroutine to report telemetry at a time.
	telemetryMutex.Lock()
	defer telemetryMutex.Unlock()

	reportClusterTelemetry(c)
	reportNodeTelemetry(c)
}

func reportClusterTelemetry(c *cluster) {
	log.NamespacedInfo(c.Namespace, logger, "reporting cluster telemetry")

	// Identify this as a rook cluster for Ceph telemetry by setting the Rook version.
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.RookVersionKey, rookversion.Version)

	// Report the K8s version
	serverVersion, err := c.context.Clientset.Discovery().ServerVersion()
	if err != nil {
		log.NamespacedWarning(c.Namespace, logger, "failed to report the K8s server version. %v", err)
	} else {
		telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.K8sVersionKey, serverVersion.String())
	}

	// Report the CSI version if it has been detected
	if telemetry.CSIVersion != "" {
		telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.CSIVersionKey, telemetry.CSIVersion)
	}

	// Report the max mon id
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.MonMaxIDKey, strconv.Itoa(c.mons.MaxMonID()))

	// Report the telemetry for mon settings
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.MonCountKey, strconv.Itoa(c.Spec.Mon.Count))
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.MonAllowMultiplePerNodeKey, strconv.FormatBool(c.Spec.Mon.AllowMultiplePerNode))
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.MonPVCEnabledKey, strconv.FormatBool(c.Spec.Mon.VolumeClaimTemplate != nil))
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.MonStretchEnabledKey, strconv.FormatBool(c.Spec.IsStretchCluster()))

	// Set the telemetry for device sets
	deviceSets := 0
	portableDeviceSets := 0
	nonportableDeviceSets := 0
	for _, deviceSet := range c.Spec.Storage.StorageClassDeviceSets {
		deviceSets++
		if deviceSet.Portable {
			portableDeviceSets++
		} else {
			nonportableDeviceSets++
		}
	}
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.DeviceSetTotalKey, strconv.Itoa(deviceSets))
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.DeviceSetPortableKey, strconv.Itoa(portableDeviceSets))
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.DeviceSetNonPortableKey, strconv.Itoa(nonportableDeviceSets))

	// Set the telemetry for network settings
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.NetworkProviderKey, string(c.Spec.Network.Provider))

	// Set the telemetry for external cluster settings
	telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.ExternalModeEnabledKey, strconv.FormatBool(c.Spec.External.Enable))
}

func reportNodeTelemetry(c *cluster) {
	log.NamespacedInfo(c.Namespace, logger, "reporting node telemetry")
	operatorNamespace := os.Getenv(k8sutil.PodNamespaceEnvVar)

	// Report the K8sNodeCount
	nodelist, err := c.context.Clientset.CoreV1().Nodes().List(c.ClusterInfo.Context, metav1.ListOptions{})
	if err != nil {
		log.NamespacedWarning(c.Namespace, logger, "failed to report the K8s node count. %v", err)
	} else {
		telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.K8sNodeCount, strconv.Itoa(len(nodelist.Items)))
	}

	// Report the cephNodeCount
	if c.Spec.CrashCollector.Disable {
		telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.CephNodeCount, "-1")
	} else {
		listoption := metav1.ListOptions{LabelSelector: fmt.Sprintf("%s=%s", k8sutil.AppAttr, nodedaemon.CrashCollectorAppName)}
		cephNodeList, err := c.context.Clientset.CoreV1().Pods(c.Namespace).List(c.ClusterInfo.Context, listoption)
		if err != nil {
			log.NamespacedWarning(c.Namespace, logger, "failed to report the ceph node count. %v", err)
		} else {
			telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.CephNodeCount, strconv.Itoa(len(cephNodeList.Items)))
		}
	}
	// Report the csi rbd node count
	listoption := metav1.ListOptions{LabelSelector: fmt.Sprintf("%s=%s", k8sutil.AppAttr, csi.CsiRBDPlugin)}
	cephRbdNodelist, err := c.context.Clientset.CoreV1().Pods(operatorNamespace).List(c.ClusterInfo.Context, listoption)
	if err != nil {
		log.NamespacedWarning(c.Namespace, logger, "failed to report the ceph rbd node count. %v", err)
	} else {
		telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.RBDNodeCount, strconv.Itoa(len(cephRbdNodelist.Items)))
	}

	// Report the csi cephfs node count
	listoption = metav1.ListOptions{LabelSelector: fmt.Sprintf("%s=%s", k8sutil.AppAttr, csi.CsiCephFSPlugin)}
	cephFSNodelist, err := c.context.Clientset.CoreV1().Pods(operatorNamespace).List(c.ClusterInfo.Context, listoption)
	if err != nil {
		log.NamespacedWarning(c.Namespace, logger, "failed to report the ceph cephfs node count. %v", err)
	} else {
		telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.CephFSNodeCount, strconv.Itoa(len(cephFSNodelist.Items)))
	}

	// Report the csi nfs node count
	listoption = metav1.ListOptions{LabelSelector: fmt.Sprintf("%s=%s", k8sutil.AppAttr, csi.CsiNFSPlugin)}
	cephNFSNodelist, err := c.context.Clientset.CoreV1().Pods(operatorNamespace).List(c.ClusterInfo.Context, listoption)
	if err != nil {
		log.NamespacedWarning(c.Namespace, logger, "failed to report the ceph nfs node count. %v", err)
	} else {
		telemetry.ReportKeyValue(c.context, c.ClusterInfo, telemetry.NFSNodeCount, strconv.Itoa(len(cephNFSNodelist.Items)))
	}
}

func (c *cluster) configureMsgr2() error {
	encryptionSetting := "secure"
	rbdMapOptions := "rbd_default_map_options"
	encryptionGlobalConfigSettings := map[string]string{
		"ms_cluster_mode": encryptionSetting,
		"ms_service_mode": encryptionSetting,
		"ms_client_mode":  encryptionSetting,
		rbdMapOptions:     "ms_mode=secure",
	}
	monStore := config.GetMonStore(c.context, c.ClusterInfo)

	encryptionEnabled := c.Spec.NetworkEncryptionEnabled()

	if encryptionEnabled {
		log.NamespacedInfo(c.Namespace, logger, "setting msgr2 encryption mode to %q", encryptionSetting)
		if err := monStore.SetAll("global", encryptionGlobalConfigSettings); err != nil {
			return err
		}
	} else {
		encryptionConfig := []config.Option{}
		for k := range encryptionGlobalConfigSettings {
			encryptionConfig = append(encryptionConfig, config.Option{Who: "global", Option: k})
		}
		if err := monStore.DeleteAll(encryptionConfig...); err != nil {
			return errors.Wrap(err, "failed to delete msgr2 encryption settings")
		}

		// set default rbd map options to enable msgr2 in the kernel if it's
		// required even with encryption disabled
		if c.Spec.RequireMsgr2() {
			if err := monStore.SetAll("global", map[string]string{rbdMapOptions: "ms_mode=prefer-crc"}); err != nil {
				return err
			}
		}
	}
	// Set network compression
	if c.Spec.Network.Connections == nil || c.Spec.Network.Connections.Compression == nil || !c.Spec.Network.Connections.Compression.Enabled {
		encryptionConfig := []config.Option{
			{Who: "global", Option: "ms_osd_compress_mode"},
		}
		if err := monStore.DeleteAll(encryptionConfig...); err != nil {
			return errors.Wrap(err, "failed to delete msgr2 compression settings")
		}
	} else {
		globalConfigSettings := map[string]string{
			"ms_osd_compress_mode": "force",
		}
		log.NamespacedInfo(c.Namespace, logger, "setting msgr2 compression mode to %q", "force")
		if err := monStore.SetAll("global", globalConfigSettings); err != nil {
			return err
		}
	}

	return nil
}

func (c *cluster) fetchCephConfigFromSecrets() (map[string]map[string]string, error) {
	result := make(map[string]map[string]string)

	for module, keys := range c.Spec.CephConfigFromSecret {
		result[module] = make(map[string]string)

		for key, selector := range keys {
			val, err := c.fetchSecretValue(selector)
			if err != nil {
				return nil, fmt.Errorf("failed to get value for key %q in module %q from secret %q: %w",
					key, module, selector.LocalObjectReference.Name, err)
			}

			log.NamespacedDebug(c.Namespace, logger, "setting Ceph config key %q in module %q from secret %q",
				key, module, selector.LocalObjectReference.Name)
			log.NamespacedTrace(c.Namespace, logger, "setting Ceph config key %q in module %q to value %q from secret %q",
				key, module, val, selector.LocalObjectReference.Name)
			result[module][key] = val
		}
	}

	return result, nil
}

func (c *cluster) fetchSecretValue(selector v1.SecretKeySelector) (string, error) {
	secret, err := c.context.Clientset.CoreV1().Secrets(c.ClusterInfo.Namespace).Get(
		c.ClusterInfo.Context, selector.LocalObjectReference.Name, metav1.GetOptions{},
	)
	if err != nil {
		return "", fmt.Errorf("failed to get secret %q: %w", selector.LocalObjectReference.Name, err)
	}

	val, ok := secret.Data[selector.Key]
	if !ok {
		return "", fmt.Errorf("secret %q is missing key %q", selector.LocalObjectReference.Name, selector.Key)
	}

	return string(val), nil
}

// initClusterCephxStatus set `Uninitialized` cephx status for new clusters.
// this should not be run for external mode clusters
func initClusterCephxStatus(c *cluster) error {
	initErr := c.ClusterInfo.IsInitialized()
	if initErr == nil {
		log.NamespacedDebug(c.Namespace, logger, "not setting uninitialized cephx status on already initialized CephCluster")
		return nil
	}
	if c.ClusterInfo.Context.Err() != nil {
		// most IsInitialized() errors mean the cluster is new, but if clusterInfo.Context is
		// nil, it is a 'real' error to return
		return c.ClusterInfo.Context.Err()
	}

	err := retry.RetryOnConflict(retry.DefaultRetry, func() error {
		clusterObj := &cephv1.CephCluster{}
		err := c.context.Client.Get(c.ClusterInfo.Context, c.namespacedName, clusterObj)
		if err != nil {
			return errors.Wrapf(err, "failed to get cluster in order to initialize its cephx status")
		}

		emptyStatus := cephv1.CephxStatus{}
		// mon cephx status is one of the first set after mons are successfully running, so we only need to check it
		if clusterObj.Status.Cephx.Mon != emptyStatus {
			return nil // do not initialize multiple times
		}

		uninitializedStatus := keyring.UninitializedCephxStatus()
		log.NamespacedInfo(c.Namespace, logger, "initializing cephx status")
		clusterObj.Status.Cephx = cephv1.ClusterCephxStatus{
			Mon: uninitializedStatus,
			Mgr: uninitializedStatus,
			// OSD statuses are determined entirely within OSD reconcile - don't set uninitialized here
			CSI: cephv1.CephxStatusWithKeyCount{
				CephxStatus: uninitializedStatus,
			},
			RBDMirrorPeer:  uninitializedStatus,
			CrashCollector: uninitializedStatus,
			CephExporter:   uninitializedStatus,
		}

		if err := reporting.UpdateStatus(c.context.Client, clusterObj); err != nil {
			return errors.Wrapf(err, "failed to initialize cluster cephx status")
		}

		return nil
	})
	return err
}

func (c *cluster) deleteBootstrapKeys() {
	bootstrapKeys := []string{"client.bootstrap-mds", "client.bootstrap-mgr", "client.bootstrap-rbd", "client.bootstrap-rbd-mirror", "client.bootstrap-rgw"}
	for _, bootstrapkey := range bootstrapKeys {
		err := client.AuthDelete(c.context, c.ClusterInfo, bootstrapkey)
		if err != nil {
			log.NamespacedDebug(c.Namespace, logger, "failed to delete bootstrap key %q. Error: %v", bootstrapkey, err)
		} else {
			log.NamespacedInfo(c.Namespace, logger, "successfully deleted bootstrap key %q", bootstrapkey)
		}
	}
}