CLOUDP-78859: Rename Community CRD (#294)

* CLOUDP-78859: Rename Community CRD

* Fix operator crash and test failures

* Fix black formatting

* Rename crs and fix docs

* Fix missing mongodbcommunity_crd

* Fix black formatting

* Fix black formatting, the sequel

Author: alyacb

deploy/crds/arbitrary_statefulset_configuration/mongodb.com_v1_custom_volume_cr.yaml

@@ -1,5 +1,5 @@
 apiVersion: mongodb.com/v1
-kind: MongoDB
+kind: MongoDBCommunity
 metadata:
   name: example-mongodb
 spec:

deploy/crds/mongodb.com_mongodb_crd.yaml renamed to deploy/crds/mongodb.com_mongodbcommunity_crd.yaml

@@ -1,7 +1,7 @@
 apiVersion: apiextensions.k8s.io/v1beta1
 kind: CustomResourceDefinition
 metadata:
-  name: mongodb.mongodb.com
+  name: mongodbcommunity.mongodb.com
 spec:
   additionalPrinterColumns:
   - JSONPath: .status.phase
@@ -14,18 +14,18 @@ spec:
     type: string
   group: mongodb.com
   names:
-    kind: MongoDB
-    listKind: MongoDBList
-    plural: mongodb
+    kind: MongoDBCommunity
+    listKind: MongoDBCommunityList
+    plural: mongodbcommunity
     shortNames:
-    - mdb
-    singular: mongodb
+    - mdbc
+    singular: mongodbcommunity
   scope: Namespaced
   subresources:
     status: {}
   validation:
     openAPIV3Schema:
-      description: MongoDB is the Schema for the mongodbs API
+      description: MongoDBCommunity is the Schema for the mongodbs API
       properties:
         apiVersion:
           description: 'APIVersion defines the versioned schema of this representation
@@ -40,7 +40,7 @@ spec:
         metadata:
           type: object
         spec:
-          description: MongoDBSpec defines the desired state of MongoDB
+          description: MongoDBCommunitySpec defines the desired state of MongoDB
           properties:
             featureCompatibilityVersion:
               description: FeatureCompatibilityVersion configures the feature compatibility
@@ -278,7 +278,7 @@ spec:
           - version
           type: object
         status:
-          description: MongoDBStatus defines the observed state of MongoDB
+          description: MongoDBCommunityStatus defines the observed state of MongoDB
           properties:
             currentMongoDBMembers:
               type: integer

deploy/crds/mongodb.com_v1_mongodb_cr.yaml renamed to deploy/crds/mongodb.com_v1_mongodbcommunity_cr.yaml

@@ -1,6 +1,6 @@
 ---
 apiVersion: mongodb.com/v1
-kind: MongoDB
+kind: MongoDBCommunity
 metadata:
   name: example-mongodb
 spec:

deploy/crds/mongodb.com_v1_mongodb_custom_role.yaml renamed to deploy/crds/mongodb.com_v1_mongodbcommunity_custom_role.yaml

@@ -1,6 +1,6 @@
 ---
 apiVersion: mongodb.com/v1
-kind: MongoDB
+kind: MongoDBCommunity
 metadata:
   name: custom-role-mongodb
 spec:

deploy/crds/mongodb.com_v1_mongodb_openshift_cr.yaml renamed to deploy/crds/mongodb.com_v1_mongodbcommunity_openshift_cr.yaml

@@ -1,6 +1,6 @@
 ---
 apiVersion: mongodb.com/v1
-kind: MongoDB
+kind: MongoDBCommunity
 metadata:
   name: example-openshift-mongodb
 spec:

deploy/crds/mongodb.com_v1_mongodb_tls_cr.yaml renamed to deploy/crds/mongodb.com_v1_mongodbcommunity_tls_cr.yaml

@@ -1,6 +1,6 @@
 ---
 apiVersion: mongodb.com/v1
-kind: MongoDB
+kind: MongoDBCommunity
 metadata:
   name: example-mongodb
 spec:

deploy/kustomization.yaml

@@ -1,7 +1,7 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 resources:
- - ./crds/mongodb.com_mongodb_crd.yaml
+ - ./crds/mongodb.com_mongodbcommunity_crd.yaml
  - ./operator/service_account.yaml
  - ./operator/role.yaml
  - ./operator/role_binding.yaml

docs/architecture.md

@@ -28,7 +28,7 @@ You create and update MongoDB resources by defining a MongoDB resource definitio
    - `automation-config` which is mounted from the previously generated ConfigMap to both the server and agent. Only lives as long as the pod.
    - `healthstatus` which contains the agent's current status. This is shared with the `mongod` container where it's used by the pre-stop hook. Only lives as long as the pod.
 
-1. Initiates the MongoDB Agent, which in turn creates the database configuration and launches the `mongod` process according to your [MongoDB resource definition](../deploy/crds/mongodb.com_v1_mongodb_cr.yaml).
+1. Initiates the MongoDB Agent, which in turn creates the database configuration and launches the `mongod` process according to your [MongoDB resource definition](../deploy/crds/mongodb.com_v1_mongodbcommunity_cr.yaml).
 
 <!--
 <img src="" alt="Architecure diagram of the MongoDB Community Kubernetes Operator">

docs/deploy-configure.md

@@ -17,7 +17,7 @@ To deploy your first replica set:
 
 1. Invoke the following `kubectl` command:
    ```
-   kubectl apply -f deploy/crds/mongodb.com_v1_mongodb_cr.yaml --namespace <my-namespace>
+   kubectl apply -f deploy/crds/mongodb.com_v1_mongodbcommunity_cr.yaml --namespace <my-namespace>
    ```
 2. Verify that the MongoDB resource deployed:
    ```
@@ -129,7 +129,7 @@ To upgrade this resource from `4.0.6` to `4.2.7`:
 
 To deploy the operator on OpenShift you will have to provide the environment variable `MANAGED_SECURITY_CONTEXT` set to `true` for both the `mongodb` and `mongodb-agent` containers, as well as the operator deployment.
 
-See [here](../deploy/crds/mongodb.com_v1_mongodb_openshift_cr.yaml) for
+See [here](../deploy/crds/mongodb.com_v1_mongodbcommunity_openshift_cr.yaml) for
 an example of how to provide the required configuration for a MongoDB
 replica set.
 

docs/install-upgrade.md

@@ -32,11 +32,11 @@ To install the MongoDB Community Kubernetes Operator:
 
    a. Invoke the following `kubectl` command:
       ```
-      kubectl create -f deploy/crds/mongodb.com_mongodb_crd.yaml
+      kubectl create -f deploy/crds/mongodb.com_mongodbcommunity_crd.yaml
       ```
    b. Verify that the Custom Resource Definitions installed successfully:
       ```
-      kubectl get crd/mongodb.mongodb.com
+      kubectl get crd/mongodbcommunity.mongodb.com
       ```
 3. Install the Operator.
 
@@ -56,5 +56,5 @@ To upgrade the MongoDB Community Kubernetes Operator:
 1. Change to the directory in which you cloned the repository.
 2. Invoke the following `kubectl` command to upgrade the [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
    ```
-   kubectl apply -f deploy/crds/mongodb.com_mongodb_crd.yaml
+   kubectl apply -f deploy/crds/mongodb.com_mongodbcommunity_crd.yaml
    ```

pkg/apis/mongodb/v1/mongodb_types.go

@@ -35,8 +35,8 @@ const (
 	defaultPasswordKey = "password"
 )
 
-// MongoDBSpec defines the desired state of MongoDB
-type MongoDBSpec struct {
+// MongoDBCommunitySpec defines the desired state of MongoDB
+type MongoDBCommunitySpec struct {
 	// Members is the number of members in the replica set
 	// +optional
 	Members int `json:"members"`
@@ -314,8 +314,8 @@ type Authentication struct {
 // +kubebuilder:validation:Enum=SCRAM
 type AuthMode string
 
-// MongoDBStatus defines the observed state of MongoDB
-type MongoDBStatus struct {
+// MongoDBCommunityStatus defines the observed state of MongoDB
+type MongoDBCommunityStatus struct {
 	MongoURI string `json:"mongoUri"`
 	Phase    Phase  `json:"phase"`
 
@@ -327,20 +327,20 @@ type MongoDBStatus struct {
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
-// MongoDB is the Schema for the mongodbs API
+// MongoDBCommunity is the Schema for the mongodbs API
 // +kubebuilder:subresource:status
-// +kubebuilder:resource:path=mongodb,scope=Namespaced,shortName=mdb
+// +kubebuilder:resource:path=mongodbcommunity,scope=Namespaced,shortName=mdbc,singular=mongodbcommunity
 // +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="Current state of the MongoDB deployment"
 // +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".status.version",description="Version of MongoDB server"
-type MongoDB struct {
+type MongoDBCommunity struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   MongoDBSpec   `json:"spec,omitempty"`
-	Status MongoDBStatus `json:"status,omitempty"`
+	Spec   MongoDBCommunitySpec   `json:"spec,omitempty"`
+	Status MongoDBCommunityStatus `json:"status,omitempty"`
 }
 
-func (m MongoDB) AutomationConfigMembersThisReconciliation() int {
+func (m MongoDBCommunity) AutomationConfigMembersThisReconciliation() int {
 	// determine the correct number of automation config replica set members
 	// based on our desired number, and our current number
 	return scale.ReplicasThisReconciliation(automationConfigReplicasScaler{
@@ -350,7 +350,7 @@ func (m MongoDB) AutomationConfigMembersThisReconciliation() int {
 }
 
 // MongoURI returns a mongo uri which can be used to connect to this deployment
-func (m MongoDB) MongoURI() string {
+func (m MongoDBCommunity) MongoURI() string {
 	members := make([]string, m.Spec.Members)
 	clusterDomain := "svc.cluster.local" // TODO: make this configurable
 	for i := 0; i < m.Spec.Members; i++ {
@@ -359,7 +359,7 @@ func (m MongoDB) MongoURI() string {
 	return fmt.Sprintf("mongodb://%s", strings.Join(members, ","))
 }
 
-func (m MongoDB) Hosts() []string {
+func (m MongoDBCommunity) Hosts() []string {
 	hosts := make([]string, m.Spec.Members)
 	clusterDomain := "svc.cluster.local" // TODO: make this configurable
 	for i := 0; i < m.Spec.Members; i++ {
@@ -370,42 +370,42 @@ func (m MongoDB) Hosts() []string {
 
 // ServiceName returns the name of the Service that should be created for
 // this resource
-func (m MongoDB) ServiceName() string {
+func (m MongoDBCommunity) ServiceName() string {
 	return m.Name + "-svc"
 }
 
-func (m MongoDB) AutomationConfigSecretName() string {
+func (m MongoDBCommunity) AutomationConfigSecretName() string {
 	return m.Name + "-config"
 }
 
 // TLSConfigMapNamespacedName will get the namespaced name of the ConfigMap containing the CA certificate
 // As the ConfigMap will be mounted to our pods, it has to be in the same namespace as the MongoDB resource
-func (m MongoDB) TLSConfigMapNamespacedName() types.NamespacedName {
+func (m MongoDBCommunity) TLSConfigMapNamespacedName() types.NamespacedName {
 	return types.NamespacedName{Name: m.Spec.Security.TLS.CaConfigMap.Name, Namespace: m.Namespace}
 }
 
 // TLSSecretNamespacedName will get the namespaced name of the Secret containing the server certificate and key
-func (m MongoDB) TLSSecretNamespacedName() types.NamespacedName {
+func (m MongoDBCommunity) TLSSecretNamespacedName() types.NamespacedName {
 	return types.NamespacedName{Name: m.Spec.Security.TLS.CertificateKeySecret.Name, Namespace: m.Namespace}
 }
 
 // TLSOperatorSecretNamespacedName will get the namespaced name of the Secret created by the operator
 // containing the combined certificate and key.
-func (m MongoDB) TLSOperatorSecretNamespacedName() types.NamespacedName {
+func (m MongoDBCommunity) TLSOperatorSecretNamespacedName() types.NamespacedName {
 	return types.NamespacedName{Name: m.Name + "-server-certificate-key", Namespace: m.Namespace}
 }
 
-func (m MongoDB) NamespacedName() types.NamespacedName {
+func (m MongoDBCommunity) NamespacedName() types.NamespacedName {
 	return types.NamespacedName{Name: m.Name, Namespace: m.Namespace}
 }
 
-func (m *MongoDB) ScramCredentialsNamespacedName() types.NamespacedName {
+func (m *MongoDBCommunity) ScramCredentialsNamespacedName() types.NamespacedName {
 	return types.NamespacedName{Name: fmt.Sprintf("%s-agent-scram-credentials", m.Name), Namespace: m.Namespace}
 }
 
 // GetFCV returns the feature compatibility version. If no FeatureCompatibilityVersion is specified.
 // It uses the major and minor version for whichever version of MongoDB is configured.
-func (m MongoDB) GetFCV() string {
+func (m MongoDBCommunity) GetFCV() string {
 	versionToSplit := m.Spec.FeatureCompatibilityVersion
 	if versionToSplit == "" {
 		versionToSplit = m.Spec.Version
@@ -415,15 +415,15 @@ func (m MongoDB) GetFCV() string {
 	return strings.Join(parts[:minorIndex+1], ".")
 }
 
-func (m MongoDB) DesiredReplicas() int {
+func (m MongoDBCommunity) DesiredReplicas() int {
 	return m.Spec.Members
 }
 
-func (m MongoDB) CurrentReplicas() int {
+func (m MongoDBCommunity) CurrentReplicas() int {
 	return m.Status.CurrentStatefulSetReplicas
 }
 
-func (m *MongoDB) StatefulSetReplicasThisReconciliation() int {
+func (m *MongoDBCommunity) StatefulSetReplicasThisReconciliation() int {
 	return scale.ReplicasThisReconciliation(m)
 }
 
@@ -441,13 +441,13 @@ func (a automationConfigReplicasScaler) CurrentReplicas() int {
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
-// MongoDBList contains a list of MongoDB
-type MongoDBList struct {
+// MongoDBCommunityList contains a list of MongoDB
+type MongoDBCommunityList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
-	Items           []MongoDB `json:"items"`
+	Items           []MongoDBCommunity `json:"items"`
 }
 
 func init() {
-	SchemeBuilder.Register(&MongoDB{}, &MongoDBList{})
+	SchemeBuilder.Register(&MongoDBCommunity{}, &MongoDBCommunityList{})
 }

pkg/apis/mongodb/v1/mongodb_types_test.go

@@ -97,14 +97,14 @@ func TestGetScramCredentialsSecretName(t *testing.T) {
 
 }
 
-func newReplicaSet(members int, name, namespace string) MongoDB {
-	return MongoDB{
+func newReplicaSet(members int, name, namespace string) MongoDBCommunity {
+	return MongoDBCommunity{
 		TypeMeta: metav1.TypeMeta{},
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      name,
 			Namespace: namespace,
 		},
-		Spec: MongoDBSpec{
+		Spec: MongoDBCommunitySpec{
 			Members: members,
 		},
 	}