(DOCSP-22978) Adding spec.statefulSet.spec.serviceName to the MongoDB Resource spec (#957)

* (DOCSP-22978) spec.statefulSet.spec.serviceName for the MDB resource

* Edits

* Edits, not using the options file

* Extra line at the end of the file

* Fixed indentation

* Updated examples

* edits

* Edits from copy review, also a small nit in multi-cluster about Istio, based on discussion with PL

Author: JuliaMongo

source/includes/options-k8s-shared.yaml

@@ -94,10 +94,10 @@ pre: |
 
      Use :setting:`spec.statefulSet.spec.serviceName` instead.
 description: |
-  Name of |k8s| service to be created or used for a
+  Name of the |k8s| service to be created or used for a
   |k8s-statefulset|. If the service with this name already exists, the
   |k8s-op-full| does not delete or recreate it. This setting lets
-  users create their custom services and lets the |k8s-op-short|
+  you create your own custom services and lets the |k8s-op-short|
   reuse them.
 
 ---

source/multi-cluster-quick-start.txt

@@ -29,8 +29,8 @@ and |istio| service mesh.
 .. note::
 
    The procedure in this Quick Start relies on Istio, but you can use
-   another service mesh solution as long as you ensure that cross-cluster
-   service FQDNs are resolvable.
+   another service mesh or solution as long as you ensure that
+   cross-cluster service FQDNs are resolvable.
 
 The beta release of the |multi-clusters| offers you different layers of
 availability, depending on the needs of your enterprise application. You
@@ -98,7 +98,8 @@ documentation:
 - |istio| service mesh. This tutorial uses |istio| to facilitate
   `DNS resolution <https://istio.io/latest/docs/ops/configuration/traffic-management/dns-proxy/>`__
   for MongoDB replica sets deployed in different |k8s| clusters. You can
-  use another service mesh solution.
+  use another service mesh or solution as long as you ensure that
+  cross-cluster service FQDNs are resolvable.
 
 - Documentation from Istio to `Install Multicluster <https://istio.io/latest/docs/setup/install/multicluster/>`__.
 

source/reference/k8s-operator-om-specification.txt

@@ -477,9 +477,9 @@ Optional |onprem| Resource Settings
    </core/system-overview/#backup-daemon-service>`.
 
    To review which fields you can add to
-   :opsmgrkube:`spec.backup.statefulSet.spec`, see the
-   :k8sdocs:`Kubernetes documentation
-   </reference/generated/kubernetes-api/{+k8s-api-version+}/#statefulsetspec-v1-apps>`.
+   :opsmgrkube:`spec.backup.statefulSet.spec`, see
+   :k8sdocs:`StatefulSetSpec v1 apps
+   </reference/generated/kubernetes-api/{+k8s-api-version+}/#statefulsetspec-v1-apps>` in the |k8s| documentation.
 
 .. opsmgrkube:: spec.backup.statefulSet.spec.template
 
@@ -1141,9 +1141,10 @@ Optional |onprem| Resource Settings
    for |onprem|.
 
    To review which fields you can add to
-   :opsmgrkube:`spec.statefulSet.spec`, see the
-   :k8sdocs:`Kubernetes documentation
-   </reference/generated/kubernetes-api/{+k8s-api-version+}/#statefulsetspec-v1-apps>`.
+   :opsmgrkube:`spec.statefulSet.spec`, see
+   :k8sdocs:`StatefulSetSpec v1 apps
+   </reference/generated/kubernetes-api/{+k8s-api-version+}/#statefulsetspec-v1-apps>`
+   in the |k8s| documentation.
 
 .. opsmgrkube:: spec.statefulSet.spec.template
 

source/reference/k8s-operator-specification.txt

@@ -403,3 +403,30 @@ Examples
 
          .. literalinclude:: /reference/k8s/shardedclusterpodspec.yaml
             :language: yaml
+
+.. _statefulset-settings:
+
+StatefulSet Settings
+--------------------
+
+The following |k8s-statefulsets| settings apply only to replica set and
+sharded cluster resource types.
+
+.. setting:: spec.statefulSet.spec
+
+   *Type*: collection
+
+   Specification for the |k8s-statefulset| that the |k8s-op| creates
+   for |k8s-mdbrscs|.
+
+.. setting:: spec.statefulSet.spec.serviceName
+
+   *Type*: string
+
+   *Default*: ``<resource_name>-svc`` and ``<resource_name>-svc-external``
+
+   Name of the |k8s| service to be created or used for a
+   |k8s-statefulset|. If the service with this name already exists, the
+   |k8s-op-full| does not delete or recreate it. This setting lets
+   you create your own custom services and lets the |k8s-op-short|
+   reuse them.

source/reference/k8s/replicasetpodspec.yaml

@@ -65,6 +65,9 @@ spec:
       enabled: true
       modes: ["X509"]
       internalCluster: "X509"
+  statefulSet:
+    spec:
+      serviceName: my-service
   additionalMongodConfig:
     net:
       ssl:

source/reference/k8s/shardedclusterpodspec.yaml

@@ -105,4 +105,7 @@ spec:
       enabled: true
       modes: ["X509"]
       internalCluster: "X509"
+  statefulSet:
+    spec:
+      serviceName: my-service
 ...