Skip to content

Commit 5bf901b

Browse files
authored
Added spec.backup.members (#645)
* Added spec.backup.members * Included tech review from Nik * Replaced refs to OM /rapid releases, added one more link, fixed a typo * Final link cleanup
1 parent 2136668 commit 5bf901b

File tree

4 files changed

+58
-36
lines changed

4 files changed

+58
-36
lines changed

config/intersphinx.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,5 @@ path: biconnector.inv
2121
name: opsmanager
2222
url: https://docs.opsmanager.mongodb.com/current/
2323
path: objects.inv
24-
---
25-
name: opsmanagerrapid
26-
url: https://docs.opsmanager.mongodb.com/rapid/
27-
path: opsmgrrapid.inv
24+
2825
...
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
.. admonition:: Highly Available Ops Manager Resources
22
:class: note
33

4-
For high availability, set this value to more than ``1``. Multiple
5-
|onprem| instances can read from the same Application
6-
Database, ensuring failover if one instance is unavailable and
7-
enabling you to update the |onprem| resource without downtime.
4+
For high availability, set this value to more than ``1``.
5+
:opsmgr:`Multiple Ops Manager instances
6+
</tutorial/configure-application-high-availability/#multiple-application-servers>`
7+
can read from the same Application Database, ensuring failover if
8+
one instance is unavailable and enabling you to update the
9+
|onprem| resource without downtime.

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

Lines changed: 50 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,9 @@ resources.
6666

6767
.. opsmgrkube:: spec.replicas
6868

69-
*Type*: number
69+
*Type*: integer
7070

7171
*Required*. Number of |onprem| instances to run in parallel.
72-
7372
The minimum accepted value is ``1``.
7473

7574
.. include:: /includes/admonitions/note-highly-available-om.rst
@@ -286,6 +285,17 @@ Optional |onprem| Resource Settings
286285
backup service based on the container's memory. Changing the
287286
``-Xms`` and ``-Xmx`` values can cause issues with |onprem|.
288287

288+
.. opsmgrkube:: spec.backup.members
289+
290+
*Type*: integer
291+
292+
*Optional*. Number of :opsmgr:`backup daemon services
293+
</core/system-overview/#backup-daemon-service>`
294+
to deploy in |k8s|. If not specified, defaults to ``1``.
295+
To ensure high availability for your backup service, deploy
296+
:opsmgr:`multiple backup daemons </tutorial/configure-backup-high-availability/#multiple-backup-daemons>`
297+
in |onprem|.
298+
289299
.. opsmgrkube:: spec.backup.opLogStores
290300

291301
*Type*: collection
@@ -407,20 +417,22 @@ Optional |onprem| Resource Settings
407417
*Type*: collection
408418

409419
Specification for the |k8s-statefulset| that the |k8s-op| creates
410-
for the :ref:`backup-daemon`.
420+
for the :opsmgr:`backup daemon service
421+
</core/system-overview/#backup-daemon-service>`.
411422

412423
To review which fields you can add to
413424
:opsmgrkube:`spec.backup.statefulSet.spec`, see the
414425
:k8sdocs:`Kubernetes documentation
415-
</reference/generated/kubernetes-api/v1.16/#statefulsetspec-v1-apps>`.
426+
</reference/generated/kubernetes-api/v1.21/#statefulsetspec-v1-apps>`.
416427

417428
.. opsmgrkube:: spec.backup.statefulSet.spec.template
418429

419430
*Type*: collection
420431

421432
:k8sdocs:`Template </concepts/workloads/pods/pod-overview/#pod-templates>`
422433
for the |k8s| pods in the |k8s-statefulset| that the |k8s-op| creates
423-
for the :ref:`backup-daemon`.
434+
for the :opsmgr:`backup daemon service
435+
</core/system-overview/#backup-daemon-service>`.
424436

425437
.. note::
426438

@@ -432,28 +444,31 @@ Optional |onprem| Resource Settings
432444
*Type*: collection
433445

434446
Metadata for the |k8s| pods in the |k8s-statefulset| that the
435-
|k8s-op| creates for the :ref:`backup-daemon`.
447+
|k8s-op| creates for the :opsmgr:`backup daemon service
448+
</core/system-overview/#backup-daemon-service>`.
436449

437450
To review which fields you can add to
438451
:opsmgrkube:`spec.backup.statefulSet.spec.template.metadata`, see
439452
the :k8sdocs:`Kubernetes documentation
440-
</reference/generated/kubernetes-api/v1.16/#objectmeta-v1-meta>`.
453+
</reference/generated/kubernetes-api/v1.21/#objectmeta-v1-meta>`.
441454

442455
.. opsmgrkube:: spec.backup.statefulSet.spec.template.spec
443456

444457
*Type*: collection
445458

446459
Specifications of the |k8s| pods in the |k8s-statefulset| that the
447-
|k8s-op| creates for the :ref:`backup-daemon`.
460+
|k8s-op| creates for the :opsmgr:`backup daemon service
461+
</core/system-overview/#backup-daemon-service>`.
448462

449463
To review the complete list of fields you can add to
450464
:opsmgrkube:`spec.backup.statefulSet.spec.template.spec`, see the
451465
:k8sdocs:`Kubernetes documentation
452-
</reference/generated/kubernetes-api/v1.16/#podspec-v1-core>`.
466+
</reference/generated/kubernetes-api/v1.21/#podspec-v1-core>`.
453467

454468
The following example ``spec.backup.statefulSet.spec.template.spec``
455469
defines minimum and maximum CPU and memory capacity for one
456-
:ref:`backup-daemon` container the |k8s-op| deploys:
470+
:opsmgr:`backup daemon service
471+
</core/system-overview/#backup-daemon-service>` container the |k8s-op| deploys:
457472

458473
.. code-block:: yaml
459474

@@ -478,9 +493,11 @@ Optional |onprem| Resource Settings
478493

479494
List of containers that belong to the |k8s| pods in the
480495
|k8s-statefulset| that the |k8s-op| creates for the
481-
:ref:`backup-daemon`.
496+
:opsmgr:`backup daemon service
497+
</current/core/system-overview/#backup-daemon-service>`.
482498

483-
To modify the specifications of the :ref:`backup-daemon` container,
499+
To modify the specifications of the :opsmgr:`backup daemon service
500+
</current/core/system-overview/#backup-daemon-service>` container,
484501
you must provide the exact name of the container using the ``name``
485502
field, as shown in the following example:
486503

@@ -506,7 +523,8 @@ Optional |onprem| Resource Settings
506523
*Type*: string
507524

508525
Minimum CPU capacity that must be available on a |k8s| |k8s-node| to
509-
host the :ref:`backup-daemon`.
526+
host the :opsmgr:`backup daemon service
527+
</current/core/system-overview/#backup-daemon-service>`.
510528

511529
The requested value must be less than or equal to
512530
:opsmgrkube:`spec.backup.statefulSet.spec.template.spec.containers.resources.limits.cpu`.
@@ -516,16 +534,20 @@ Optional |onprem| Resource Settings
516534
*Type*: string
517535

518536
Maximum CPU capacity for the |k8s-node| being created to host
519-
the :ref:`backup-daemon`. If omitted, this value is set to
537+
the :opsmgr:`backup daemon service
538+
</current/core/system-overview/#backup-daemon-service>`.
539+
If omitted, this value is set to
520540
:opsmgrkube:`spec.backup.statefulSet.spec.template.spec.containers.resources.requests.cpu`.
521541

522542
.. opsmgrkube:: spec.backup.statefulSet.spec.template.spec.containers.resources.requests.memory
523543

524544
*Type*: string
525545

526546
Minimum memory capacity that must be available on a |k8s| |k8s-node|
527-
to host the :ref:`backup-daemon` on |k8s|. This value is expressed as
528-
an integer followed by a unit of memory in |jedec| notation.
547+
to host the :opsmgr:`backup daemon service
548+
</current/core/system-overview/#backup-daemon-service>` on |k8s|.
549+
This value is expressed as an integer followed by a unit of memory
550+
in |jedec| notation.
529551

530552
.. note::
531553

@@ -540,8 +562,9 @@ Optional |onprem| Resource Settings
540562
*Type*: string
541563

542564
Maximum memory capacity for the |k8s-node| being created to host
543-
the :ref:`backup-daemon`. If omitted, this value is set to
544-
:opsmgrkube:`spec.backup.statefulSet.spec.template.spec.containers.resources.requests.memory`.
565+
the :opsmgr:`backup daemon service
566+
</current/core/system-overview/#backup-daemon-service>`. If omitted,
567+
this value is set to :opsmgrkube:`spec.backup.statefulSet.spec.template.spec.containers.resources.requests.memory`.
545568

546569
The |k8s-op-short| calculates and sets parameters for Java heap size
547570
based on the container's memory.
@@ -596,7 +619,7 @@ Optional |onprem| Resource Settings
596619
.. note::
597620

598621
If you deploy |onprem| 4.2, you must specify a MongoDB version
599-
earlier than than 4.0 in the :ref:`resource definition
622+
earlier than 4.0 in the :ref:`resource definition
600623
<k8s-specification>` for the database that stores the metadata for
601624
the |s3| snapshot store.
602625

@@ -633,11 +656,11 @@ Optional |onprem| Resource Settings
633656
*Required if you enable Backup using an S3 store.*
634657

635658
Name of the secret that contains the ``accessKey`` and
636-
``secretKey`` fields. The :ref:`backup-daemon` uses the values
637-
of these fields as credentials to access your
638-
|aws| |s3| or |s3|-compatible bucket. The |s3|
639-
snapshot store can't be configured if the secret is missimg either
640-
key.
659+
``secretKey`` fields. The :opsmgr:`backup daemon service
660+
</current/core/system-overview/#backup-daemon-service>` uses
661+
the values of these fields as credentials to access your
662+
|aws| |s3| or |s3|-compatible bucket. The |s3| snapshot store
663+
can't be configured if the secret is missing either key.
641664

642665
.. opsmgrkube:: spec.backup.s3Stores.pathStyleAccessEnabled
643666

@@ -884,7 +907,7 @@ Optional |onprem| Resource Settings
884907
To review which fields you can add to
885908
:opsmgrkube:`spec.statefulSet.spec`, see the
886909
:k8sdocs:`Kubernetes documentation
887-
</reference/generated/kubernetes-api/v1.16/#statefulsetspec-v1-apps>`.
910+
</reference/generated/kubernetes-api/v1.21/#statefulsetspec-v1-apps>`.
888911

889912
.. opsmgrkube:: spec.statefulSet.spec.template
890913

@@ -909,7 +932,7 @@ Optional |onprem| Resource Settings
909932
To review which fields you can add to
910933
:opsmgrkube:`spec.statefulSet.spec.template.metadata`, see
911934
the :k8sdocs:`Kubernetes documentation
912-
</reference/generated/kubernetes-api/v1.16/#objectmeta-v1-meta>`.
935+
</reference/generated/kubernetes-api/v1.21/#objectmeta-v1-meta>`.
913936

914937
.. opsmgrkube:: spec.statefulSet.spec.template.spec
915938

@@ -921,7 +944,7 @@ Optional |onprem| Resource Settings
921944
To review the complete list of fields you can add to
922945
:opsmgrkube:`spec.statefulSet.spec.template.spec`, see the
923946
:k8sdocs:`Kubernetes documentation
924-
</reference/generated/kubernetes-api/v1.16/#podspec-v1-core>`.
947+
</reference/generated/kubernetes-api/v1.21/#podspec-v1-core>`.
925948

926949
The following example ``spec.statefulSet.spec.template.spec`` defines
927950
minimum and maximum CPU and memory capacity for one |onprem|

source/tutorial/create-operator-credentials.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To create credentials for the |k8s-op-short|, you must:
4949

5050
#. Add the |ipaddr| or |cidr| block of any hosts that serve the
5151
|k8s-op-short| to the
52-
:ref:`API Whitelist <configure-access-to-whitelisted-ops>`.
52+
:opsmgr:`API Whitelist </tutorial/configure-public-api-access/>`.
5353

5454
.. _create-k8s-secret-procedure:
5555

0 commit comments

Comments
 (0)