(DOCSP-7580): New field 'replicas' in MongodbOpsManager

Author: melissamahoney-mongodb

source/includes/steps-deploy-k8s-opsmgr.yaml

@@ -10,7 +10,7 @@ content: |
 
    .. literalinclude:: /reference/k8s/example-opsmgr-minimal.yaml
       :language: yaml
-      :emphasize-lines: 5-10,12-13
+      :emphasize-lines: 5,7-11,13-14
 
 ---
 title: "Open your preferred text editor and paste the |k8s-obj| specification into a new text file."
@@ -44,6 +44,16 @@ content: |
 
         - ``om``
 
+      * - :opsmgrkube:`spec.replicas`
+        - number
+        - Number of |onprem| instances to run in parallel.
+
+          The minimum valid value is ``1``.
+
+          .. include:: /includes/note-highly-available-om.rst
+
+        - ``1``
+
       * - :opsmgrkube:`spec.version`
         - string
         - Version of |onprem| to be installed.
@@ -187,9 +197,48 @@ content: |
   .. code-block:: sh
 
      kubectl get om -n <namespace> -o yaml -w
+
+  The command returns the following output under the ``status`` field
+  while the resource deploys:
   
-  The ``-w`` flag means "watch". With the "watch" flag set, the output
-  refreshes immediately when something changes.
+  .. code-block:: yaml
+     :copyable: false
+
+     status:
+      applicationDatabase:
+       lastTransition: "2019-11-15T19:48:01Z"
+       message: AppDB Statefulset is not ready yet
+       phase: Reconciling
+       type: ""
+       version: ""
+      opsManager:
+       lastTransition: "2019-11-15T19:48:01Z"
+       message: Ops Manager is still waiting to start
+       phase: Reconciling
+       version: ""
+
+  After the resource completes the ``Reconciling`` phase, the command
+  returns the following output under the ``status`` field: 
+
+  .. code-block:: yaml
+     :copyable: false
+
+     status:
+      applicationDatabase:
+       lastTransition: "2019-11-05T17:26:42Z"
+       phase: Running
+       type: ""
+       version: 4.0.7
+      opsManager:
+       lastTransition: "2019-11-05T17:26:34Z"
+       phase: Running
+       replicas: 1
+       url: http://om-test-svc.dev.svc.cluster.local:8080
+       version: 4.2.0
+
+  The ``status.opsManager.url`` is the connection URL of the resource,
+  which can be used to reach |onprem| from inside the |k8s|
+  cluster.
 
   If the deployment fails, see :doc:`/reference/troubleshooting`.
 

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

@@ -62,6 +62,16 @@ resources.
 
    *Required*. Name of the MongoDB |k8s| resource you are creating.
 
+.. opsmgrkube:: spec.replicas
+
+   *Type*: number
+
+   *Required*. Number of |onprem| instances to run in parallel. 
+   
+   The minimum accepted value is ``1``.
+
+   .. include:: /includes/note-highly-available-om.rst
+
 .. opsmgrkube:: spec.version
 
    *Type*: number
@@ -134,7 +144,7 @@ Optional |onprem| Resource Settings
    *Type*: string
 
    |k8s| assigns each |k8s-pod| a |fqdn|. The |k8s-op-short| calculates 
-   the |fqdn| for each |k8s-pod| using a provided ``clusterName``. |k8s| 
+   the |fqdn| for each |k8s-pod| using a provided ``clusterName``. |k8s|
    does not provide an |api| to query these hostnames.
 
 .. opsmgrkube:: spec.configuration

source/reference/k8s/example-ops-manager.yaml

@@ -3,6 +3,7 @@ kind: MongoDBOpsManager
 metadata:
  name: om
 spec:
+ replicas: 1
  version: 4.2.0
  adminCredentials: ops-manager-admin
  configuration:
@@ -14,4 +15,4 @@ spec:
    version: 4.0.7
    persistent: true
    podSpec:
-     cpu: '0.25'
+     cpu: '0.25'

source/reference/k8s/example-opsmgr-minimal.yaml

@@ -4,6 +4,7 @@ kind: MongoDBOpsManager
 metadata:
   name: <myopsmanager>
 spec:
+  replicas: 1
   version: <opsmanagerversion>
   adminCredentials: <adminusercredentials> # Should match metadata.name
                                            # in the Kubernetes secret

source/release-notes.txt

@@ -53,7 +53,8 @@ Ops Manager Resource Changes (Alpha Release)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Supports highly available :ref:`Ops Manager resources
-  <k8s-om-specification>` by introducing the ``spec.replicas`` setting.
+  <k8s-om-specification>` by introducing the :opsmgrkube:`spec.replicas`
+  setting. 
 
 - Runs |k8s-pods| as a non-root user.
 

source/tutorial/deploy-om-container.txt

@@ -46,7 +46,7 @@ To deploy an |onprem| resource you must:
         --from-literal=Username="<username>"
         --from-literal=Password="<password>"  
         --from-literal=FirstName="<firstname>" 
-        --from-literal=LastName="<lastname>>"
+        --from-literal=LastName="<lastname>"
         -n <namespace>
 
 Considerations