(DOCSP-13276) Enable programmatic backups via CRD YAML file configuration (#433)

JuliaMongo · web-flow · commit 76aa00828cf4 · 2020-12-23T08:59:03.000-05:00
* (DOCSP-13276) Enable programmatic backups via CRD YAML file configuration * (DOCSP-13276) Continuous backup options in CRD, added copy review from JW * (DOCSP-13276) continuous backup in CRD: tech review first pass
diff --git a/source/includes/options-k8s-replica-set.yaml b/source/includes/options-k8s-replica-set.yaml
@@ -115,6 +115,26 @@ replacement:
 
 ---
 program: k8sRsConf
+name: spec.backup.mode
+type: string
+directive: setting
+optional: true
+inherit:
+  name: spec.backup.mode
+  program: _shared
+  file: options-k8s-shared.yaml
+---
+program: k8sRsConf
+name: spec.backup
+type: collection
+directive: setting
+optional: true
+inherit:
+  name: spec.backup
+  program: _shared
+  file: options-k8s-shared.yaml
+---
+program: k8sRsConf
 name: spec.persistent
 type: boolean
 directive: setting
diff --git a/source/includes/options-k8s-shared.yaml b/source/includes/options-k8s-shared.yaml
@@ -91,8 +91,8 @@ description: |
   Name of |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 to create their custom services and lets the Operator reuse
-  them.
+  users to create their custom services and lets the |k8s-op-short|
+  reuse them.
 
 ---
 program: _shared
@@ -103,7 +103,7 @@ optional: true
 default: cluster.local
 description: |
 
-  Domain name of the |k8s| cluster where you deploy the Operator. When
+  Domain name of the |k8s| cluster where you deploy the |k8s-op-short|. When
   |k8s| creates a |k8s-statefulset|, the |k8s| assigns each |k8s-pod| a
   |fqdn|. To update |com|, the |k8s-op-short| calculates the |fqdn| for
   each |k8s-pod| using a provided cluster name. |k8s| doesn't provide
@@ -126,13 +126,44 @@ pre: |
      Use :setting:`spec.clusterDomain` instead.
 description: |
 
-  Domain name of the |k8s| cluster where you deploy the Operator. When
-  |k8s| creates a |k8s-statefulset|, the |k8s| assigns each |k8s-pod| a
-  |fqdn|. To update |com|, the |k8s-op-short| calculates the |fqdn| for
+  Domain name of the |k8s| cluster where you deploy the |k8s-op-short|.
+  When |k8s| creates a |k8s-statefulset|, the |k8s| assigns each |k8s-pod|
+  a |fqdn|. To update |com|, the |k8s-op-short| calculates the |fqdn| for
   each |k8s-pod| using a provided cluster name. |k8s| doesn't provide
   an |api| to query these hostnames.
 
   .. include:: /includes/admonitions/warning-set-cluster-name.rst
+---
+program: _shared
+name: spec.backup.mode
+type: string
+directive: setting
+description: |
+  
+  Enables continuous backups for a MongoDB resource.
+  Possible values are :code:`ENABLED`, :code:`DISABLED`, and
+  :code:`TERMINATED`.
+  
+  .. note::
+     The :code:`spec.backup.mode`
+     setting relies on :ref:`Backup <om-rsrc-backup>` that is
+     enabled in the |onprem| and requires that
+     :opsmgrkube:`spec.backup.enabled`
+     value in the |onprem| :ref:`resource specification
+     <k8s-om-specification>` is set to :code:`true`.
+  
+  After you enable continuous backups for your MongoDB resource  with
+  :code:`spec.backup.mode`, you can :ref:`check the backup status <get-resource-status>`.
+
+---
+program: _shared
+name: spec.backup
+type: collection
+directive: setting
+description: |
+
+  The collection container for :setting:`spec.backup.mode`,
+  which enables continuous backups for MongoDB resources in |k8s-op-short|.
 
 ---
 program: _shared
@@ -350,7 +381,7 @@ description: |
   .. seealso::
 
      The |k8s| documentation for use cases on
-     `affinity and anti-affinity <https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#more-practical-use-cases>`__
+     `affinity and anti-affinity <https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#more-practical-use-cases>`__.
 
 ---
 program: _shared
diff --git a/source/includes/options-k8s-standalone.yaml b/source/includes/options-k8s-standalone.yaml
@@ -121,8 +121,8 @@ inherit:
   name: spec.clusterName
   program: _shared
   file: options-k8s-shared.yaml
-
 ---
+
 program: k8sSaConf
 name: spec.opsManager.configMapRef.name
 type: string
diff --git a/source/includes/steps-source-deploy-k8s-resource.yaml b/source/includes/steps-source-deploy-k8s-resource.yaml
@@ -151,6 +151,7 @@ content: |
   |k8s-obj| specification file for a {{k8sResource}} deployment:
 
   - :setting:`spec.additionalMongodConfig`
+  - :setting:`spec.backup.mode`
   - :setting:`spec.clusterDomain`
   - :setting:`spec.featureCompatibilityVersion`
   - :setting:`spec.logLevel`
@@ -176,13 +177,13 @@ content: |
   |k8s-obj| specification file for a :term:`sharded cluster`
   deployment:
 
+  - :setting:`spec.backup.mode`
   - :setting:`spec.clusterDomain`
   - :setting:`spec.exposedExternally`
   - :setting:`spec.logLevel`
   - :setting:`spec.featureCompatibilityVersion`
   - :setting:`spec.connectivity.replicaSetHorizons`
 
-
   .. include:: /includes/admonitions/warning-set-cluster-name.rst
 
   **For config server**
diff --git a/source/reference/k8s-operator-specification.txt b/source/reference/k8s-operator-specification.txt
@@ -83,10 +83,10 @@ Optional
 
 Every resource type may use the following settings:
 
-.. include:: /includes/option/setting-k8sSaConf-metadata.namespace.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.featureCompatibilityVersion.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.clusterDomain.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.clusterName.rst
+.. include:: /includes/option/setting-k8sSaConf-metadata.namespace.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.service.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.logLevel.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.security.authentication.ignoreUnknownUsers.rst
@@ -141,19 +141,27 @@ Replica Set Settings
    All of the :ref:`standalone-settings` also apply to replica set
    resources.
 
-The following settings only apply to replica set resource types:
+The following settings apply only to replica set resource types:
 
+.. include:: /includes/option/setting-k8sRsConf-spec.backup.rst
+.. include:: /includes/option/setting-k8sRsConf-spec.backup.mode.rst
+.. include:: /includes/option/setting-k8sSaConf-spec.clusterDomain.rst
+.. include:: /includes/option/setting-k8sSaConf-spec.clusterName.rst
+.. include:: /includes/option/setting-k8sRsConf-spec.connectivity.replicaSetHorizons.rst
+.. include:: /includes/option/setting-k8sSaConf-spec.featureCompatibilityVersion.rst
 .. include:: /includes/option/setting-k8sRsConf-spec.members.rst
 .. include:: /includes/option/setting-k8sRsConf-spec.podSpec.podAntiAffinityTopologyKey.rst
-.. include:: /includes/option/setting-k8sRsConf-spec.connectivity.replicaSetHorizons.rst
+
 
 .. _sharded-cluster-settings:
 
 Sharded Cluster Settings
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-The following settings only apply to sharded cluster resource types:
+The following settings apply only to sharded cluster resource types:
 
+.. include:: /includes/option/setting-k8sRsConf-spec.backup.rst
+.. include:: /includes/option/setting-k8sRsConf-spec.backup.mode.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.exposedExternally.rst
 .. include:: /includes/option/setting-k8sScConf-spec.configServerCount.rst
 .. include:: /includes/option/setting-k8sScConf-spec.configSrv.additionalMongodConfig.rst
@@ -213,9 +221,10 @@ The following settings only apply to sharded cluster resource types:
 Security Settings
 -----------------
 
-The following security settings only apply to replica set and sharded
+The following security settings apply only to replica set and sharded
 cluster resource types:
 
+
 .. include:: /includes/option/setting-k8sRsConf-spec.security.tls.enabled.rst
 .. include:: /includes/option/setting-k8sRsConf-spec.security.tls.ca.rst
 .. include:: /includes/option/setting-k8sRsConf-spec.security.tls.additionalCertificateDomains.rst
diff --git a/source/reference/troubleshooting.txt b/source/reference/troubleshooting.txt
@@ -109,14 +109,20 @@ The following key-value pairs describe the resource deployment statuses:
    * - ``link``
      - Deployment |url| in |mms|.
 
+   * - ``backup.statusName``
+     - If you enabled continuous backups with :setting:`spec.backup.mode`
+       in |k8s| for your MongoDB resource, this field indicates
+       the status of the backup, such as ``backup.statusName:"STARTED"``.
+       Possible values are ``STARTED``, ``STOPPED``, and ``TERMINATED``.
+
    * - Resource specific fields
      - For descriptions of these fields, see
        :doc:`/reference/k8s-operator-specification`.
 
 .. example::
 
-   If you want to see what the status of a replica set named
-   ``my-replica-set`` in the ``developer`` namespace, run:
+   To see the status of a replica set named ``my-replica-set`` in
+   the ``developer`` namespace, run:
 
    .. code-block:: sh
 
@@ -192,8 +198,7 @@ invoke this command:
 
 .. example::
 
-   If your :term:`replica set` is labeled ``myrs``, the |k8s-pod| log
-   command is invoked as:
+   If your :term:`replica set` is labeled ``myrs``, run:
 
    .. code-block:: sh
 
@@ -214,7 +219,7 @@ To view all |k8s-mdbrsc| specifications in the provided
 
 .. example::
 
-   To read details about the ``dublin`` standalone resource, invoke
+   To read details about the ``dublin`` standalone resource, run
    this command:
 
    .. code-block:: shell
@@ -279,7 +284,7 @@ those pods.
       my-replica-set-2     0/1 Pending 0 2h
 
    ``my-replica-set-2`` is stuck in the ``Pending`` stage. To gather
-   more data on the error, run the following:
+   more data on the error, run:
 
    .. code-block:: sh
       :copyable: false
@@ -289,7 +294,9 @@ those pods.
 
       <describe output omitted>
 
-      Warning FailedScheduling 15s (x3691 over 3h) default-scheduler 0/3 nodes are available: 1 node(s) had taints that the pod didn't tolerate, 2 Insufficient memory.
+      Warning FailedScheduling 15s (x3691 over 3h) default-scheduler
+      0/3 nodes are available: 1 node(s) had taints that the pod
+      didn't tolerate, 2 Insufficient memory.
 
    The output indicates an error in memory allocation.
 
@@ -321,14 +328,18 @@ those pods.
 Replace a ConfigMap to Reflect Changes
 ---------------------------------------
 
-If you are unable to modify or redeploy an already-deployed configMap file using the *kubectl apply* command, invoke the following:
+If you cannot modify or redeploy an already-deployed resource
+:file:`ConfigMap` file using the *kubectl apply* command, run:
 
 .. code-block:: shell
 
       kubectl replace -f <my-config-map>.yaml
 
-This will delete and re-create a resource. This command is useful in cases where you need to update resource files that cannot be updated
-once initialized or want to make an immediate recursive change.
+This deletes and re-creates the :file:`ConfigMap` resource file.
+
+This command is useful in cases where you want to make an immediate
+recursive change, or you need to update resource files that cannot
+be updated once initialized.
 
 Remove |k8s| Components
 -----------------------
