Skip to content

Commit 7a180b3

Browse files
jvincent-mongodbjvincent-mongodb
authored
DOCSP-36928 -- backport to v1.27 (#1845)
1 parent 803b035 commit 7a180b3

9 files changed

+260
-244
lines changed

‎source/includes/install/same-namespace-kubectl.rst

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,9 @@
22

33
.. note:: Use the same namespace throughout
44

5-
The following examples assume that you created a |k8s-ns|
6-
using the default |k8s-op-short| namespace of ``mongodb``.
7-
If you specified a different label for your namespace when
8-
you :ref:`created it <k8s-prerequisites>`, change all
9-
values for ``metadata.namespace`` to that namespace.
10-
11-
To change the label for the namespace for the following
12-
deployment to ``production``, edit all values for
5+
By default, the |k8s-op-short| deploys all resources in your |k8s| cluster
6+
to the |k8s-ns| ``mongodb``. You can deploy |k8s-op-short| resources
7+
to a different namespace by editing all values for
138
``metadata.namespace`` in ``mongodb-enterprise.yaml``:
149

1510
.. code-block:: yaml

‎source/includes/install/same-namespace-oc.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,9 @@
22

33
.. note:: Use the same namespace throughout
44

5-
The following examples assume that you created a |k8s-ns|
6-
using the default |k8s-op-short| namespace of ``mongodb``.
7-
If you specified a different label for your namespace when
8-
you :ref:`created it <k8s-prerequisites>`, change all
9-
values for ``metadata.namespace`` to that namespace.
10-
11-
To change the label for the namespace for the following
12-
deployment to ``production``, edit all values for
5+
By default, the |k8s-op-short| deploys all resources in your |k8s| cluster
6+
to the |k8s-ns| ``mongodb``. You can deploy |k8s-op-short| resources
7+
to a different namespace by editing all values for
138
``metadata.namespace`` in ``mongodb-enterprise-openshift.yaml``:
149

1510
.. code-block:: yaml
@@ -35,4 +30,4 @@
3530
---
3631
# Example truncated
3732
---
38-
...
33+
...

‎source/includes/steps-install-k8s-online-helm.yaml

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,56 @@
1-
---
2-
ref: helm-k8s-online-install
3-
inherit:
4-
file: steps-helm-master.yaml
5-
ref: install-helm-charts
61
stepnum: 1
2+
ref: update-helm-chart
3+
title: Add the `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__.
4+
content: |
75
6+
You can add the |k8s-op-short| Helm Chart locally by running:
7+
8+
.. code-block:: sh
9+
10+
helm repo add mongodb https://mongodb.github.io/helm-charts
811
---
9-
ref: helm-k8s-online-install-crds
12+
stepnum: 2
13+
ref: upgrade-customize-chart
14+
title: "Customize your Helm Chart before deploying it."
15+
content: |
16+
17+
To learn about optional |k8s-op-short|
18+
installation settings, see :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
19+
---
20+
ref: update-meko-helm
21+
stepnum: 3
22+
title: "Apply the CRDs to your |k8s| cluster."
23+
content: |
24+
25+
Run the following ``kubectl`` command with your desired |k8s-op-short| version to deploy the CRDs to your |k8s| cluster:
26+
27+
.. code-block::
28+
29+
kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-enterprise-kubernetes/<version>/crds.yaml
30+
---
31+
ref: helm-k8s-online-ug
1032
inherit:
1133
file: steps-helm-master.yaml
1234
ref: helm-master-install
13-
stepnum: 2
35+
stepnum: 4
1436
replacement:
15-
method: "Install the |k8s-op-short|:"
37+
method: "Deploy the |k8s-op-short|."
1638
content: |
39+
40+
Run the following ``helm`` command to deploy the |k8s-op-short| to the
41+
default namespace in your |k8s| cluster:
42+
43+
.. code-block:: sh
44+
45+
helm install --upgrade enterprise-operator mongodb/enterprise-operator
1746
18-
.. include:: /includes/k8sonline.rst
47+
48+
You can pass the ``--namespace`` and ``--create-namespace`` flags to deploy
49+
the |k8s-op-short| to a non-default namespace, like so:
1950
20-
...
51+
.. code-block::
52+
53+
helm install enterprise-operator mongodb/enterprise-operator \
54+
--namespace mongodb \
55+
--create-namespace
56+
...

‎source/includes/steps-install-kubectl.yaml

Lines changed: 16 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,34 @@
1-
---
2-
title: "Clone the :github:`MongoDB Enterprise Kubernetes Operator repository </mongodb/mongodb-enterprise-kubernetes>`."
3-
level: 4
4-
ref: install-kubectl-clone-repo
5-
stepnum: 1
6-
content: |
7-
Invoke the following ``git`` command:
8-
9-
.. code-block:: sh
10-
11-
git clone https://github.com/mongodb/mongodb-enterprise-kubernetes.git
12-
---
13-
ref: install-kubectl-cd-yaml
14-
inherit:
15-
file: steps-install-master.yaml
16-
ref: install-master-cd
17-
stepnum: 2
18-
---
19-
ref: install-kubectl-crds
20-
inherit:
21-
file: steps-install-master.yaml
22-
ref: install-master-crds
23-
stepnum: 3
24-
replacement:
25-
method: "Install the |k8s-crds| for MongoDB deployments using the following |kubectl| command:"
26-
content: |
27-
28-
Invoke the following |kubectl| command:
29-
30-
.. code-block:: sh
31-
32-
kubectl apply -f crds.yaml
33-
341
---
352
ref: install-kubectl-edit-yaml
363
inherit:
374
file: steps-install-master.yaml
385
ref: install-master-edit-yaml
39-
stepnum: 4
6+
stepnum: 1
407
replacement:
418
method: installing
429
---
4310
ref: install-kubectl-install
44-
inherit:
45-
file: steps-install-master.yaml
46-
ref: install-master-install
47-
stepnum: 5
11+
stepnum: 2
4812
replacement:
4913
method: "Install the |k8s-op-short| using the following
5014
|kubectl| command:"
5115
content: |
5216
53-
Invoke the following |kubectl| command:
17+
Populate the ``<version>`` placeholder and run the following ``kubectl``
18+
command to deploy your chosen version of the |k8s-op-short| to your |k8s| cluster:
5419
5520
.. code-block:: sh
5621
57-
kubectl apply -f mongodb-enterprise.yaml
22+
kubectl apply -f kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-enterprise-kubernetes/<version>/mongodb-enterprise.yaml
23+
---
24+
ref: update-meko-kubectl
25+
stepnum: 3
26+
title: "Apply the MongoDB CRDs."
27+
content: |
28+
29+
Populate the ``<version>`` placeholder and run the following ``kubectl``
30+
command to deploy your chosen version of the CRDs to your |k8s| cluster:
5831
59-
...
32+
.. code-block::
33+
34+
kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-enterprise-kubernetes/<version>/crds.yaml

‎source/includes/steps-upgrade-k8s-online-helm.yaml

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,47 @@ ref: update-helm-chart
33
title: Update to the latest version of the `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__.
44
content: |
55
6+
Run the following command to check the version of your current Helm template:
7+
8+
.. code-block:: sh
9+
10+
helm search repo mongodb/enterprise-operator
11+
12+
If your currently installed version is not the latest release, run the following
13+
commmand to update your Helm repo:
14+
615
.. code-block:: sh
716
817
helm repo update mongodb
918
19+
If you don't have the Helm repo installed locally, you can install it by running:
1020
21+
.. code-block:: sh
22+
23+
helm repo add mongodb https://mongodb.github.io/helm-charts
1124
---
12-
ref: remove-project-spec-k8s-online-helm
1325
stepnum: 2
14-
inherit:
15-
file: steps-install-master.yaml
16-
ref: remove-project-spec
17-
---
1826
ref: upgrade-customize-chart
19-
inherit:
20-
file: steps-helm-master.yaml
21-
ref: helm-master-customize-chart
22-
stepnum: 3
27+
title: "Customize your Helm Chart before upgrading it."
28+
content: |
29+
30+
To avoid breaking changes, you should ensure that you select the same settings
31+
as those in your existing deployment. To learn about optional |k8s-op-short|
32+
installation settings, see :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
2333
2434
---
35+
ref: update-meko-helm
36+
stepnum: 3
37+
title: "Apply the CRDs to your |k8s| cluster."
38+
content: |
39+
40+
Populate the ``<version>`` placeholder and run the following ``kubectl``
41+
command to deploy the CRDs to your |k8s| cluster:
2542
43+
.. code-block::
44+
45+
kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-enterprise-kubernetes/<version>/crds.yaml
46+
---
2647
ref: helm-k8s-online-ug
2748
inherit:
2849
file: steps-helm-master.yaml
@@ -32,10 +53,19 @@ replacement:
3253
method: "Upgrade the |k8s-op-short|."
3354
content: |
3455
35-
Invoke the following ``helm`` command:
56+
Run the following ``helm`` command to deploy the |k8s-op-short| to the
57+
default namespace in your |k8s| cluster:
3658
3759
.. code-block:: sh
3860
39-
helm upgrade enterprise-operator mongodb/enterprise-operator
61+
helm install enterprise-operator mongodb/enterprise-operator
62+
63+
64+
You can pass the ``--namespace`` and ``--namespace-create`` flags to deploy
65+
the |k8s-op-short| to a non-default namespace, like so:
4066
41-
...
67+
.. code-block::
68+
69+
helm install enterprise-operator mongodb/enterprise-operator \
70+
--namespace mongodb \
71+
--create-namespace

‎source/includes/steps-upgrade-kubectl.yaml

Lines changed: 21 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,37 @@
11
---
2-
ref: upgrade-kubectl-crds
3-
inherit:
4-
file: steps-install-master.yaml
5-
ref: install-master-crds
62
stepnum: 1
7-
replacement:
8-
method: "Upgrade the |k8s-crds| for MongoDB deployments."
3+
ref: upgrade-customize-chart
4+
title: "Customize your |k8s-op-short| |yaml| before upgrading it."
95
content: |
10-
11-
Invoke the following |kubectl| command:
12-
13-
.. code-block:: sh
14-
15-
kubectl replace -f crds.yaml
16-
17-
---
18-
ref: upgrade-kubectl-edit-yaml
19-
inherit:
20-
file: steps-install-master.yaml
21-
ref: install-master-edit-yaml
22-
stepnum: 2
23-
optional: true
24-
replacement:
25-
method: upgrading
26-
27-
---
28-
ref: remove-project-spec-kubectl
29-
stepnum: 3
30-
inherit:
31-
file: steps-install-master.yaml
32-
ref: remove-project-spec
6+
7+
To avoid breaking changes, you should ensure that you select the same settings
8+
as those in your existing deployment. To learn about optional |k8s-op-short|
9+
installation settings, see :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
3310
---
3411
ref: upgrade-kubectl-upgrade
3512
inherit:
3613
file: steps-install-master.yaml
3714
ref: install-master-install
38-
stepnum: 4
15+
stepnum: 2
3916
replacement:
4017
method: "Upgrade to the new version of the |k8s-op-short|."
4118
content: |
4219
43-
Invoke the following ``helm`` command:
20+
Populate the ``<version>`` placeholder and run the following ``kubectl``
21+
command to deploy your chosen version of the |k8s-op-short| to your |k8s| cluster:
4422
4523
.. code-block:: sh
4624
47-
helm upgrade enterprise-operator mongodb/enterprise-operator
25+
kubectl apply -f kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-enterprise-kubernetes/<version>/mongodb-enterprise.yaml
26+
---
27+
ref: update-meko-kubectl
28+
stepnum: 3
29+
title: "Update the MongoDB CRDs."
30+
content: |
31+
32+
Populate the ``<version>`` placeholder and run the following ``kubectl``
33+
command to deploy your chosen version of the CRDs to your |k8s| cluster:
4834
49-
...
35+
.. code-block::
36+
37+
kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-enterprise-kubernetes/<version>/crds.yaml

0 commit comments

Comments
 (0)