Add CephCluster API (cephclusters.csi.ceph.io)

PROJECT

@@ -25,4 +25,12 @@ resources:
   kind: OperatorConfig
   path: github.com/ceph/ceph-csi-operator/api/v1alpha1
   version: v1alpha1
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: ceph.io
+  group: csi
+  kind: CephCluster
+  path: github.com/ceph/ceph-csi-operator/api/v1alpha1
+  version: v1alpha1
 version: "3"

api/v1alpha1/cephcluster_types.go

@@ -0,0 +1,62 @@
+/*
+Copyright 2024.
+
+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 v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// ReadAffinitySpec capture Ceph CSI read affinity settings
+type ReadAffinitySpec struct {
+	CrushLocationLabels []string `json:"crushLocationLabels,omitempty"`
+}
+
+// CephClusterSpec defines the desired state of CephCluster
+type CephClusterSpec struct {
+	Monitors             []string         `json:"monitors"`
+	ReadAffinity         ReadAffinitySpec `json:"readAffinity,omitempty"`
+	RbdMirrorDaemonCount int              `json:"rbdMirrorDaemonCount,omitempty"`
+}
+
+// CephClusterStatus defines the observed state of CephCluster
+type CephClusterStatus struct {
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// CephCluster is the Schema for the cephclusters API
+type CephCluster struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   CephClusterSpec   `json:"spec,omitempty"`
+	Status CephClusterStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// CephClusterList contains a list of CephCluster
+type CephClusterList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []CephCluster `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&CephCluster{}, &CephClusterList{})
+}

config/crd/bases/csi.ceph.io_cephclusters.yaml

@@ -0,0 +1,66 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.14.0
+  name: cephclusters.csi.ceph.io
+spec:
+  group: csi.ceph.io
+  names:
+    kind: CephCluster
+    listKind: CephClusterList
+    plural: cephclusters
+    singular: cephcluster
+  scope: Namespaced
+  versions:
+  - name: v1alpha1
+    schema:
+      openAPIV3Schema:
+        description: CephCluster is the Schema for the cephclusters API
+        properties:
+          apiVersion:
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+            type: string
+          kind:
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: CephClusterSpec defines the desired state of CephCluster
+            properties:
+              monitors:
+                items:
+                  type: string
+                type: array
+              rbdMirrorDaemonCount:
+                type: integer
+              readAffinity:
+                description: ReadAffinitySpec capture Ceph CSI read affinity settings
+                properties:
+                  crushLocationLabels:
+                    items:
+                      type: string
+                    type: array
+                type: object
+            required:
+            - monitors
+            type: object
+          status:
+            description: CephClusterStatus defines the observed state of CephCluster
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}

config/crd/kustomization.yaml

@@ -4,6 +4,7 @@
 resources:
 - bases/csi.ceph.io_drivers.yaml
 - bases/csi.ceph.io_operatorconfigs.yaml
+- bases/csi.ceph.io_cephclusters.yaml
 #+kubebuilder:scaffold:crdkustomizeresource
 
 patches:
@@ -15,6 +16,7 @@ patches:
 # patches here are for enabling the CA injection for each CRD
 #- path: patches/cainjection_in_drivers.yaml
 #- path: patches/cainjection_in_operatorconfigs.yaml
+#- path: patches/cainjection_in_cephclusters.yaml
 #+kubebuilder:scaffold:crdkustomizecainjectionpatch
 
 # [WEBHOOK] To enable webhook, uncomment the following section

config/rbac/cephcluster_editor_role.yaml

@@ -0,0 +1,27 @@
+# permissions for end users to edit cephclusters.
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  labels:
+    app.kubernetes.io/name: ceph-csi-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: cephcluster-editor-role
+rules:
+- apiGroups:
+  - csi.ceph.io
+  resources:
+  - cephclusters
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
+- apiGroups:
+  - csi.ceph.io
+  resources:
+  - cephclusters/status
+  verbs:
+  - get

config/rbac/cephcluster_viewer_role.yaml

@@ -0,0 +1,23 @@
+# permissions for end users to view cephclusters.
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  labels:
+    app.kubernetes.io/name: ceph-csi-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: cephcluster-viewer-role
+rules:
+- apiGroups:
+  - csi.ceph.io
+  resources:
+  - cephclusters
+  verbs:
+  - get
+  - list
+  - watch
+- apiGroups:
+  - csi.ceph.io
+  resources:
+  - cephclusters/status
+  verbs:
+  - get

config/rbac/kustomization.yaml

@@ -20,6 +20,8 @@ resources:
 # default, aiding admins in cluster management. Those roles are
 # not used by the Project itself. You can comment the following lines
 # if you do not want those helpers be installed with your Project.
+- cephcluster_editor_role.yaml
+- cephcluster_viewer_role.yaml
 - operatorconfig_editor_role.yaml
 - operatorconfig_viewer_role.yaml
 - driver_editor_role.yaml

config/samples/csi_v1alpha1_cephcluster.yaml

@@ -0,0 +1,9 @@
+apiVersion: csi.ceph.io/v1alpha1
+kind: CephCluster
+metadata:
+  labels:
+    app.kubernetes.io/name: ceph-csi-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: cephcluster-sample
+spec:
+  # TODO(user): Add fields here

config/samples/kustomization.yaml

@@ -2,4 +2,5 @@
 resources:
 - csi_v1alpha1_driver.yaml
 - csi_v1alpha1_operatorconfig.yaml
+- csi_v1alpha1_cephcluster.yaml
 #+kubebuilder:scaffold:manifestskustomizesamples