Skip to content

Commit 4071177

Browse files
authored
Prod notes: added sizings and updated examples (#520)
* Prod notes: added sizings and updated examples * Initial comments from Raj * Include copy review comments from Melissa * Address final copy review comments, ready for tech review * Address tech review, part1 * Final minor changes for tech review * Final copy and tech review
1 parent e1c096a commit 4071177

File tree

6 files changed

+464
-237
lines changed

6 files changed

+464
-237
lines changed

conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@
5959
source_constants = {
6060
'version': version,
6161
'k8s-op-short': 'Kubernetes Operator',
62+
'k8s-api-version': 'v1.20',
6263
'aagent': 'MongoDB Agent or legacy Automation Agent',
6364
'aagents': 'MongoDB Agents or legacy Automation Agents',
6465
'mdbagent': 'MongoDB Agent',

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ name = "k8s-operator"
44
aagent = "MongoDB Agent or legacy Automation Agent"
55
aagents = "MongoDB Agents or legacy Automation Agents"
66
k8s-op-short = "Kubernetes Operator"
7+
k8s-api-version = "v1.20"
78
bndl-version = "4.2.2"
89
bndl-version-val = "``4.2.11-ent``"
910
appdb-init-version = "1.0.6"

source/includes/options-k8s-shared.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ description: |
240240
|k8s-node| to host {{component}}.
241241
242242
This value maps to the
243-
:k8sdocs:`limits field </reference/generated/kubernetes-api/v1.10/#resourcerequirements-v1-core>`
243+
:k8sdocs:`limits field </reference/generated/kubernetes-api/{+k8s-api-version+}/#resourcerequirements-v1-core>`
244244
for CPU for the created pod.
245245
246246
@@ -261,7 +261,7 @@ description: |
261261
{{cpuLimit}}.
262262
263263
This value maps to the
264-
:k8sdocs:`requests field </reference/generated/kubernetes-api/v1.11/#resourcerequirements-v1-core>`
264+
:k8sdocs:`requests field </reference/generated/kubernetes-api/{+k8s-api-version+}/#resourcerequirements-v1-core>`
265265
for CPU for the created pod.
266266
267267
The requested value must be less than or equal to {{cpuLimit}}.
@@ -298,7 +298,7 @@ description: |
298298
this value to ``4Gi``.
299299
300300
This value maps to the
301-
:k8sdocs:`limits field </reference/generated/kubernetes-api/v1.10/#resourcerequirements-v1-core>`
301+
:k8sdocs:`limits field </reference/generated/kubernetes-api/{+k8s-api-version+}/#resourcerequirements-v1-core>`
302302
for memory for the created pod.
303303
304304
{{memoryWarning}}
@@ -321,7 +321,7 @@ description: |
321321
{{memoryLimit}}.
322322
323323
This value maps to the
324-
:k8sdocs:`requests field </reference/generated/kubernetes-api/v1.10/#resourcerequirements-v1-core>`
324+
:k8sdocs:`requests field </reference/generated/kubernetes-api/{+k8s-api-version+}/#resourcerequirements-v1-core>`
325325
for memory for the created pod.
326326
327327
The requested value must be less than or equal to {{memoryLimit}}.
@@ -1220,7 +1220,7 @@ description: |
12201220
{{component}}.
12211221
12221222
To review which fields you can add to {{podTemplate_metadata}}, see
1223-
the :k8sdocs:`Kubernetes documentation </reference/generated/kubernetes-api/v1.11/#objectmeta-v1-meta>`.
1223+
the :k8sdocs:`Kubernetes documentation </reference/generated/kubernetes-api/{+k8s-api-version+}/#objectmeta-v1-meta>`.
12241224
12251225
---
12261226
program: _shared
@@ -1234,7 +1234,7 @@ description: |
12341234
{{component}}.
12351235
12361236
To review which fields you can add to {{podTemplate_spec}}, see the
1237-
:k8sdocs:`Kubernetes documentation </reference/generated/kubernetes-api/v1.11/#podspec-v1-core>`.
1237+
:k8sdocs:`Kubernetes PodSpec v1 core API </reference/generated/kubernetes-api/{+k8s-api-version+}/#podspec-v1-core>`.
12381238
12391239
.. note::
12401240

source/index.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,6 @@ optimal performance.
5555
/tutorial/modify-resource-image
5656
/reference
5757
Release Notes </release-notes>
58+
Production Notes </reference/production-notes>
5859
Known Issues </reference/known-issues>
5960
MongoDB Community Kubernetes Operator <https://github.com/mongodb/mongodb-kubernetes-operator>

0 commit comments

Comments
 (0)