(DOCSP-13665) MongoDB Database Custom Resource Architecture (#499)

Merging the first part of MEKO Production notes effort: the architecture of the MongoDB custom resources. The second part: performance, is to follow in the coming weeks.

Author: JuliaMongo

conf.py

@@ -134,7 +134,8 @@
     '.. |jvm| replace:: :abbr:`JVM (Java Virtual Machine)`',
     '.. |k8s-cr| replace:: `ClusterRole <https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole>`__',
     '.. |k8s-crb| replace:: `ClusterRoleBinding <https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding>`__',
-    '.. |k8s-configmaps| replace:: `ConfigMaps <https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/>`__',
+    '.. |k8s-configmap-def| replace:: `ConfigMap <https://kubernetes.io/docs/concepts/configuration/configmap/>`__',
+    '.. |k8s-configmaps| replace:: `ConfigMaps <https://kubernetes.io/docs/concepts/configuration/configmap/>`__',
     '.. |k8s-configmap| replace:: `ConfigMap <https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/>`__',
     '.. |k8s-custom-resource| replace:: `custom resource <https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/>`__',
     '.. |k8s-custom-resources| replace:: `custom resources <https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/>`__',
@@ -151,17 +152,19 @@
     '.. |k8s-op-full| replace:: MongoDB Enterprise Kubernetes Operator',
     '.. |k8s-op-short| replace:: Kubernetes Operator',
     '.. |k8s-op| replace:: MongoDB Enterprise Kubernetes Operator',
-    '.. |k8s-pods| replace:: `pods <https://kubernetes.io/docs/concepts/workloads/pods/pod/>`__',
-    '.. |k8s-pod| replace:: `pod <https://kubernetes.io/docs/concepts/workloads/pods/pod/>`__',
+    '.. |k8s-pods| replace:: `Pods <https://kubernetes.io/docs/concepts/workloads/pods/pod/>`__',
+    '.. |k8s-pod| replace:: `Pod <https://kubernetes.io/docs/concepts/workloads/pods/pod/>`__',
     '.. |k8s-pvcs| replace:: `Persistent Volume Claims <https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims>`__',
     '.. |k8s-pvc| replace:: `Persistent Volume Claim <https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims>`__',
     '.. |k8s-pvs| replace:: `Persistent Volumes <https://kubernetes.io/docs/concepts/storage/persistent-volumes/>`__',
     '.. |k8s-pv| replace:: `Persistent Volume <https://kubernetes.io/docs/concepts/storage/persistent-volumes/>`__',
+    '.. |k8s-rolling-update| replace:: `rolling update <https://kubernetes.io/docs/tutorials/kubernetes-basics/update/update-intro/>`__',
     '.. |k8s-rule| replace:: `rule <https://kubernetes.io/docs/concepts/configuration/assign-pod-node/>`__',
     '.. |k8s-sc| replace:: `StorageClass <https://kubernetes.io/docs/concepts/storage/storage-classes/>`__',
     '.. |k8s-secrets| replace:: `secrets <https://kubernetes.io/docs/concepts/configuration/secret/>`__',
     '.. |k8s-secret| replace:: `secret <https://kubernetes.io/docs/concepts/configuration/secret/>`__',
     '.. |k8s-service| replace:: `service <https://kubernetes.io/docs/concepts/services-networking/service/>`__',
+    '.. |k8s-service-type| replace:: `ServiceType <https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types>`__',
     '.. |k8s-statefulsets| replace:: `StatefulSets <https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/>`__',
     '.. |k8s-statefulset| replace:: `StatefulSet <https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/>`__',
     '.. |k8s-webhook| replace:: `Webhook <https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#what-are-admission-webhooks>`__',

snooty.toml

@@ -10,6 +10,7 @@ appdb-init-version = "1.0.6"
 ops-manager-init-version = "1.0.3"
 database-init-version = "1.0.2"
 mdbtools-version = "100.1.0"
+mdbagent = "MongoDB Agent"
 appdb-agent-version = "10.2.15.5958-1_4.2.11-ent"
 mdb-ent-db = "MongoDB Enterprise Database"
 mdb-ent-db-version = "2.0.0"

source/images/mdb-resources-arch.svg

@@ -13,7 +13,7 @@ Install and Configure the |k8s-op-short|
    :class: singlecol
 
 :ref:`plan-k8s-operator-install`
-  Review |k8s-op-short| deployment scopes, considerations, and
+  Review |k8s-op-short| deployment architecture, scopes, considerations, and
   prerequisites.
 
 :ref:`install-k8s`

source/images/mdb-resources-replica-set-reconciliation.svg

@@ -12,6 +12,9 @@ You can use the |k8s-op-short| to deploy and manage MongoDB clusters
 from the |k8s| |api|, without having to configure them in
 |onprem| or |cloud-short|.
 
+:ref:`mdb-resources-arch`
+  Review the MongoDB database custom resources architecture.
+
 :ref:`configure-k8s-op-mdb-resources`
   Configure the |k8s-op-short| to deploy MongoDB database resources.
 
@@ -37,6 +40,7 @@ from the |k8s| |api|, without having to configure them in
    .. toctree::
       :titlesonly:
 
+      /tutorial/mdb-resources-arch
       /configure-k8s-operator-for-mdb-resources
       /deploy
       /tutorial/edit-deployment