Skip to content

Commit c1f7026

Browse files
kyuan-mongodbjwilliams-mongo
kyuan-mongodb
authored and
jwilliams-mongo
committed
DOCSP-43004 meko nested components (#1846)
1 parent b96c8d0 commit c1f7026

File tree

40 files changed

+168
-300
lines changed

40 files changed

+168
-300
lines changed

‎source/includes/admonitions/data-url-config-map-external-dbs.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,4 @@
77
:opsmgrkube:`spec.configuration.mms.centralUrl <spec.configuration>`
88
setting in the |onprem| resource specification.
99

10-
.. seealso::
11-
12-
:ref:`mdb-resource-deployment-locations`
10+
To learn more, see :ref:`mdb-resource-deployment-locations`.

‎source/includes/admonitions/k8s-persistent-volumes-om.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
.. warning::
2-
3-
Grant your containers permission to write to your |k8s-pv|.
4-
The |k8s-op-short| sets ``fsGroup = 2000``, ``runAsUser = 2000``,
5-
and ``runAsNonRoot = true`` in ``securityContext``. |k8s-op-short|
6-
sets ``fsgroup`` equal to ``runAsUser`` to make the volume writable
7-
for a user that runs the main process in the container. To learn
8-
more, see :k8sdocs:`Configure a
9-
Security Context for a Pod or Container
10-
</tasks/configure-pod-container/security-context/>` and the related
11-
:k8sdocs:`discussion
12-
</tasks/configure-pod-container/security-context/#discussion>` in
13-
the |k8s| documentation. If redeploying the resource doesn't fix
14-
issues with your Persistent Volume, contact |mdb-support|.
1+
:red:`WARNING:` Grant your containers permission to write to your |k8s-pv|.
2+
The |k8s-op-short| sets ``fsGroup = 2000``, ``runAsUser = 2000``,
3+
and ``runAsNonRoot = true`` in ``securityContext``. |k8s-op-short|
4+
sets ``fsgroup`` equal to ``runAsUser`` to make the volume writable
5+
for a user that runs the main process in the container. To learn
6+
more, see :k8sdocs:`Configure a
7+
Security Context for a Pod or Container
8+
</tasks/configure-pod-container/security-context/>` and the related
9+
:k8sdocs:`discussion
10+
</tasks/configure-pod-container/security-context/#discussion>` in
11+
the |k8s| documentation. If redeploying the resource doesn't fix
12+
issues with your Persistent Volume, contact |mdb-support|.

‎source/includes/admonitions/k8s-persistent-volumes.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
.. include:: /includes/admonitions/k8s-persistent-volumes-om.rst
22

3-
.. note::
4-
5-
If you do not use |k8s-pvs|, the :guilabel:`Disk Usage` and
6-
:guilabel:`Disk IOPS` charts cannot be displayed in either the
7-
:guilabel:`Processes` tab on the :guilabel:`Deployment` page or in
8-
the :guilabel:`Metrics` page when
9-
:opsmgr:`reviewing the data </tutorial/view-diagnostics>` for this
10-
deployment.
3+
If you do not use |k8s-pvs|, the :guilabel:`Disk Usage` and
4+
:guilabel:`Disk IOPS` charts cannot be displayed in either the
5+
:guilabel:`Processes` tab on the :guilabel:`Deployment` page or in
6+
the :guilabel:`Metrics` page when
7+
:opsmgr:`reviewing the data </tutorial/view-diagnostics>` for this
8+
deployment.

‎source/includes/admonitions/mms-centralurl-external-mdb.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,4 @@
77
Set the value to the URL by which |onprem| is exposed outside of the
88
|k8s| cluster.
99

10-
.. seealso::
11-
12-
:ref:`mdb-resource-deployment-locations`
10+
To learn more, see :ref:`mdb-resource-deployment-locations`.

‎source/includes/admonitions/note-namespace-match-configmap.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
1-
.. note::
2-
3-
This value must exist on the *same* namespace as the resource
4-
you want to create.
1+
This value must exist on the *same* namespace as the resource
2+
you want to create.

‎source/includes/fact-example-secret-prefix-cluster-file.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
.. example::
2-
3-
If you call your deployment ``my-deployment`` and you set the
4-
prefix to ``mdb``, you must name the |tls| secret for the
5-
client |tls| communications ``mdb-my-deployment-cert``. Also,
6-
you must name the |tls| secret for internal cluster authentication
7-
(if enabled) ``mdb-my-deployment-clusterfile``.
1+
For example, if you call your deployment ``my-deployment`` and you set
2+
the prefix to ``mdb``, you must name the |tls| secret for the
3+
client |tls| communications ``mdb-my-deployment-cert``. Also,
4+
you must name the |tls| secret for internal cluster authentication
5+
(if enabled) ``mdb-my-deployment-clusterfile``.

‎source/includes/facts/fact-external-domain-spec.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,8 @@ connections still use the hostname with the external domain:
2525
- The {+mdbagent+} to connect to |mongod|.
2626
- |mongod| to connect to other |mongod| instances.
2727

28-
.. warning::
29-
30-
Specifying this field changes how |onprem| registers |mongod| processes.
31-
You can specify this field only for new replica set deployments starting in |k8s-op-short|
32-
version 1.19. You can't change the value of this field or any ``processes[n].hostname`` fields
33-
in the |onprem| :opsmgr:`automation configuration </reference/cluster-configuration>` for a running
34-
replica set deployment.
28+
:red:`WARNING:` Specifying this field changes how |onprem| registers |mongod| processes.
29+
You can specify this field only for new replica set deployments starting in |k8s-op-short|
30+
version 1.19. You can't change the value of this field or any ``processes[n].hostname`` fields
31+
in the |onprem| :opsmgr:`automation configuration </reference/cluster-configuration>` for a running
32+
replica set deployment.

‎source/includes/list-tables/annotation-placeholders-multi-cluster.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,12 @@ annotations in each service for a specific Pod.
3636
:ref:`spec.clusterSpecList.clusterName
3737
<multi-spec-agent-clusterspeclist-clustername>`.
3838

39-
.. note::
40-
41-
This value might not reflect the order of the member clusters
42-
defined in :ref:`spec.clusterSpecList <multi-spec-clusterspeclist>`.
43-
Although you can change the order of
44-
member clusters in :ref:`spec.clusterSpecList <multi-spec-clusterspeclist>`,
45-
the |k8s-op-short| still uses the index that it initially assigned
46-
for the current cluster name.
39+
This value might not reflect the order of the member clusters
40+
defined in :ref:`spec.clusterSpecList <multi-spec-clusterspeclist>`.
41+
Although you can change the order of
42+
member clusters in :ref:`spec.clusterSpecList <multi-spec-clusterspeclist>`,
43+
the |k8s-op-short| still uses the index that it initially assigned
44+
for the current cluster name.
4745

4846
* - ``{statefulSetName}``
4947
- The |k8s-statefulset|. Equal to ``{resourceName}-{clusterIndex}``.

‎source/includes/list-tables/configmap-keys-curl.rst

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,11 @@
1313

1414
.. include:: /includes/fact-resource-name-char-limit.rst
1515

16-
.. seealso::
17-
18-
- |k8s| documentation on `names <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/>`__.
19-
This name must follow :rfc:`RFC1123 <1123>` naming
20-
conventions, using only lowercase alphanumeric
21-
characters, ``-`` or ``.``, and must start and end with an
22-
alphanumeric character.
16+
To learn more, see |k8s| documentation on `names <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/>`__.
17+
This name must follow :rfc:`RFC1123 <1123>` naming
18+
conventions, using only lowercase alphanumeric
19+
characters, ``-`` or ``.``, and must start and end with an
20+
alphanumeric character.
2321

2422
- ``my-project``
2523

@@ -64,11 +62,9 @@
6462

6563
.. include:: /includes/steps/find-org-id.rst
6664

67-
.. note::
68-
69-
You must have the :opsmgr:`Organization Project Creator </reference/user-roles/#Organization Project Creator>`
70-
role to create a new project within an existing
71-
|com| organization.
65+
You must have the :opsmgr:`Organization Project Creator </reference/user-roles/#Organization Project Creator>`
66+
role to create a new project within an existing
67+
|com| organization.
7268

7369
If you provide an empty string as your ``orgId``, |k8s-op-short|
7470
creates an organization with the same name as your project.
@@ -82,9 +78,7 @@
8278

8379
.. include:: /includes/admonitions/data-url-config-map-external-dbs.rst
8480

85-
.. note::
86-
87-
If you're using |cloud-short|, set the ``data.baseUrl`` value
88-
to ``https://cloud.mongodb.com``.
81+
If you're using |cloud-short|, set the ``data.baseUrl`` value
82+
to ``https://cloud.mongodb.com``.
8983

9084
- ``https://ops.example.com:8443``

‎source/includes/list-tables/configmap-keys.rst

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,12 @@
1313

1414
.. include:: /includes/fact-resource-name-char-limit.rst
1515

16-
.. seealso::
17-
18-
- :setting:`metadata.name`
19-
- |k8s| documentation on `names <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/>`__.
20-
This name must follow :rfc:`RFC1123 <1123>` naming
21-
conventions, using only lowercase alphanumeric
22-
characters, '-' or '.', and must start and end with an
23-
alphanumeric character.
16+
To learn more, see :setting:`metadata.name`, and
17+
|k8s| documentation on `names <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/>`__.
18+
This name must follow :rfc:`RFC1123 <1123>` naming
19+
conventions, using only lowercase alphanumeric
20+
characters, '-' or '.', and must start and end with an
21+
alphanumeric character.
2422

2523
- ``myconfigmap``
2624

@@ -82,9 +80,7 @@
8280

8381
.. include:: /includes/admonitions/data-url-config-map-external-dbs.rst
8482

85-
.. note::
86-
87-
If you're using |cloud-short|, set the ``data.baseUrl`` value
88-
to ``https://cloud.mongodb.com``.
83+
If you're using |cloud-short|, set the ``data.baseUrl`` value
84+
to ``https://cloud.mongodb.com``.
8985

9086
- ``https://ops.example.com:8443``

‎source/includes/list-tables/configure-acme-based-certs.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@
2727
- Optional
2828
- .. include:: /includes/facts/fact-external-service-annotation-spec.rst
2929

30-
.. note::
31-
32-
You can specify placeholder values to customize your annotations.
33-
To learn more, see :setting:`spec.externalAccess.externalService.annotations
34-
<spec.externalAccess.externalService.annotations>`.
30+
You can specify placeholder values to customize your annotations.
31+
To learn more, see :setting:`spec.externalAccess.externalService.annotations
32+
<spec.externalAccess.externalService.annotations>`.

‎source/includes/list-tables/resource-keys-split-horizons.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,17 @@
2121

2222
You may add multiple external mappings per host.
2323

24-
.. note:: Split Horizon Requirements
24+
Split Horizon Requirements
2525

26-
- Make sure that each value in this array is unique.
26+
- Make sure that each value in this array is unique.
2727

28-
- Make sure that the number of entries in this array matches
29-
the value given in :setting:`spec.members`.
28+
- Make sure that the number of entries in this array matches
29+
the value given in :setting:`spec.members`.
3030

31-
- Provide a value for the
32-
:setting:`spec.security.certsSecretPrefix` setting to
33-
enable |tls|. This method to use split horizons requires the
34-
Server Name Indication extension of the |tls| protocol.
31+
- Provide a value for the
32+
:setting:`spec.security.certsSecretPrefix` setting to
33+
enable |tls|. This method to use split horizons requires the
34+
Server Name Indication extension of the |tls| protocol.
3535
- :setting:`See Setting<spec.connectivity.replicaSetHorizons>`
3636

3737
* - | ``spec.security``

‎source/includes/list-tables/rs-resource-base-options.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@
1313

1414
.. include:: /includes/fact-resource-name-char-limit.rst
1515

16-
.. seealso::
17-
18-
- :setting:`metadata.name`
19-
- Kubernetes documentation on
20-
:k8sdocs:`names </concepts/overview/working-with-objects/names/>`.
16+
To learn more, see :setting:`metadata.name` and
17+
Kubernetes documentation on
18+
:k8sdocs:`names </concepts/overview/working-with-objects/names/>`.
2119

2220
- ``myproject``
2321

‎source/includes/setting-k8sRsConf-spec.connectivity.replicaSetHorizons.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@
99

1010
You may add multiple external mappings per host.
1111

12-
.. note:: Split Horizon Requirements
12+
Split Horizon Requirements:
1313

14-
- Make sure that each value in this array is unique.
14+
- Make sure that each value in this array is unique.
1515

16-
- Make sure that the number of entries in this array matches the
17-
value given in :setting:`spec.members`.
16+
- Make sure that the number of entries in this array matches the
17+
value given in :setting:`spec.members`.
1818

19-
- Provide a value for the
20-
:setting:`spec.security.certsSecretPrefix` setting to
21-
enable |tls|. This method to use split horizons requires the
22-
Server Name Indication extension of the |tls| protocol.
19+
- Provide a value for the
20+
:setting:`spec.security.certsSecretPrefix` setting to
21+
enable |tls|. This method to use split horizons requires the
22+
Server Name Indication extension of the |tls| protocol.
2323

24-
- :ref:`Configure the routing for external hostnames <connect-from-outside-k8s>`.
24+
- :ref:`Configure the routing for external hostnames <connect-from-outside-k8s>`.
2525

2626
.. example::
2727

‎source/includes/setting-k8sRsConf-spec.podSpec.persistence.multiple.data.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,14 @@
3535

3636
Default value is 16Gi.
3737

38-
.. example::
39-
40-
If this |k8s-mdbrsc| requires 60 gigabytes of storage
41-
space, set this value to ``60Gi``.
38+
For example, if this |k8s-mdbrsc| requires 60 gigabytes of storage
39+
space, set this value to ``60Gi``.
4240

4341
* - ``storageClass``
4442
- string
4543
- Type of storage needed for :manual:`sharded cluster </reference/glossary/#std-term-sharded-cluster>` shard member. You may create
4644
this storage type as a |k8s-sc| object before using it in this
4745
|k8s-obj| specification.
4846

49-
.. note::
50-
51-
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
47+
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
5248

‎source/includes/setting-k8sRsConf-spec.podSpec.persistence.multiple.journal.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,14 @@
3535

3636
Default value is 1Gi.
3737

38-
.. example::
39-
40-
If this |k8s-mdbrsc| requires 60 gigabytes of storage
41-
space, set this value to ``60Gi``.
38+
For example, if this |k8s-mdbrsc| requires 60 gigabytes of storage
39+
space, set this value to ``60Gi``.
4240

4341
* - ``storageClass``
4442
- string
4543
- Type of storage needed for :manual:`sharded cluster </reference/glossary/#std-term-sharded-cluster>` shard member. You may create
4644
this storage type as a |k8s-sc| object before using it in this
4745
|k8s-obj| specification.
4846

49-
.. note::
50-
51-
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
47+
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
5248

‎source/includes/setting-k8sRsConf-spec.podSpec.persistence.multiple.logs.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,14 @@
3535

3636
Default value is 3Gi.
3737

38-
.. example::
39-
40-
If this |k8s-mdbrsc| requires 60 gigabytes of storage
41-
space, set this value to ``60Gi``.
38+
For example, if this |k8s-mdbrsc| requires 60 gigabytes of storage
39+
space, set this value to ``60Gi``.
4240

4341
* - ``storageClass``
4442
- string
4543
- Type of storage needed for :manual:`sharded cluster </reference/glossary/#std-term-sharded-cluster>` shard member. You may create
4644
this storage type as a |k8s-sc| object before using it in this
4745
|k8s-obj| specification.
4846

49-
.. note::
50-
51-
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
47+
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
5248

‎source/includes/setting-k8sRsConf-spec.podSpec.persistence.single.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,15 @@
3535

3636
Default value is 16Gi.
3737

38-
.. example::
39-
40-
If :manual:`replica set </reference/glossary/#std-term-replica-set>` in requires 60 gigabytes of
41-
storage space, set this value to ``60Gi``.
38+
For example, if :manual:`replica set
39+
</reference/glossary/#std-term-replica-set>` in requires 60
40+
gigabytes of storage space, set this value to ``60Gi``.
4241

4342
* - ``storageClass``
4443
- string
4544
- Type of storage specified in a |k8s-pvc|. You may create
4645
this storage type as a |k8s-sc| object before using it in this
4746
|k8s-obj| specification.
4847

49-
.. note::
50-
51-
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
48+
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
5249

‎source/includes/setting-k8sSaConf-spec.podSpec.persistence.multiple.data.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,14 @@
3535

3636
Default value is 16Gi.
3737

38-
.. example::
39-
40-
If this |k8s-mdbrsc| requires 60 gigabytes of storage
41-
space, set this value to ``60Gi``.
38+
For example, if this |k8s-mdbrsc| requires 60 gigabytes of storage
39+
space, set this value to ``60Gi``.
4240

4341
* - ``storageClass``
4442
- string
4543
- Type of storage needed for :term:`standalone deployment <standalone>`. You may create
4644
this storage type as a |k8s-sc| object before using it in this
4745
|k8s-obj| specification.
4846

49-
.. note::
50-
51-
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
47+
.. include:: /includes/admonitions/fact-reclaimpolicy-to-retain.rst
5248

0 commit comments

Comments
 (0)