Documentation
¶
Index ¶
- Constants
- Variables
- func Add(mgr manager.Manager, context *clusterd.Context, ...) error
- func CSIEnabled() bool
- func CreateCSISecrets(context *clusterd.Context, clusterInfo *client.ClusterInfo) error
- func CreateCsiConfigMap(ctx context.Context, namespace string, clientset kubernetes.Interface, ...) error
- func FormatCsiClusterConfig(clusterKey string, mons map[string]*cephclient.MonInfo) (string, error)
- func GenerateNetNamespaceFilePath(ctx context.Context, client client.Client, ...) (string, error)
- func GetPodAntiAffinity(key, value string) corev1.PodAntiAffinity
- func IsHolderEnabled() bool
- func MonEndpoints(mons map[string]*cephclient.MonInfo, requireMsgr2 bool) []string
- func SaveCSIDriverOptions(clientset kubernetes.Interface, clusterNamespace string, ...) error
- func SaveClusterConfig(clientset kubernetes.Interface, clusterNamespace string, ...) error
- type CSIClusterConfigEntry
- type CephCSIVersion
- type ClusterDetail
- type Param
- type ReconcileCSI
Constants ¶
const ( CsiRBDNodeSecret = "rook-csi-rbd-node" CsiRBDProvisionerSecret = "rook-csi-rbd-provisioner" )
const ( CsiCephFSNodeSecret = "rook-csi-cephfs-node" CsiCephFSProvisionerSecret = "rook-csi-cephfs-provisioner" )
const ( // kubelet directory path DefaultKubeletDirPath = "/var/lib/kubelet" // grpc metrics and liveness port for cephfs and rbd DefaultCephFSGRPCMerticsPort uint16 = 9091 DefaultCephFSLivenessMerticsPort uint16 = 9081 DefaultRBDGRPCMerticsPort uint16 = 9090 DefaultRBDLivenessMerticsPort uint16 = 9080 DefaultCSIAddonsPort uint16 = 9070 // driver daemonset names CsiRBDPlugin = "csi-rbdplugin" CsiCephFSPlugin = "csi-cephfsplugin" CsiNFSPlugin = "csi-nfsplugin" RBDDriverShortName = "rbd" CephFSDriverShortName = "cephfs" NFSDriverShortName = "nfs" )
Variables ¶
var ( CSIParam Param EnableRBD = false EnableCephFS = false EnableNFS = false AllowUnsupported = false CustomCSICephConfigExists = false // driver names CephFSDriverName string NFSDriverName string RBDDriverName string // configuration map for csi ConfigName = "rook-ceph-csi-config" ConfigKey = "csi-cluster-config-json" )
var ( // image names DefaultCSIPluginImage = "quay.io/cephcsi/cephcsi:v3.11.0" DefaultRegistrarImage = "registry.k8s.io/sig-storage/csi-node-driver-registrar:v2.10.0" DefaultProvisionerImage = "registry.k8s.io/sig-storage/csi-provisioner:v4.0.0" DefaultAttacherImage = "registry.k8s.io/sig-storage/csi-attacher:v4.5.0" DefaultSnapshotterImage = "registry.k8s.io/sig-storage/csi-snapshotter:v7.0.1" DefaultResizerImage = "registry.k8s.io/sig-storage/csi-resizer:v1.10.0" DefaultCSIAddonsImage = "quay.io/csiaddons/k8s-sidecar:v0.8.0" // image pull policy DefaultCSIImagePullPolicy = string(corev1.PullIfNotPresent) // Local package template path for RBD //go:embed template/rbd/csi-rbdplugin.yaml RBDPluginTemplatePath string //go:embed template/rbd/csi-rbdplugin-holder.yaml RBDPluginHolderTemplatePath string //go:embed template/rbd/csi-rbdplugin-provisioner-dep.yaml RBDProvisionerDepTemplatePath string //go:embed template/rbd/csi-rbdplugin-svc.yaml RBDPluginServiceTemplatePath string // Local package template path for CephFS //go:embed template/cephfs/csi-cephfsplugin.yaml CephFSPluginTemplatePath string //go:embed template/cephfs/csi-cephfsplugin-holder.yaml CephFSPluginHolderTemplatePath string //go:embed template/cephfs/csi-cephfsplugin-provisioner-dep.yaml CephFSProvisionerDepTemplatePath string //go:embed template/cephfs/csi-cephfsplugin-svc.yaml CephFSPluginServiceTemplatePath string // Local package template path for NFS //go:embed template/nfs/csi-nfsplugin.yaml NFSPluginTemplatePath string //go:embed template/nfs/csi-nfsplugin-provisioner-dep.yaml NFSProvisionerDepTemplatePath string //go:embed template/nfs/csi-nfsplugin-holder.yaml NFSPluginHolderTemplatePath string )
Specify default images as var instead of const so that they can be overridden with the Go linker's -X flag. This allows users to easily build images with a different opinionated set of images without having to specify them manually in charts/manifests which can make upgrades more manually challenging.
Functions ¶
func Add ¶ added in v1.8.0
func Add(mgr manager.Manager, context *clusterd.Context, opManagerContext context.Context, opConfig opcontroller.OperatorConfig) error
Add creates a new Ceph CSI Controller and adds it to the Manager. The Manager will set fields on the Controller and Start it when the Manager is Started.
func CSIEnabled ¶
func CSIEnabled() bool
func CreateCSISecrets ¶ added in v1.1.3
func CreateCSISecrets(context *clusterd.Context, clusterInfo *client.ClusterInfo) error
CreateCSISecrets creates all the Kubernetes CSI Secrets
func CreateCsiConfigMap ¶ added in v1.1.0
func CreateCsiConfigMap(ctx context.Context, namespace string, clientset kubernetes.Interface, ownerInfo *k8sutil.OwnerInfo) error
CreateCsiConfigMap creates an empty config map that will be later used to provide cluster configuration to ceph-csi. If a config map already exists, it will return it.
func FormatCsiClusterConfig ¶ added in v1.1.0
func FormatCsiClusterConfig( clusterKey string, mons map[string]*cephclient.MonInfo, ) (string, error)
FormatCsiClusterConfig returns a json-formatted string containing the cluster-to-mon mapping required to configure ceph csi.
func GenerateNetNamespaceFilePath ¶ added in v1.9.2
func GetPodAntiAffinity ¶ added in v1.4.0
func GetPodAntiAffinity(key, value string) corev1.PodAntiAffinity
Get PodAntiAffinity from a key and value pair
func IsHolderEnabled ¶ added in v1.14.0
func IsHolderEnabled() bool
func MonEndpoints ¶ added in v1.8.3
func MonEndpoints(mons map[string]*cephclient.MonInfo, requireMsgr2 bool) []string
func SaveCSIDriverOptions ¶ added in v1.13.0
func SaveCSIDriverOptions(clientset kubernetes.Interface, clusterNamespace string, clusterInfo *cephclient.ClusterInfo) error
SaveCSIDriverOptions, similar to SaveClusterConfig, updates the config map used by ceph-csi with CSI driver options such as read affinity, kernel mount options and fuse mount options.
func SaveClusterConfig ¶ added in v1.1.0
func SaveClusterConfig(clientset kubernetes.Interface, clusterNamespace string, clusterInfo *cephclient.ClusterInfo, newCsiClusterConfigEntry *CSIClusterConfigEntry) error
SaveClusterConfig updates the config map used to provide ceph-csi with basic cluster configuration. The clusterNamespace and clusterInfo are used to determine what "cluster" in the config map will be updated and the clusterNamespace value is expected to match the clusterID value that is provided to ceph-csi uses in the storage class. The locker l is typically a mutex and is used to prevent the config map from being updated for multiple clusters simultaneously.
Types ¶
type CSIClusterConfigEntry ¶ added in v1.14.0
type CSIClusterConfigEntry struct {
cephcsi.ClusterInfo
Namespace string `json:"namespace"`
}
type CephCSIVersion ¶ added in v1.3.0
CephCSIVersion represents the Ceph CSI version format
func (*CephCSIVersion) String ¶ added in v1.3.0
func (v *CephCSIVersion) String() string
func (*CephCSIVersion) Supported ¶ added in v1.3.0
func (v *CephCSIVersion) Supported() bool
Supported checks if the detected version is part of the known supported CSI versions
type ClusterDetail ¶ added in v1.9.2
type ClusterDetail struct {
// contains filtered or unexported fields
}
ClusterDetail is a struct that holds the information of a cluster, it knows its internals (like FSID through clusterInfo) and the Kubernetes object that represents it (like the CephCluster CRD)
type Param ¶
type Param struct {
CSIPluginImage string
RegistrarImage string
ProvisionerImage string
AttacherImage string
SnapshotterImage string
ResizerImage string
DriverNamePrefix string
KubeletDirPath string
ForceCephFSKernelClient string
CephFSKernelMountOptions string
CephFSPluginUpdateStrategy string
NFSPluginUpdateStrategy string
RBDPluginUpdateStrategy string
PluginPriorityClassName string
ProvisionerPriorityClassName string
VolumeReplicationImage string
CSIAddonsImage string
ImagePullPolicy string
CSIClusterName string
CSIDomainLabels string
GRPCTimeout time.Duration
CSIEnableMetadata bool
EnablePluginSelinuxHostMount bool
EnableCSIHostNetwork bool
EnableOMAPGenerator bool
EnableRBDSnapshotter bool
EnableCephFSSnapshotter bool
EnableNFSSnapshotter bool
EnableCSIAddonsSideCar bool
MountCustomCephConf bool
EnableCSIDriverSeLinuxMount bool
EnableCSIEncryption bool
EnableCSITopology bool
EnableLiveness bool
CephFSAttachRequired bool
RBDAttachRequired bool
NFSAttachRequired bool
VolumeGroupSnapshotSupported bool
EnableVolumeGroupSnapshot bool
LogLevel uint8
SidecarLogLevel uint8
CephFSLivenessMetricsPort uint16
CSIAddonsPort uint16
RBDLivenessMetricsPort uint16
LeaderElectionLeaseDuration time.Duration
LeaderElectionRenewDeadline time.Duration
LeaderElectionRetryPeriod time.Duration
ProvisionerReplicas int32
CSICephFSPodLabels map[string]string
CSINFSPodLabels map[string]string
CSIRBDPodLabels map[string]string
}
type ReconcileCSI ¶ added in v1.8.0
type ReconcileCSI struct {
// contains filtered or unexported fields
}
ReconcileCSI reconciles a ceph-csi driver
func (*ReconcileCSI) Reconcile ¶ added in v1.8.0
func (r *ReconcileCSI) Reconcile(context context.Context, request reconcile.Request) (reconcile.Result, error)
Reconcile reads that state of the operator config map and makes changes based on the state read The Controller will requeue the Request to be processed again if the returned error is non-nil or Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
Source Files
Directories