Skip to content

Commit df466f0

Browse files
(DOCSP-11103)(DOCSP-11104): enterprise kubernetes doc improvements (#318)
* (DOCSP-11103): checkpoint * (DOCSP-11103), (DOCSP-11104): k8s doc enhancements * (DOCSP-11103), (DOCSP-11104): small structural tweak * (DOCSP-11103): tech review feedback * (DOCSP-11103),(DOCS-13759): tech review feedback and fix typo in example
1 parent 7d55b88 commit df466f0

8 files changed

+115
-21
lines changed

source/includes/prereqs/secure-om-resource.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
- :doc:`Install the Kubernetes Operator </tutorial/install-k8s-operator>`.
22

3-
- :doc:`Create Credentials for the Kubernetes Operator </tutorial/create-operator-credentials>`.
4-
53
- :ref:`Deploy the Ops Manager application <deploy-om-container>` that
64
you want to secure.
75

@@ -21,7 +19,7 @@
2119

2220
.. code-block:: sh
2321
24-
<opsmgr-name>db<index>.<opsmgr-name>-db-svc.<namespace>.svc.cluster.local
22+
<opsmgr-name>-db-<index>.<opsmgr-name>-db-svc.<namespace>.svc.cluster.local
2523
2624
* - Key Usages
2725
- MongoDB requires the |tls| certs to include two specific

source/includes/steps-deploy-k8s-opsmgr-http.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ content: |
582582
583583
kubectl get om -o yaml -w
584584
585-
When the |onprem| is running, the command returns the following
585+
When |onprem| is running, the command returns the following
586586
output under the ``status`` field:
587587
588588
.. code-block:: yaml

source/includes/steps-deploy-k8s-opsmgr-https.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -674,7 +674,7 @@ content: |
674674
675675
kubectl get om -o yaml -w
676676
677-
When the |onprem| is running, the command returns the following
677+
When |onprem| is running, the command returns the following
678678
output under the ``status`` field:
679679
680680
.. code-block:: yaml

source/includes/steps-deploy-k8s-opsmgr-local-mode.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,15 @@ content: |
9696
The installers that you download depend on the environment to which
9797
you deployed the operator:
9898
99+
.. note::
100+
101+
The examples below provide you with a link to quickly download the
102+
specified versions of MongoDB Community edition and the MongoDB
103+
Database tools.
104+
105+
To download MongoDB Enterprise Edition, or any other version of
106+
MongoDB Community Edition, visit the :dl:`MongoDB Download Center`.
107+
99108
.. tabs::
100109
101110
.. tab:: Vanilla Kubernetes
Lines changed: 62 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,86 @@
11
---
2-
ref: verify-om-appdb-tls-certs
2+
ref: configure-kubectl-standalone
33
stepnum: 1
4+
inherit:
5+
file: steps-configure-kubectl-namespace.yaml
6+
ref: configure-kubectl-namespace
7+
---
8+
ref: verify-om-appdb-tls-certs
9+
stepnum: 2
410
level: 4
511
inherit:
612
file: steps-source-deploy-om-resource.yaml
713
ref: verify-om-appdb-tls-certs
8-
---
14+
---
915
ref: create-om-appdb-secret
10-
stepnum: 2
16+
stepnum: 3
1117
level: 4
1218
inherit:
1319
file: steps-source-deploy-om-resource.yaml
1420
ref: create-om-appdb-secret
1521
---
1622
ref: create-om-appdb-configmap
17-
stepnum: 3
23+
stepnum: 4
1824
level: 4
1925
inherit:
2026
file: steps-source-deploy-om-resource.yaml
2127
ref: create-om-appdb-configmap
2228
---
2329
ref: create-om-appdb-set-secret
24-
stepnum: 4
30+
stepnum: 5
2531
level: 4
2632
inherit:
2733
file: steps-source-deploy-om-resource.yaml
2834
ref: create-om-appdb-set-secret
35+
---
36+
title: "Apply changes to your |onprem| deployment."
37+
stepnum: 6
38+
level: 4
39+
ref: apply-changes-om-k8s
40+
content: |
41+
42+
Invoke the following ``kubectl`` command on the filename of the
43+
|onprem| resource definition:
44+
45+
.. code-block:: sh
46+
47+
kubectl apply -f <opsmgr-resource>.yaml
48+
49+
---
50+
title: "Track the status of your |onprem| instance."
51+
stepnum: 7
52+
level: 4
53+
ref: track-k8s-instance
54+
content: |
55+
56+
To check the status of your |onprem| resource, invoke the following
57+
command:
58+
59+
.. code-block:: sh
60+
61+
kubectl get om -o yaml -w
62+
63+
When |onprem| is running, the command returns the following
64+
output under the ``status`` field:
65+
66+
.. code-block:: yaml
67+
:copyable: false
68+
69+
status:
70+
applicationDatabase:
71+
lastTransition: "2019-12-06T17:46:15Z"
72+
members: 3
73+
phase: Running
74+
type: ReplicaSet
75+
version: 4.2.2-ent
76+
opsManager:
77+
lastTransition: "2019-12-06T17:46:32Z"
78+
phase: Running
79+
replicas: 1
80+
url: https://om-appdb-tls-enabled-svc.dev.svc.cluster.local:8443
81+
version: 4.2.6
82+
83+
See :doc:`/reference/troubleshooting` for information about the
84+
resource deployment statuses.
85+
2986
...

source/includes/steps-source-deploy-om-resource.yaml

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content: |
77
88
Verify that each member of the Replica Set has one |tls| certificate named with the following format:
99
10-
``<resource-name>db<index>-pem``
10+
``<resource-name>-db-<index>-pem``
1111
1212
Where ``<index>`` is a 0-based index number to the total amount of
1313
members minus one. (``0`` to ``n-1``)
@@ -24,9 +24,9 @@ content: |
2424
.. code-block:: sh
2525
2626
kubectl create secret generic appdb-certs \
27-
--from-file=om-appdb-0-pem \
28-
--from-file=om-appdb-1-pem \
29-
--from-file=om-appdb-2-pem
27+
--from-file=om-appdb-tls-enabled-db-0-pem \
28+
--from-file=om-appdb-tls-enabled-db-1-pem \
29+
--from-file=om-appdb-tls-enabled-db-2-pem
3030
3131
``kubectl`` creates one Secret containing the three certificates.
3232
@@ -67,11 +67,16 @@ ref: create-om-appdb-set-secret
6767
title: "Specify the Secret with certs to the |onprem| yaml definition."
6868
content: |
6969
70-
.. literalinclude:: /includes/code-examples/yaml-files/example-opsmgr.yaml
71-
:language: yaml
72-
:linenos:
73-
:copyable: false
74-
:start-after: START-secure-appdb-full
75-
:end-before: END-secure-appdb-full
70+
.. literalinclude:: /includes/code-examples/yaml-files/example-opsmgr.yaml
71+
:language: yaml
72+
:linenos:
73+
:copyable: false
74+
:start-after: START-secure-appdb-full
75+
:end-before: END-secure-appdb-full
7676
77+
.. note::
78+
79+
The |k8s-op-short| mounts the |certauth| you add using the
80+
:opsmgrkube:`spec.applicationDatabase.security.tls.ca` setting to
81+
both the |onprem| and the Application Database pods.
7782
...

source/tutorial/modify-resource-image.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ To create a volume mount for a MongoDB database resource:
6666
podTemplate:
6767
spec:
6868
containers:
69-
- name: mongod-enterprise-database
69+
- name: mongodb-enterprise-database
7070
volumeMounts:
7171
- mountPath: </new/mount/path>
7272
name: survives-restart

source/tutorial/plan-om-resource.txt

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,25 @@ database or :term:`sharded cluster`. If you have concerns about
9797
performance or size requirements for the Application Database, contact
9898
`MongoDB Support <https://support.mongodb.com/welcome>`__.
9999

100+
Monitoring
101+
++++++++++
102+
103+
The |k8s-op-short| automatically configures |onprem| to monitor the
104+
Application Database that backs the |application|. The |k8s-op-short|
105+
creates a project named ``<ops-manager-deployment-name>-db`` for you to
106+
monitor the Application Database deployment.
107+
108+
|onprem| monitors the Application Database deployment, but |onprem| does
109+
not manage it. You cannot change the Application Database's
110+
configuration in the |application|.
111+
112+
.. important::
113+
114+
The |onprem| UI might display warnings in the
115+
``<ops-manager-deployment-name>-db`` project stating that the
116+
agents for the Application Database are out of date. You can safely
117+
ignore these warnings.
118+
100119
.. _app-db-auth:
101120

102121
Authentication
@@ -390,6 +409,12 @@ Prerequisites
390409
Use these credentials to log in to |onprem| for the first time. Once
391410
you deploy |onprem|, change the password or remove this secret.
392411

412+
.. note::
413+
414+
The admin user's password must adhere to the |onprem|
415+
:opsmgr:`password complexity requirements
416+
</tutorial/edit-your-user-account/index.html#edit-your-user-account>`.
417+
393418
.. code-block:: sh
394419

395420
kubectl create secret generic <adminusercredentials> \

0 commit comments

Comments
 (0)