Skip to content

Commit a862166

Browse files
authored
(DOCSP-14707): Drafted MEKO OpenShift Quick Start. (#595)
* (DOCSP-14707): Drafted MEKO OpenShift Quick Start. * (DOCSP-14707): Incorporated Nate's feedback. * (DOCSP-14707): Incorporated Rodrigo's feedback.
1 parent ea413b3 commit a862166

7 files changed

+162
-13
lines changed

source/includes/steps-add-database-user-scram.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ content: |
110110
111111
You can view the newly-created user in |com|:
112112
113-
1. From the Project's :guilabel:`Deployment` view, click
113+
a. From the Project's :guilabel:`Deployment` view, click
114114
the :guilabel:`Security` tab.
115115
116116
#. Click the :guilabel:`MongoDB Users` nested tab.

source/includes/steps-install-prereqs.yaml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,17 +95,16 @@ content: |
9595
``registry.connect.redhat.com``, then save the file:
9696
9797
.. code-block:: json
98-
:emphasize-lines: 5-9
98+
:emphasize-lines: 6-8
9999
100100
{
101101
"auths": {
102-
"registry.redhat.io": {
103-
"auth": "<encoded-string>"
104-
},
105-
"auths": {
106-
"registry.connect.redhat.com": {
107-
"auth": "<encoded-string>"
108-
}
102+
"registry.redhat.io": {
103+
"auth": "<encoded-string>"
104+
},
105+
"registry.connect.redhat.com": {
106+
"auth": "<encoded-string>"
107+
}
109108
}
110109
}
111110

source/includes/steps-kind-quick-start.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ title: "Install the |k8s-op-full|"
4545
ref: install-kubectl-kind
4646
content: |
4747
48-
1. Change to the directory in which you cloned the repository.
48+
a. Change to the directory in which you cloned the repository.
4949
5050
#. Install the |k8s-crds| for MongoDB deployments using the
5151
following |kubectl| command:
@@ -249,7 +249,7 @@ content: |
249249
`Cloud Manager <docs.cloudmanager.com/current/>`__
250250
application, depending on where your clusters are hosted:
251251
252-
1. Click :guilabel:`Deployment` in the left navigation.
252+
a. Click :guilabel:`Deployment` in the left navigation.
253253
254254
#. Click :icon-mms:`ellipsis` for the deployment to which you want
255255
to connect.
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
stepnum: 1
3+
level: 4
4+
ref: clone-k8s-repo-openshift
5+
source:
6+
file: steps-kind-quick-start.yaml
7+
ref: clone-k8s-repo-kind
8+
9+
---
10+
stepnum: 2
11+
level: 4
12+
ref: create-k8s-ns-openshift
13+
source:
14+
file: steps-kind-quick-start.yaml
15+
ref: create-k8s-ns-kind
16+
17+
---
18+
stepnum: 3
19+
level: 4
20+
ref: configure-kubectl-configmap-openshift
21+
source:
22+
file: steps-kind-quick-start.yaml
23+
ref: configure-kubectl-configmap-kind
24+
25+
---
26+
stepnum: 4
27+
level: 4
28+
ref: create-k8s-secret-openshift
29+
title: "Create a |k8s-secret| that contains credentials authorized to pull images from the ``registry.connect.redhat.com`` repository."
30+
source:
31+
file: steps-install-prereqs.yaml
32+
ref: create-k8s-secret
33+
34+
---
35+
stepnum: 5
36+
level: 4
37+
title: "Install the |k8s-op-full|"
38+
ref: install-k8s-openshift
39+
content: |
40+
41+
a. Invoke the following |oc| command to install the |k8s-crds| for
42+
MongoDB deployments:
43+
44+
.. code-block:: sh
45+
46+
oc apply -f crds.yaml
47+
48+
#. Add your ``<openshift-pull-secret>`` to the ``ServiceAccount``
49+
definitions in the |k8s-op-full| |yaml| file:
50+
51+
.. literalinclude:: /includes/openshift-service-accounts.yaml
52+
:language: yaml
53+
:emphasize-lines: 11-12, 22-23, 33-34
54+
55+
#. Invoke the following |oc| command to install |k8s-op-short|:
56+
57+
.. code-block:: sh
58+
59+
oc apply -f mongodb-enterprise-openshift.yaml
60+
61+
---
62+
stepnum: 6
63+
level: 4
64+
ref: create-k8s-credentials-openshift
65+
source:
66+
file: steps-kind-quick-start.yaml
67+
ref: create-k8s-credentials-kind
68+
69+
---
70+
stepnum: 7
71+
level: 4
72+
ref: copy-k8s-configmap-openshift
73+
source:
74+
file: steps-kind-quick-start.yaml
75+
ref: copy-k8s-configmap-kind
76+
77+
---
78+
stepnum: 8
79+
level: 4
80+
ref: deploy-replica-set-openshift
81+
source:
82+
file: steps-kind-quick-start.yaml
83+
ref: deploy-replica-set-kind
84+
85+
---
86+
stepnum: 9
87+
level: 4
88+
ref: create-k8s-user-secret-openshift
89+
source:
90+
file: steps-kind-quick-start.yaml
91+
ref: create-k8s-user-secret-kind
92+
93+
---
94+
stepnum: 10
95+
level: 4
96+
ref: add-k8s-user-configmap-openshift
97+
source:
98+
file: steps-kind-quick-start.yaml
99+
ref: add-k8s-user-configmap-kind
100+
101+
---
102+
stepnum: 11
103+
level: 4
104+
ref: view-k8s-user-openshift
105+
optional: true
106+
source:
107+
file: steps-add-database-user-scram.yaml
108+
ref: view-k8s-user
109+
110+
---
111+
stepnum: 12
112+
level: 4
113+
ref: connect-k8s-rs-openshift
114+
source:
115+
file: steps-kind-quick-start.yaml
116+
ref: connect-k8s-rs-kind
117+
118+
...

source/index.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ optimal performance.
4848
:titlesonly:
4949

5050
Kind Quick Start </kind-quick-start>
51+
OpenShift Quick Start </openshift-quick-start>
5152
Install the Operator </installation>
5253
Deploy Ops Manager Resources </om-resources>
5354
Deploy MongoDB Database Resources </mdb-resources>

source/kind-quick-start.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Kind Quick Start
1313
:class: singlecol
1414

1515
|k8s-op-full| uses the |k8s| API and tools to manage MongoDB
16-
clusters. |k8s-op-full| works together with MongoDB |com|. This
16+
clusters. |k8s-op-short| works together with MongoDB |com|. This
1717
tutorial demonstrates how to deploy and connect to your first replica
18-
set in |com| from |kind| with |k8s-op-full|.
18+
set in |com| from |kind| with |k8s-op-short|.
1919

2020

2121
Prerequisites

source/openshift-quick-start.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. _openshift-quick-start-ref:
2+
3+
=====================
4+
OpenShift Quick Start
5+
=====================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
|k8s-op-full| uses the |k8s| API and tools to manage MongoDB
16+
clusters. |k8s-op-short| works together with MongoDB |com|. This
17+
tutorial demonstrates how to deploy and connect to your first replica
18+
set in |com| from OpenShift with |k8s-op-short|.
19+
20+
21+
Prerequisites
22+
-------------
23+
24+
This tutorial requires:
25+
26+
- A running |com| cluster.
27+
28+
Procedure
29+
---------
30+
31+
.. include:: /includes/steps/openshift-quick-start.rst

0 commit comments

Comments
 (0)