Skip to content

Commit 713272b

Browse files
lmkerbey-mdbjwilliams-mongo
authored andcommitted
(DOCSP-26682) Add HeadDB guidance to K8S Backup page (#1220)
* (DOCSP-26682) * (DOCSP-26682) * (DOCSP-26682) * (DOCSP-26682) * (DOCSP-26682) Typo fix. * (DOCSP-26682)
1 parent 8e723ba commit 713272b

File tree

2 files changed

+41
-48
lines changed

2 files changed

+41
-48
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,16 @@ content: |
200200
for the head database, oplog store, and snapshot store.
201201
- ``true``
202202
203+
* - | ``spec``
204+
| ``.backup``
205+
| ``.headDB``
206+
- collection
207+
- A collection of configuration settings for the
208+
:term:`head database`. For descriptions of the individual
209+
settings in the collection, see
210+
:opsmgrkube:`spec.backup.headDB`.
211+
-
212+
203213
* - | ``spec``
204214
| ``.backup``
205215
| ``.opLogStores``

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

Lines changed: 31 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ optional: true
335335
ref: configure-backup-https
336336
content: |
337337
338-
If you want to enable backup for your |onprem| instance, you must
338+
If you want to enable Backup for your |onprem| instance, you must
339339
configure all of the following settings:
340340
341341
.. list-table::
@@ -351,11 +351,21 @@ content: |
351351
| ``.backup``
352352
| ``.``:opsmgrkube:`~spec.backup.enabled`
353353
- boolean
354-
- Flag that indicates that backup is enabled. You must specify
355-
``spec.backup.enabled: true`` to configure settings for the head
356-
database, oplog store, and snapshot store.
354+
- Flag that indicates that Backup is enabled. You must
355+
specify ``spec.backup.enabled: true`` to configure settings
356+
for the head database, oplog store, and snapshot store.
357357
- ``true``
358358
359+
* - | ``spec``
360+
| ``.backup``
361+
| ``.headDB``
362+
- collection
363+
- A collection of configuration settings for the
364+
:term:`head database`. For descriptions of the individual
365+
settings in the collection, see
366+
:opsmgrkube:`spec.backup.headDB`.
367+
-
368+
359369
* - | ``spec``
360370
| ``.backup``
361371
| ``.opLogStores``
@@ -419,9 +429,9 @@ content: |
419429
| ``.s3Stores``
420430
| ``.``:opsmgrkube:`~spec.backup.s3Stores.s3BucketEndpoint`
421431
- string
422-
- |url| of the |s3| or |s3|-compatible bucket where
432+
- |url| of the |s3| or |s3|-compatible bucket that
423433
:opsmgr:`stores </tutorial/manage-s3-blockstore-storage>` the
424-
database backup snapshots.
434+
database Backup snapshots.
425435
- ``s3.us-east-1.amazonaws.com``
426436
427437
* - | ``spec``
@@ -430,19 +440,8 @@ content: |
430440
| ``.``:opsmgrkube:`~spec.backup.s3Stores.s3BucketName`
431441
- string
432442
- Name of the |s3| or |s3|-compatible bucket that stores the
433-
database backup snapshots.
434-
- ``my-bucket``
435-
436-
* - | ``spec``
437-
| ``.backup``
438-
| ``.s3Stores``
439-
| ``.``:opsmgrkube:`~spec.backup.s3Stores.s3RegionOverride`
440-
- string
441-
- Region where your |s3|-compatible bucket resides. Use this
442-
field only if your |s3| store's
443-
:opsmgrkube:`s3BucketEndpoint <spec.backup.s3Stores.s3BucketEndpoint>`
444-
doesn't include a region in its |url|. Don't use this field with |aws| |s3| buckets.
445-
- ``us-east-1``
443+
database Backup snapshots.
444+
- my-bucket
446445
447446
To configure a blockstore, configure the following settings:
448447
@@ -474,25 +473,9 @@ content: |
474473
namespace as the |onprem| resource.
475474
- ``my-mongodb-blockstore``
476475
477-
---
478-
title: "Configure any additional settings for an |onprem| backup."
479-
stepnum: 8
480-
level: 4
481-
optional: true
482-
ref: add-k8s-optional-values-backups-https
483-
content: |
484-
485-
Add any :ref:`optional settings <optional-om-k8s-settings>` for backups
486-
that you want to apply to your deployment to the |k8s-obj| specification
487-
file. For example, for each type of backup store, and for |onprem| backup
488-
daemon processes, you can assign labels to associate particular backup
489-
stores or backup daemon processes with specific projects.
490-
Use ``spec.backup.[*].assignmentLabels`` elements of the OpsManager
491-
resources.
492-
493476
---
494477
title: "Configure any additional settings for an |onprem| deployment."
495-
stepnum: 9
478+
stepnum: 8
496479
level: 4
497480
optional: true
498481
ref: add-k8s-values
@@ -502,13 +485,13 @@ content: |
502485
want to apply to your deployment to the |k8s-obj| specification file.
503486
---
504487
title: "Save this file with a ``.yaml`` file extension."
505-
stepnum: 10
488+
stepnum: 9
506489
level: 4
507490
ref: save-object-spec
508491

509492
---
510493
title: "Create your |onprem| instance."
511-
stepnum: 11
494+
stepnum: 10
512495
level: 4
513496
ref: start-k8s-instance
514497
content: |
@@ -526,7 +509,7 @@ content: |
526509
527510
---
528511
title: "Track the status of your |onprem| instance."
529-
stepnum: 12
512+
stepnum: 11
530513
level: 4
531514
ref: track-k8s-instance
532515
content: |
@@ -567,7 +550,7 @@ content: |
567550
568551
After the |onprem| resource completes the ``Reconciling`` phase, the
569552
command returns the following output under the ``status`` field if you
570-
enabled backup:
553+
enabled Backup:
571554
572555
.. code-block:: yaml
573556
:copyable: false
@@ -591,7 +574,7 @@ content: |
591574
url: https://om-svc.cloudqa.svc.cluster.local:8443
592575
version: "6.0.17"
593576
594-
Backup remains in a ``Pending`` state until you configure the backup
577+
Backup remains in a ``Pending`` state until you configure the Backup
595578
databases.
596579
597580
.. tip::
@@ -621,7 +604,7 @@ content: |
621604
url: https://om-svc.dev.svc.cluster.local:8443
622605
version: ""
623606
624-
Backup remains in a ``Pending`` state until you configure the backup
607+
Backup remains in a ``Pending`` state until you configure the Backup
625608
databases.
626609
627610
.. tip::
@@ -633,7 +616,7 @@ content: |
633616
634617
---
635618
title: "Access the |onprem| application."
636-
stepnum: 13
619+
stepnum: 12
637620
level: 4
638621
ref: access-opsmgr-instance
639622
content: |
@@ -688,7 +671,7 @@ content: |
688671
689672
---
690673
title: "Create credentials for the Kubernetes Operator."
691-
stepnum: 14
674+
stepnum: 13
692675
level: 4
693676
ref: create-credentials
694677
content: |
@@ -700,7 +683,7 @@ content: |
700683
701684
---
702685
title: "Create a project using a |k8s-configmap|."
703-
stepnum: 15
686+
stepnum: 14
704687
level: 4
705688
ref: create-project
706689
content: |
@@ -752,8 +735,8 @@ content: |
752735
``mms-ca.crt``.
753736
754737
---
755-
title: "Deploy MongoDB database resources to complete the backup configuration."
756-
stepnum: 16
738+
title: "Deploy MongoDB database resources to complete the Backup configuration."
739+
stepnum: 15
757740
level: 4
758741
ref: configure-backup
759742
content: |
@@ -789,7 +772,7 @@ content: |
789772
790773
---
791774
title: "Confirm that the |onprem| resource is running."
792-
stepnum: 17
775+
stepnum: 16
793776
level: 4
794777
ref: confirm-running
795778
content: |

0 commit comments

Comments
 (0)