Skip to content

Commit 85ed15e

Browse files
Anthony Sansonejwilliams-mongo
authored andcommitted
(DOCSP-7375): Updates to k8s Spec language.
1 parent 09f21f9 commit 85ed15e

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

source/reference/k8s-operator-specification.txt

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _k8s-specification:
22

3-
==================================
4-
MongoDB |k8s| Object Specification
5-
==================================
3+
====================================
4+
MongoDB |k8s| Resource Specification
5+
====================================
66

77
.. default-domain:: mongodb
88

@@ -14,17 +14,18 @@ MongoDB |k8s| Object Specification
1414

1515
.. include:: /includes/note-k8s-supported-in-om4.rst
1616

17-
The `MongoDB Enterprise Kubernetes Operator <https://github.com/mongodb/mongodb-enterprise-kubernetes>`__
17+
The :gh:`MongoDB Enterprise Kubernetes Operator </mongodb/mongodb-enterprise-kubernetes>`
1818
creates |k8s| |k8s-statefulsets| from specification files that you
1919
wrote.
2020

21-
MongoDB resources are created in Kubernetes as `custom resources <https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/>`__.
22-
After you create or update a MongoDB resource specification, you direct
21+
MongoDB resources are created in Kubernetes as
22+
:k8sdocs:`custom resources </concepts/extend-kubernetes/api-extension/custom-resources/>`.
23+
After you create or update a |k8s-mdbrsc| specification, you direct
2324
|k8s-op-full| to apply this specification to your |k8s| environment.
2425
|k8s-op-short| creates the defined |k8s-statefulsets|, services and
2526
other Kubernetes resources. After the Operator finishes creating those
26-
objects, it updates Ops Manager deployment configuration to reflect
27-
changes.
27+
objects, it updates the |onprem-link| deployment configuration to
28+
reflect changes.
2829

2930
.. list-table::
3031
:widths: 20 40 40
@@ -37,19 +38,19 @@ changes.
3738

3839
* - Standalone
3940
- 1
40-
- 1 per member
41+
- 1 |k8s-pod|
4142

4243
* - Replica Set
4344
- 1
44-
- 1 per member
45+
- 1 |k8s-pod| per member
4546

4647
* - Sharded Cluster
47-
- 1
48-
- 1 per shard or config server member
48+
- <numberOfShards> + 2
49+
- 1 |k8s-pod| per |mongos|, shard, or config server member
4950

50-
Each |k8s-obj| uses an |k8s-obj| specification in
51-
:abbr:`YAML (Yet Another Markup Language)` to define the characteristics and settings of the MongoDB object: standalone, :term:`replica set`,
52-
and :term:`sharded cluster`.
51+
Each |k8s-mdbrsc| uses an object specification in |yaml| to define the
52+
characteristics and settings of the MongoDB object: standalone,
53+
:term:`replica set`, and :term:`sharded cluster`.
5354

5455
Common Resource Settings
5556
------------------------

0 commit comments

Comments
 (0)