Skip to content

Commit 7abc891

Browse files
authored
(DOCSP-35026) Fixes replacement value issue for yaml files (#1529)
1 parent ef95a19 commit 7abc891

32 files changed

+289
-445
lines changed

source/includes/k8soffline.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Install `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__
2+
and set the value of ``registry.pullPolicy`` to ``IfNotPresent``.
3+
To learn about optional |k8s-op-short| installation settings, see
4+
:ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
5+
6+
.. code-block:: sh
7+
8+
helm install enterprise-operator mongodb/enterprise-operator \
9+
--set registry.pullPolicy='IfNotPresent'

source/includes/k8sonline.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Install `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__.
2+
The following command installs the |k8s-crds| and the |k8s-op-short|
3+
in the current namespace named ``default``. By default, the
4+
|k8s-op-short| uses the ``default`` namespace.
5+
6+
.. code-block:: sh
7+
8+
helm install enterprise-operator mongodb/enterprise-operator
9+
10+
The following command installs the |k8s-op-short| in the ``mongodb``
11+
namespace with the optional ``--create-namespace`` option.
12+
13+
.. code-block:: sh
14+
15+
helm install enterprise-operator mongodb/enterprise-operator \
16+
--namespace mongodb \
17+
--create-namespace
18+
19+
To learn about optional |k8s-op-short| installation settings, see
20+
:ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. code-block:: none
2+
3+
kubectl apply -f <om-resource-specification>.yaml
4+
5+
|k8s| automatically reconfigures your deployment with the new
6+
specifications. You can see these changes reflected in your |mms| or
7+
:cloudmgr:`Cloud Manager </>` application.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
a. Set :opsmgrkube:`spec.version` to the new |onprem| version.
2+
3+
#. If you upgraded your :ref:`application database <appdb-om-arch>`, set
4+
:opsmgrkube:`spec.applicationDatabase.version` to the compatible MongoDB
5+
version.
6+
7+
c. *(Optional)* If you might need to downgrade, set
8+
:setting:`spec.featureCompatibilityVersion`.
9+
10+
11+
.. literalinclude:: /reference/k8s/example-ops-manager.yaml
12+
:language: yaml
13+
:linenos:

source/includes/osoffline.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Install `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__:
2+
3+
.. code-block:: sh
4+
5+
helm install enterprise-operator mongodb/enterprise-operator \
6+
--set registry.pullPolicy='IfNotPresent' \
7+
--set registry.imagePullSecrets='<openshift-pull-secret>' \
8+
--values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
9+
10+
Use the `values-openshift.yaml <https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>`__
11+
settings, ``registry.pullPolicy=IfNotPresent``, and
12+
``registry.imagePullSecrets=<openshift-pull-secret>``. To learn
13+
about optional |k8s-op-short| installation settings, see
14+
:ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.

source/includes/osonline.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Install `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__:
2+
3+
.. code-block:: sh
4+
5+
helm install enterprise-operator mongodb/enterprise-operator \
6+
--values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
7+
8+
Use the `values-openshift.yaml <https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>`__
9+
settings. To learn about optional |k8s-op-short| installation settings,
10+
see :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.

source/includes/quay-archive.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. code-block:: sh
2+
3+
docker save quay.io/mongodb/mongodb-enterprise-operator:<op-version> -o mongodb-enterprise-operator.tar; \
4+
docker save quay.io/mongodb/mongodb-enterprise-database:<db-version> -o mongodb-enterprise-database.tar; \
5+
docker save quay.io/mongodb/mongodb-enterprise-ops-manager:<om-version> -o mongodb-enterprise-ops-manager.tar; \
6+
docker save quay.io/mongodb/mongodb-enterprise-appdb:{+appdb-agent-version+} -o mongodb-enterprise-appdb.tar; \
7+
docker save quay.io/mongodb/mongodb-enterprise-init-ops-manager:{+ops-manager-init-version+} -o mongodb-enterprise-init-ops-manager.tar; \
8+
docker save quay.io/mongodb/mongodb-enterprise-init-appdb:{+appdb-init-version+} -o mongodb-enterprise-init-appdb.tar;
9+
docker save quay.io/mongodb/mongodb-enterprise-init-database:{+database-init-version+} -o mongodb-enterprise-init-database.tar;

source/includes/quayimport.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. code-block:: sh
2+
3+
docker load -i mongodb-enterprise-operator.tar; \
4+
docker load -i mongodb-enterprise-database.tar; \
5+
docker load -i mongodb-enterprise-ops-manager.tar; \
6+
docker load -i mongodb-enterprise-appdb.tar; \
7+
docker load -i mongodb-enterprise-init-ops-manager.tar; \
8+
docker load -i mongodb-enterprise-init-appdb.tar; \
9+
docker load -i mongodb-enterprise-init-database.tar;

source/includes/quaypull.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. code-block:: sh
2+
3+
docker pull quay.io/mongodb/mongodb-enterprise-operator:<op-version>; \
4+
docker pull quay.io/mongodb/mongodb-enterprise-database:<db-version>; \
5+
docker pull quay.io/mongodb/mongodb-enterprise-ops-manager:<om-version>; \
6+
docker pull quay.io/mongodb/mongodb-enterprise-appdb:{+appdb-agent-version+}; \
7+
docker pull quay.io/mongodb/mongodb-enterprise-init-ops-manager:{+ops-manager-init-version+}; \
8+
docker pull quay.io/mongodb/mongodb-enterprise-init-appdb:{+appdb-init-version+}; \
9+
docker pull quay.io/mongodb/mongodb-enterprise-init-database:{+database-init-version+};

source/includes/rh-archive.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. code-block:: sh
2+
3+
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-operator:<op-version> -o mongodb-enterprise-operator.tar; \
4+
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-database:<db-version> -o mongodb-enterprise-database.tar; \
5+
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-ops-manager:<om-version> -o mongodb-enterprise-ops-manager.tar; \
6+
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-appdb:{+appdb-agent-version+} -o mongodb-enterprise-appdb.tar; \
7+
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-init-ops-manager:{+ops-manager-init-version+} -o mongodb-enterprise-init-ops-manager.tar; \
8+
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-init-appdb:{+appdb-init-version+} -o mongodb-enterprise-init-appdb.tar;
9+
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-init-database:{+database-init-version+} -o mongodb-enterprise-init-database.tar;

source/includes/rhimport.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. code-block:: sh
2+
3+
docker load -i mongodb-enterprise-operator.tar; \
4+
docker load -i mongodb-enterprise-database.tar; \
5+
docker load -i mongodb-enterprise-ops-manager.tar; \
6+
docker load -i mongodb-enterprise-appdb.tar; \
7+
docker load -i mongodb-enterprise-init-ops-manager.tar; \
8+
docker load -i mongodb-enterprise-init-appdb.tar; \
9+
docker load -i mongodb-enterprise-init-database.tar;

source/includes/rhpull.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. code-block:: sh
2+
3+
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-operator:<op-version>; \
4+
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-database:<db-version>; \
5+
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-ops-manager:<om-version>; \
6+
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-appdb:{+appdb-agent-version+}; \
7+
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-init-ops-manager:{+ops-manager-init-version+}; \
8+
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-init-appdb:{+appdb-init-version+}; \
9+
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-init-database:{+database-init-version+};

source/includes/steps-helm-master.yaml

Lines changed: 1 addition & 197 deletions
Original file line numberDiff line numberDiff line change
@@ -21,122 +21,6 @@ content: |
2121
title: "{{method}}"
2222
level: 4
2323
ref: helm-master-install
24-
replacement:
25-
k8sonline: |
26-
27-
Install `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__.
28-
The following command installs the |k8s-crds| and the |k8s-op-short|
29-
in the current namespace named ``default``. By default, the
30-
|k8s-op-short| uses the ``default`` namespace.
31-
32-
.. code-block:: sh
33-
34-
helm install enterprise-operator mongodb/enterprise-operator
35-
36-
The following command installs the |k8s-op-short| in the ``mongodb``
37-
namespace with the optional ``--create-namespace`` option.
38-
39-
.. code-block:: sh
40-
41-
helm install enterprise-operator mongodb/enterprise-operator \
42-
--namespace mongodb \
43-
--create-namespace
44-
45-
To learn about optional |k8s-op-short| installation settings, see
46-
:ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
47-
48-
k8soffline: |
49-
50-
Install `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__
51-
and set the value of ``registry.pullPolicy`` to ``IfNotPresent``.
52-
To learn about optional |k8s-op-short| installation settings, see
53-
:ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
54-
55-
.. code-block:: sh
56-
57-
helm install enterprise-operator mongodb/enterprise-operator \
58-
--set registry.pullPolicy='IfNotPresent'
59-
60-
osonline: |
61-
62-
Install `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__:
63-
64-
.. code-block:: sh
65-
66-
helm install enterprise-operator mongodb/enterprise-operator \
67-
--values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
68-
69-
Use the `values-openshift.yaml <https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>`__
70-
settings. To learn about optional |k8s-op-short| installation settings,
71-
see :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
72-
73-
osoffline: |
74-
75-
Install `MongoDB Helm Charts for Kubernetes <https://mongodb.github.io/helm-charts>`__:
76-
77-
.. code-block:: sh
78-
79-
helm install enterprise-operator mongodb/enterprise-operator \
80-
--set registry.pullPolicy='IfNotPresent' \
81-
--set registry.imagePullSecrets='<openshift-pull-secret>' \
82-
--values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
83-
84-
Use the `values-openshift.yaml <https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>`__
85-
settings, ``registry.pullPolicy=IfNotPresent``, and
86-
``registry.imagePullSecrets=<openshift-pull-secret>``. To learn
87-
about optional |k8s-op-short| installation settings, see
88-
:ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
89-
90-
k8sonlineupgrade: |
91-
92-
Invoke the following ``helm`` command:
93-
94-
.. code-block:: sh
95-
96-
helm upgrade enterprise-operator mongodb/enterprise-operator
97-
98-
k8sofflineupgrade: |
99-
100-
Invoke the following ``helm upgrade`` command.
101-
Use the ``registry.pullPolicy=IfNotPresent`` setting. To learn
102-
about optional |k8s-op-short| installation settings, see
103-
:ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
104-
105-
.. code-block:: sh
106-
107-
helm upgrade enterprise-operator mongodb/enterprise-operator \
108-
--set registry.pullPolicy='IfNotPresent'
109-
110-
osonlineupgrade: |
111-
112-
Invoke the following ``helm upgrade`` command.
113-
Use `values-openshift.yaml <https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>`__ settings. To learn
114-
about optional |k8s-op-short| installation settings, see
115-
:ref:`Operator Helm Installation Settings<meko-op-install-settings-helm>`.
116-
117-
.. code-block:: sh
118-
119-
helm upgrade enterprise-operator mongodb/enterprise-operator \
120-
--values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
121-
122-
osofflineupgrade: |
123-
124-
125-
Invoke the following ``helm upgrade`` command:
126-
127-
.. code-block:: sh
128-
129-
helm upgrade enterprise-operator mongodb/enterprise-operator \
130-
--set registry.pullPolicy='IfNotPresent' \
131-
--set registry.imagePullSecrets='<openshift-pull-secret>' \
132-
--values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
133-
134-
Use the `values-openshift.yaml <https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>`__
135-
settings, ``registry.pullPolicy=IfNotPresent``, and
136-
``registry.imagePullSecrets=<openshift-pull-secret>``. To learn
137-
about optional |k8s-op-short| installation settings, see
138-
:ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
139-
14024
replacement:
14125
method: ""
14226

@@ -153,99 +37,19 @@ ref: helm-master-disconnect-internet
15337
title: "Export the |k8s-op-short| images as ``.tar`` archive files:"
15438
level: 4
15539
ref: helm-master-archive-files
156-
replacement:
157-
versions: |
158-
.. include:: /includes/install/replace-op-and-om-versions.rst
159-
160-
quayarchive: |
161-
162-
.. code-block:: sh
163-
164-
docker save quay.io/mongodb/mongodb-enterprise-operator:<op-version> -o mongodb-enterprise-operator.tar; \
165-
docker save quay.io/mongodb/mongodb-enterprise-database:<db-version> -o mongodb-enterprise-database.tar; \
166-
docker save quay.io/mongodb/mongodb-enterprise-ops-manager:<om-version> -o mongodb-enterprise-ops-manager.tar; \
167-
docker save quay.io/mongodb/mongodb-enterprise-appdb:{+appdb-agent-version+} -o mongodb-enterprise-appdb.tar; \
168-
docker save quay.io/mongodb/mongodb-enterprise-init-ops-manager:{+ops-manager-init-version+} -o mongodb-enterprise-init-ops-manager.tar; \
169-
docker save quay.io/mongodb/mongodb-enterprise-init-appdb:{+appdb-init-version+} -o mongodb-enterprise-init-appdb.tar;
170-
docker save quay.io/mongodb/mongodb-enterprise-init-database:{+database-init-version+} -o mongodb-enterprise-init-database.tar;
171-
172-
rharchive: |
173-
174-
.. code-block:: sh
175-
176-
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-operator:<op-version> -o mongodb-enterprise-operator.tar; \
177-
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-database:<db-version> -o mongodb-enterprise-database.tar; \
178-
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-ops-manager:<om-version> -o mongodb-enterprise-ops-manager.tar; \
179-
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-appdb:{+appdb-agent-version+} -o mongodb-enterprise-appdb.tar; \
180-
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-init-ops-manager:{+ops-manager-init-version+} -o mongodb-enterprise-init-ops-manager.tar; \
181-
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-init-appdb:{+appdb-init-version+} -o mongodb-enterprise-init-appdb.tar;
182-
docker save registry.connect.redhat.com/mongodb/mongodb-enterprise-init-database:{+database-init-version+} -o mongodb-enterprise-init-database.tar;
18340

18441
---
185-
title: "Copy these ``.tar`` files to the host running the
186-
|k8s| ``docker`` daemon."
42+
title: "Copy these ``.tar`` files to the host running the |k8s| ``docker`` daemon."
18743
level: 4
18844
ref: helm-master-copy-tar
18945
---
19046
title: "Import the ``.tar`` files into ``docker``."
19147
level: 4
19248
ref: helm-master-import-tar
193-
replacement:
194-
195-
quayimport: |
196-
197-
.. code-block:: sh
198-
199-
docker load -i mongodb-enterprise-operator.tar; \
200-
docker load -i mongodb-enterprise-database.tar; \
201-
docker load -i mongodb-enterprise-ops-manager.tar; \
202-
docker load -i mongodb-enterprise-appdb.tar; \
203-
docker load -i mongodb-enterprise-init-ops-manager.tar; \
204-
docker load -i mongodb-enterprise-init-appdb.tar; \
205-
docker load -i mongodb-enterprise-init-database.tar;
206-
207-
rhimport: |
208-
209-
.. code-block:: sh
210-
211-
docker load -i mongodb-enterprise-operator.tar; \
212-
docker load -i mongodb-enterprise-database.tar; \
213-
docker load -i mongodb-enterprise-ops-manager.tar; \
214-
docker load -i mongodb-enterprise-appdb.tar; \
215-
docker load -i mongodb-enterprise-init-ops-manager.tar; \
216-
docker load -i mongodb-enterprise-init-appdb.tar; \
217-
docker load -i mongodb-enterprise-init-database.tar;
21849

21950
---
22051
title: "Use ``docker`` to request the files."
22152
level: 4
22253
ref: helm-master-docker-request
223-
replacement:
224-
quaypull: |
225-
226-
.. code-block:: sh
227-
228-
docker pull quay.io/mongodb/mongodb-enterprise-operator:<op-version>; \
229-
docker pull quay.io/mongodb/mongodb-enterprise-database:<db-version>; \
230-
docker pull quay.io/mongodb/mongodb-enterprise-ops-manager:<om-version>; \
231-
docker pull quay.io/mongodb/mongodb-enterprise-appdb:{+appdb-agent-version+}; \
232-
docker pull quay.io/mongodb/mongodb-enterprise-init-ops-manager:{+ops-manager-init-version+}; \
233-
docker pull quay.io/mongodb/mongodb-enterprise-init-appdb:{+appdb-init-version+}; \
234-
docker pull quay.io/mongodb/mongodb-enterprise-init-database:{+database-init-version+};
235-
236-
rhpull: |
237-
238-
.. code-block:: sh
239-
240-
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-operator:<op-version>; \
241-
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-database:<db-version>; \
242-
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-ops-manager:<om-version>; \
243-
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-appdb:{+appdb-agent-version+}; \
244-
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-init-ops-manager:{+ops-manager-init-version+}; \
245-
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-init-appdb:{+appdb-init-version+}; \
246-
docker pull registry.connect.redhat.com/mongodb/mongodb-enterprise-init-database:{+database-init-version+};
247-
248-
versions: |
24954

250-
.. include:: /includes/install/replace-op-and-om-versions.rst
25155
...

0 commit comments

Comments
 (0)