Skip to content

Commit e9eea25

Browse files
lmkerbey-mdbjwilliams-mongo
lmkerbey-mdb
authored and
jwilliams-mongo
committed
(DOCSP-32503) Update Affinity Rules documentation. (#1516)
* (DOCSP-32503) Resolving naming conflict. * (DOCSP-32503) Adding back yaml files for option generation. * (DOCSP-32503) * (DOCSP-32503) * (DOCSP-32503) * (DOCSP-32503) * (DOCSP-32503) * (DOCSP-32503) * (DOCSP-32503) * (DOCSP-32503) * (DOCSP-32503) * (DOCSP-32503) * (DOCSP-32503) * Empty commit to test build. * (DOCSP-32503) * (DOCSP-32503) * Empty commit for build testing. * Empty commit for build testing. * (DOCSP-32503) * (DOCSP-32503) Ensure all affinity settings are explicitly included. If they are not, they will not be parsed properly and references via the setting directive will fail. * (DOCSP-32503) Tech review. * (DOCSP-32503) Copy review, part 1 * (DOCSP-32503) Copy review, part 2 * (DOCSP-32503) Copy review. * (DOCSP-32503) Copy review, Part 4
1 parent ee00485 commit e9eea25

File tree

46 files changed

+414
-282
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+414
-282
lines changed

‎snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ jira = "`Jira <https://jira.mongodb.org>`__"
101101
json = ":abbr:`JSON (Javascript Object Notation)`"
102102
jedec = ":abbr:`JEDEC (Joint Electron Device Engineering Council Solid State Technology Association)`"
103103
jvm = ":abbr:`JVM (Java Virtual Machine)`"
104-
k8s-affinity = "`Affinity and Anti-Affinity <https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#more-practical-use-cases>`__"
104+
k8s-affinity = "`Affinity and Anti-Affinity <https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity>`__"
105105
k8s-headless-service = "`Headless Service <https://kubernetes.io/docs/concepts/services-networking/service/#headless-services>`__"
106106
k8s-cr = "`ClusterRole <https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole>`__"
107107
k8s-crb = "`ClusterRoleBinding <https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding>`__"

‎source/includes/setting-k8sRsConf-spec.podSpec.nodeAffinity.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎source/includes/setting-k8sRsConf-spec.podSpec.podAntiAffinityTopologyKey.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎source/includes/setting-k8sRsConf-spec.podSpec.podTemplate.affinity.nodeAffinity.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. setting:: spec.podSpec.podTemplate.affinity.nodeAffinity
2+
3+
*Type*: Struct
4+
5+
|k8s| |k8s-rule| to place |k8s-pods| for :term:`replica set` on a
6+
specific range of |k8s-nodes|.
7+
8+
For optimized read-write performance, use node affinity rules that
9+
restrict |k8s-pods| to run on particular |k8s-nodes|, or to prefer
10+
to run on particular |k8s-nodes|.

‎source/includes/setting-k8sRsConf-spec.podSpec.podAffinity.rst renamed to ‎source/includes/setting-k8sRsConf-spec.podSpec.podTemplate.affinity.podAffinity.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. setting:: spec.podSpec.podAffinity
1+
.. setting:: spec.podSpec.podTemplate.affinity.podAffinity
22

33
*Type*: Struct
44

55
|k8s| |k8s-rule| to determine whether multiple |k8s-mdbrsc| |k8s-pods|
66
must be co-located with other |k8s-pods|. To learn more about the use cases,
7-
see ||k8s-affinity| in the |k8s| documentation.
7+
see |k8s-affinity| in the |k8s| documentation.
88

99

‎source/includes/setting-k8sRsConf-spec.podSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. setting:: spec.podSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
2+
3+
*Type*: string
4+
5+
*Default*: kubernetes.io/hostname
6+
7+
8+
This key defines which
9+
:k8sdocs:`label <concepts/overview/working-with-objects/labels/>`
10+
is used to determine which topology
11+
:k8sdocs:`domain <concepts/scheduling-eviction/topology-spread-constraints/>`
12+
a node belongs to.
13+

‎source/includes/setting-k8sRsConf-spec.podSpec.podTemplate.affinity.podAntiAffinity.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. setting:: spec.podSpec.podTemplate.affinity.podAntiAffinity
2+
3+
*Type*: string
4+
5+
*Default*: ``""``
6+
7+
8+
Sets a |k8s-rule| to spread |k8s-pods| hosting |k8s-mdbrsc|
9+
to different locations. A location can be a single node, rack, or
10+
region. By default, |k8s-op-short| tries to spread pods across
11+
different nodes.

‎source/includes/setting-k8sRsConf-spec.podSpec.podTemplate.affinity.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. setting:: spec.podSpec.podTemplate.affinity
2+
3+
*Type*: string
4+
5+
*Default*: kubernetes.io/hostname
6+
7+
Allows you to specify |k8s-rules| to determine the distribution of
8+
|k8s-pods| in relation to each other or to |k8s-nodes|.
9+
10+

‎source/includes/setting-k8sSaConf-spec.podSpec.nodeAffinity.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎source/includes/setting-k8sSaConf-spec.podSpec.podTemplate.affinity.nodeAffinity.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. setting:: spec.podSpec.podTemplate.affinity.nodeAffinity
2+
3+
*Type*: Struct
4+
5+
|k8s| |k8s-rule| to place |k8s-pods| for :term:`replica set` on a
6+
specific range of |k8s-nodes|.
7+
8+
For optimized read-write performance, use node affinity rules that
9+
restrict |k8s-pods| to run on particular |k8s-nodes|, or to prefer
10+
to run on particular |k8s-nodes|.

‎source/includes/setting-k8sSaConf-spec.podSpec.podAffinity.rst renamed to ‎source/includes/setting-k8sSaConf-spec.podSpec.podTemplate.affinity.podAffinity.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. setting:: spec.podSpec.podAffinity
1+
.. setting:: spec.podSpec.podTemplate.affinity.podAffinity
22

33
*Type*: Struct
44

55
|k8s| |k8s-rule| to determine whether multiple |k8s-mdbrsc| |k8s-pods|
66
must be co-located with other |k8s-pods|. To learn more about the use cases,
7-
see ||k8s-affinity| in the |k8s| documentation.
7+
see |k8s-affinity| in the |k8s| documentation.
88

99

‎source/includes/setting-k8sSaConf-spec.podSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. setting:: spec.podSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
2+
3+
*Type*: Struct
4+
5+
*Default*: kubernetes.io/hostname
6+
7+
8+
This key defines which
9+
:k8sdocs:`label <concepts/overview/working-with-objects/labels/>`
10+
is used to determine which topology
11+
:k8sdocs:`domain <concepts/scheduling-eviction/topology-spread-constraints/>`
12+
a node belongs to.
13+

‎source/includes/setting-k8sSaConf-spec.podSpec.podTemplate.affinity.podAntiAffinity.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. setting:: spec.podSpec.podTemplate.affinity.podAntiAffinity
2+
3+
*Type*: Struct
4+
5+
*Default*: kubernetes.io/hostname
6+
7+
8+
Sets a |k8s-rule| to spread |k8s-pods| hosting |k8s-mdbrsc|
9+
to different locations. A location can be a single node, rack, or
10+
region. By default, |k8s-op-short| tries to spread pods across
11+
different nodes.

‎source/includes/setting-k8sSaConf-spec.podSpec.podTemplate.affinity.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. setting:: spec.podSpec.podTemplate.affinity
2+
3+
*Type*: Struct
4+
5+
Allows you to specify |k8s-rules| to determine the distribution of
6+
|k8s-pods| in relation to each other or to |k8s-nodes|.
7+
8+

‎source/includes/setting-k8sScConf-spec.configSrvPodSpec.nodeAffinity.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎source/includes/setting-k8sScConf-spec.configSrvPodSpec.podAntiAffinityTopologyKey.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎source/includes/setting-k8sScConf-spec.configSrvPodSpec.podTemplate.affinity.nodeAffinity.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. setting:: spec.configSrvPodSpec.podTemplate.affinity.nodeAffinity
2+
3+
*Type*: collection
4+
5+
|k8s| |k8s-rule| to place |k8s-pods| for :term:`replica set` on a
6+
specific range of |k8s-nodes|.
7+
8+
For optimized read-write performance, use node affinity rules that
9+
restrict |k8s-pods| to run on particular |k8s-nodes|, or to prefer
10+
to run on particular |k8s-nodes|.

‎source/includes/setting-k8sScConf-spec.configSrvPodSpec.podAffinity.rst renamed to ‎source/includes/setting-k8sScConf-spec.configSrvPodSpec.podTemplate.affinity.podAffinity.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. setting:: spec.configSrvPodSpec.podAffinity
1+
.. setting:: spec.configSrvPodSpec.podTemplate.affinity.podAffinity
22

33
*Type*: collection
44

55
|k8s| |k8s-rule| to determine whether multiple |k8s-mdbrsc| |k8s-pods|
66
must be co-located with other |k8s-pods|. To learn more about the use cases,
7-
see ||k8s-affinity| in the |k8s| documentation.
7+
see |k8s-affinity| in the |k8s| documentation.
88

99

‎source/includes/setting-k8sScConf-spec.configSrvPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. setting:: spec.configSrvPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
2+
3+
*Type*: string
4+
5+
*Default*: kubernetes.io/hostname
6+
7+
8+
This key defines which
9+
:k8sdocs:`label <concepts/overview/working-with-objects/labels/>`
10+
is used to determine which topology
11+
:k8sdocs:`domain <concepts/scheduling-eviction/topology-spread-constraints/>`
12+
a node belongs to.

‎source/includes/setting-k8sScConf-spec.configSrvPodSpec.podTemplate.affinity.podAntiAffinity.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. setting:: spec.configSrvPodSpec.podTemplate.affinity.podAntiAffinity
2+
3+
*Type*: string
4+
5+
*Default*: kubernetes.io/hostname
6+
7+
8+
Sets a |k8s-rule| to spread |k8s-pods| hosting |k8s-mdbrsc|
9+
to different locations. A location can be a single node, rack, or
10+
region. By default, |k8s-op-short| tries to spread pods across
11+
different nodes.
12+

‎source/includes/setting-k8sScConf-spec.configSrvPodSpec.podTemplate.affinity.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. setting:: spec.configSrvPodSpec.podTemplate.affinity
2+
3+
*Type*: string
4+
5+
Allows you to specify |k8s-rules| to determine the distribution of
6+
|k8s-pods| in relation to each other or to |k8s-nodes|.
7+
8+

‎source/includes/setting-k8sScConf-spec.mongosPodSpec.nodeAffinity.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎source/includes/setting-k8sScConf-spec.mongosPodSpec.podAntiAffinityTopologyKey.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎source/includes/setting-k8sScConf-spec.mongosPodSpec.podTemplate.affinity.nodeAffinity.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. setting:: spec.mongosPodSpec.podTemplate.affinity.nodeAffinity
2+
3+
*Type*: collection
4+
5+
|k8s| |k8s-rule| to place |k8s-pods| for :term:`replica set` on a
6+
specific range of |k8s-nodes|.
7+
8+
For optimized read-write performance, use node affinity rules that
9+
restrict |k8s-pods| to run on particular |k8s-nodes|, or to prefer
10+
to run on particular |k8s-nodes|.

‎source/includes/setting-k8sScConf-spec.mongosPodSpec.podAffinity.rst renamed to ‎source/includes/setting-k8sScConf-spec.mongosPodSpec.podTemplate.affinity.podAffinity.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. setting:: spec.mongosPodSpec.podAffinity
1+
.. setting:: spec.mongosPodSpec.podTemplate.affinity.podAffinity
22

33
*Type*: collection
44

‎source/includes/setting-k8sScConf-spec.mongosPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. setting:: spec.mongosPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
2+
3+
*Type*: string
4+
5+
*Default*: kubernetes.io/hostname
6+
7+
8+
This key defines which
9+
:k8sdocs:`label <concepts/overview/working-with-objects/labels/>`
10+
is used to determine which topology
11+
:k8sdocs:`domain <concepts/scheduling-eviction/topology-spread-constraints/>`
12+
a node belongs to.
13+

‎source/includes/setting-k8sScConf-spec.mongosPodSpec.podTemplate.affinity.podAntiAffinity.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. setting:: spec.mongosPodSpec.podTemplate.affinity.podAntiAffinity
2+
3+
*Type*: string
4+
5+
*Default*: kubernetes.io/hostname
6+
7+
8+
Sets a |k8s-rule| to spread |k8s-pods| hosting |k8s-mdbrsc|
9+
to different locations. A location can be a single node, rack, or
10+
region. By default, |k8s-op-short| tries to spread pods across
11+
different nodes.
12+

‎source/includes/setting-k8sScConf-spec.mongosPodSpec.podTemplate.affinity.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. setting:: spec.mongosPodSpec.podTemplate.affinity
2+
3+
*Type*: string
4+
5+
Allows you to specify |k8s-rules| to determine the distribution of
6+
|k8s-pods| in relation to each other or to |k8s-nodes|.
7+
8+

‎source/includes/setting-k8sScConf-spec.shardPodSpec.nodeAffinity.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎source/includes/setting-k8sScConf-spec.shardPodSpec.podAntiAffinityTopologyKey.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎source/includes/setting-k8sScConf-spec.shardPodSpec.podTemplate.affinity.nodeAffinity.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. setting:: spec.shardPodSpec.podTemplate.affinity.nodeAffinity
2+
3+
*Type*: string
4+
5+
|k8s| |k8s-rule| to place |k8s-pods| for :term:`replica set` on a
6+
specific range of |k8s-nodes|.
7+
8+
For optimized read-write performance, use node affinity rules that
9+
restrict |k8s-pods| to run on particular |k8s-nodes|, or to prefer
10+
to run on particular |k8s-nodes|.

‎source/includes/setting-k8sScConf-spec.shardSpecificPodSpec.podAffinity.rst renamed to ‎source/includes/setting-k8sScConf-spec.shardPodSpec.podTemplate.affinity.podAffinity.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. setting:: spec.shardSpecificPodSpec.podAffinity
1+
.. setting:: spec.shardPodSpec.podTemplate.affinity.podAffinity
22

33
*Type*: string
44

55
|k8s| |k8s-rule| to determine whether multiple |k8s-mdbrsc| |k8s-pods|
66
must be co-located with other |k8s-pods|. To learn more about the use cases,
7-
see ||k8s-affinity| in the |k8s| documentation.
7+
see |k8s-affinity| in the |k8s| documentation.
88

99

0 commit comments

Comments
 (0)