DOCSP-4683 - One CRD deployment, troubleshooting, and reference changes. (#18)

* (DOCSP-4683): Change to One CRD.

* (DOCSP-4683): Jon's updates.

* DOCSP-4683 - Copy and tech review edits.

Author: jdestefano-mongo

conf.py

@@ -55,6 +55,10 @@
 release = conf.version.release
 pygments_style = 'sphinx'
 
+source_constants = {
+    'version': version
+}
+
 rst_epilog = '\n'.join([
     '.. |branch| replace:: ``{0}``'.format(conf.git.branches.current),
     '.. |copy| unicode:: U+000A9',

source/includes/check-resource-status.rst

@@ -0,0 +1,12 @@
+To check the status of your |k8s-mdbrsc|, invoke the following 
+command:
+
+.. code-block:: sh
+   
+   kubectl get mdb <resource-name> -n <namespace> -o yaml -w
+
+The ``-w`` flag means "watch". With the "watch" flag set, the output
+refreshes immediately when something changes until the status phase
+achieves the ``Running`` state.
+
+If the deployment fails, see :doc:`/reference/troubleshooting`.

source/includes/options-k8s-shared.yaml

@@ -14,11 +14,7 @@ type: string
 directive: setting
 optional: false
 description: |
-  *Required.* Type of |k8s-mdbrsc| to create. Accepted values are:
-
-  - ``MongoDbStandalone``
-  - ``MongoDbReplicaSet``
-  - ``MongoDbShardedCluster``
+  *Required.* Kind of |k8s-mdbrsc| to create. Set this to ``MongoDB``
 
 ---
 program: _shared
@@ -39,6 +35,20 @@ description: |
   *Required.* |k8s| |k8s-ns| where this |k8s-mdbrsc| and other
   |k8s-objs| are created.
 
+---
+program: _shared
+name: spec.type
+type: string
+directive: setting
+optional: false
+description: |
+  *Required.* Type of |k8s-mdbrsc| to create. Accepted values
+  are:
+
+  - ``Standalone``
+  - ``ReplicaSet``
+  - ``ShardedCluster``
+
 ---
 program: _shared
 name: spec.version

source/includes/options-k8s-standalone.yaml

@@ -42,6 +42,17 @@ inherit:
   program: _shared
   file: options-k8s-shared.yaml
 
+---
+program: k8sSaConf
+name: spec.type
+type: string
+directive: setting
+optional: false
+inherit:
+  name: spec.type
+  program: _shared
+  file: options-k8s-shared.yaml
+
 ---
 program: k8sSaConf
 name: spec.version

source/includes/steps-deploy-k8s-replica-set.yaml

@@ -6,15 +6,13 @@ ref: copy-k8s-example
 content: |
 
    This is a |yaml| file that you can modify to meet your desired
-   configuration. The highlighted lines should be changed for your
-   replica set configuration.
+   configuration. Change the highlighted settings to match your desired
+   :term:`replica set` configuration.
 
    .. literalinclude:: /reference/k8s/example-replica-set-minimal.yaml
       :language: yaml
-      :emphasize-lines: 5-7,9-14
+      :emphasize-lines: 5-7,9-13
 
-   Change the highlighted settings to match your desired
-   :term:`replica set` deployment.
 ---
 title: "Open your preferred text editor and paste the |k8s-obj| specification into a new text file."
 stepnum: 2
@@ -109,6 +107,12 @@ content: |
         - ``<mycredentials>`` or
           ``<namespace>/<mycredentials>``
 
+      * - :setting:`spec.type`
+        - string
+        - Type of |k8s-mdbrsc| to create.
+
+        - ``ReplicaSet``
+
       * - :setting:`spec.version`
         - string
         - Version of MongoDB that this :term:`replica set` should run.
@@ -203,17 +207,6 @@ level: 4
 ref: track-k8s-deployment
 content: |
 
-  To check the status of your |k8s-mdbrsc|, invoke the following
-  command:
-
-  .. code-block:: sh
-     
-     kubectl get mrs <rs-name> -n <namespace> -o yaml -w
-
-  The ``-w`` flag means "watch". The output refreshes immediately if
-  something changes until the status phase achieves the ``Running``
-  state.
-
-  If the deployment fails, see :doc:`/reference/troubleshooting`.
+  .. include:: /includes/check-resource-status.rst
 
 ...

source/includes/steps-deploy-k8s-sharded-cluster.yaml

@@ -6,15 +6,13 @@ ref: copy-k8s-example
 content: |
 
    This is a |yaml| file that you can modify to meet your desired
-   configuration. The highlighted lines should be changed for your
-   sharded cluster configuration.
+   configuration. Change the highlighted settings to match your desired
+   :term:`sharded cluster` configuration.
 
    .. literalinclude:: /reference/k8s/example-sharded-cluster-minimal.yaml
       :language: yaml
-      :emphasize-lines: 5-7,9-17
+      :emphasize-lines: 5-7,9-16
 
-   You will need to change the highlighted settings to match your 
-   desired :term:`sharded cluster` deployment.
 ---
 title: "Open your preferred text editor and paste the |k8s-obj| specification into a new text file."
 stepnum: 2
@@ -140,6 +138,12 @@ content: |
         - ``<mycredentials>`` or
           ``<namespace>/<mycredentials>``
 
+      * - :setting:`spec.type`
+        - string
+        - Type of |k8s-mdbrsc| to create.
+
+        - ``ShardedCluster``
+
       * - :setting:`spec.persistent`
         - string
         - *Optional.*
@@ -261,17 +265,6 @@ level: 4
 ref: track-k8s-deployment
 content: |
 
-  To check the status of your |k8s-mdbrsc|, invoke the following
-  command:
-
-  .. code-block:: sh
-     
-     kubectl get msc <sc-name> -n <namespace> -o yaml -w
-
-  The ``-w`` flag means "watch". The output refreshes immediately if
-  something changes until the status phase achieves the ``Running``
-  state.
-
-  If the deployment fails, see :doc:`/reference/troubleshooting`.
+  .. include:: /includes/check-resource-status.rst
 
 ...

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

@@ -6,15 +6,13 @@ ref: copy-k8s-example
 content: |
 
    This is a |yaml| file that you can modify to meet your desired
-   configuration. The highlighted lines should be changed for your
+   configuration. Change the highlighted settings to match your desired
    standalone configuration.
 
    .. literalinclude:: /reference/k8s/example-standalone-minimal.yaml
       :language: yaml
       :emphasize-lines: 5-7,9-12
 
-   You will need to change the highlighted settings to match your
-   desired Standalone deployment.
 ---
 title: "Open your preferred text editor and paste the |k8s-obj| specification into a new text file."
 stepnum: 2
@@ -109,6 +107,12 @@ content: |
         - ``<mycredentials>`` or
           ``<namespace>/<mycredentials>``
 
+      * - :setting:`spec.type`
+        - string
+        - Type of |k8s-mdbrsc| to create.
+
+        - ``Standalone``
+
       * - :setting:`spec.version`
         - string
         - Version of MongoDB that is installed on this
@@ -193,18 +197,6 @@ level: 4
 ref: track-k8s-deployment
 content: |
 
-  To check the status of your |k8s-mdbrsc|, invoke the following 
-  command:
-
-  .. code-block:: sh
-     
-     kubectl get mst <standlone-name> -n <namespace> -o yaml -w
-
-  The ``-w`` flag means "watch". The output refreshes immediately if
-  something changes until the status phase achieves the ``Running``
-  state.
-
-  If the deployment fails, see :doc:`/reference/troubleshooting`.
-
+    .. include:: /includes/check-resource-status.rst
 
 ...

source/reference/k8s-operator-specification.txt

@@ -66,6 +66,7 @@ Required
 .. include:: /includes/option/setting-k8sSaConf-spec.credentials.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.persistent.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.project.rst
+.. include:: /includes/option/setting-k8sSaConf-spec.type.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.version.rst
 
 Optional

source/reference/k8s/example-replica-set-minimal.yaml

@@ -1,15 +1,16 @@
 ---
 apiVersion: mongodb.com/v1
-kind: MongoDbReplicaSet
+kind: MongoDB
 metadata:
   name: <myreplicaset>
   namespace: <metadata.namespace> # Should match metadata.namespace in
                                   # your configmap file.
 spec:
   members: 3
-  version: 3.6.7
+  version: 4.0.6
   project: <myconfigmap> # Should match metadata.name in your
                          # configmap file.
   credentials: <mycredentials>
+  type: ReplicaSet
   persistent: true
 ...

source/reference/k8s/example-sharded-cluster-minimal.yaml

@@ -1,6 +1,6 @@
 ---
 apiVersion: mongodb.com/v1
-kind: MongoDbShardedCluster
+kind: MongoDB
 metadata:
   name: <myshardedcluster>
   namespace: <metadata.namespace> # Should match metadata.namespace in
@@ -10,9 +10,10 @@ spec:
   mongodsPerShardCount: 3
   mongosCount: 2
   configServerCount: 3
-  version: 3.6.7
+  version: 4.0.6
   project: <myconfigmap> # Should match metadata.name in your
                          # configmap file.
   credentials: <mycredentials>
+  type: ShardedCluster
   persistent: true
 ...