|
1 | 1 | .. list-table::
|
2 |
| - :widths: 20 80 |
| 2 | + :widths: 15 70 15 |
3 | 3 | :header-rows: 1
|
| 4 | + :stub-columns: 1 |
4 | 5 |
|
5 | 6 | * - Setting
|
6 |
| - - When to Use |
| 7 | + - Purpose |
| 8 | + - Default |
7 | 9 |
|
8 | 10 | * - ``namespace``
|
9 |
| - - To use a different namespace, you need to specify that |
10 |
| - ``namespace``. |
11 | 11 |
|
12 |
| - Default value is: ``mongodb``. |
| 12 | + - To use a different namespace, specify that ``namespace``. |
13 | 13 |
|
14 |
| - .. example:: |
| 14 | + .. code-block:: yaml |
| 15 | + :emphasize-lines: 2 |
15 | 16 |
|
16 |
| - .. code-block:: sh |
17 |
| - :emphasize-lines: 2 |
| 17 | + # Name of the Namespace to use |
| 18 | + namespace: mongodb |
18 | 19 |
|
19 |
| - # Name of the Namespace to use |
20 |
| - namespace: mongodb |
| 20 | + - ``mongodb`` |
| 21 | + |
| 22 | + * - | ``operator`` |
| 23 | + | ``.env`` |
21 | 24 |
|
22 |
| - * - ``operator.env`` |
23 | 25 | - Label for the Operator's deployment environment. The ``env``
|
24 | 26 | value affects default timeouts and the format and level of
|
25 | 27 | logging.
|
|
40 | 42 |
|
41 | 43 | Accepted values are: ``dev``, ``prod``.
|
42 | 44 |
|
43 |
| - Default value is: ``prod``. |
| 45 | + .. code-block:: yaml |
| 46 | + :emphasize-lines: 3 |
44 | 47 |
|
45 |
| - .. example:: |
| 48 | + operator: |
| 49 | + # Execution environment for the operator, dev or prod. |
| 50 | + # Use dev for more verbose logging |
| 51 | + env: prod |
46 | 52 |
|
47 |
| - .. code-block:: sh |
48 |
| - :emphasize-lines: 3 |
| 53 | + - ``prod`` |
49 | 54 |
|
50 |
| - operator: |
51 |
| - # Execution environment for the operator, dev or prod. Use dev for more verbose logging |
52 |
| - env: prod |
| 55 | + * - | ``operator`` |
| 56 | + | ``.watchNamespace`` |
53 | 57 |
|
54 |
| - * - ``operator.watchNamespace`` |
55 | 58 | - Namespace that the Operator watches for |k8s-mdbrsc| changes.
|
56 | 59 | If this |k8s-ns| differs from the default, ensure that the
|
57 | 60 | Operator's ServiceAccount
|
|
63 | 66 | assigned to the ``mongodb-enterprise-operator`` ServiceAccount
|
64 | 67 | which is the ServiceAccount used to run the |k8s-op-short|.
|
65 | 68 |
|
66 |
| - Default value is: ``<metadata.namespace>``. |
| 69 | + .. code-block:: yaml |
| 70 | + :emphasize-lines: 2 |
| 71 | +
|
| 72 | + operator: |
| 73 | + watchNamespace: * |
67 | 74 |
|
68 | 75 | .. include:: /includes/admonitions/fact-create-service-account-namespaces.rst
|
69 | 76 |
|
70 |
| - .. example:: |
| 77 | + - ``<metadata.namespace>`` |
71 | 78 |
|
72 |
| - .. code-block:: sh |
73 |
| - :emphasize-lines: 2 |
| 79 | + * - | ``operator`` |
| 80 | + | ``.watchedResources`` |
74 | 81 |
|
75 |
| - operator: |
76 |
| - watchNamespace: * |
| 82 | + - Custom resources that the |k8s-op-short| watches. |
77 | 83 |
|
78 |
| - * - ``registry.operator`` |
79 |
| - - Repository from which the |k8s-op-short| image is pulled. Specify |
80 |
| - this value if you want to pull the |k8s-op-short| image from a |
81 |
| - private repository. |
| 84 | + The |k8s-op-short| installs the |k8s-crds| for and watches only |
| 85 | + the resources you specify. |
82 | 86 |
|
83 |
| - .. example:: |
| 87 | + Accepted values are: |
84 | 88 |
|
85 |
| - .. code-block:: sh |
86 |
| - :emphasize-lines: 2 |
| 89 | + .. include:: /includes/list-tables/crds.rst |
87 | 90 |
|
88 |
| - registry: |
89 |
| - operator: quay.io/mongodb |
| 91 | + .. code-block:: yaml |
| 92 | + :emphasize-lines: 2 |
| 93 | +
|
| 94 | + operator: |
| 95 | + watchedResources: |
| 96 | + - mongodbusers |
| 97 | + - mongodb |
| 98 | + - opsmanagers |
| 99 | +
|
| 100 | +
|
| 101 | + - |
| 102 | + - ``mongodbusers`` |
| 103 | + - ``mongodb`` |
| 104 | + - ``opsmanagers`` |
90 | 105 |
|
91 |
| - * - ``registry.opsManager`` |
92 |
| - - Repository from which the |onprem| image is pulled. Specify |
93 |
| - this value if you want to pull the |onprem| image from a |
| 106 | + * - | ``registry`` |
| 107 | + | ``.appDb`` |
| 108 | +
|
| 109 | + - Repository from which the Application Database image is pulled. |
| 110 | + Specify this value if you want to pull the |onprem| image from a |
94 | 111 | private repository.
|
95 | 112 |
|
96 |
| - .. example:: |
| 113 | + .. code-block:: yaml |
| 114 | + :emphasize-lines: 2 |
97 | 115 |
|
98 |
| - .. code-block:: sh |
99 |
| - :emphasize-lines: 2 |
| 116 | + registry: |
| 117 | + appDb: quay.io/mongodb |
100 | 118 |
|
101 |
| - registry: |
102 |
| - opsManager: quay.io/mongodb |
| 119 | + - |
103 | 120 |
|
104 |
| - * - ``registry.initOpsManager`` |
105 |
| - - Repository from which the |onprem| initContainer image is pulled. |
106 |
| - This image contains the start-up scripts and readiness probe |
107 |
| - for |onprem|. |
| 121 | + * - | ``registry`` |
| 122 | + | ``.initAppDb`` |
108 | 123 |
|
109 |
| - Specify this value if you want to pull the |onprem| initContainer |
110 |
| - image from a private repository. |
| 124 | + - Repository from which the Application Database initContainer |
| 125 | + image is pulled. This image contains the start-up scripts and |
| 126 | + readiness probe for the Application Database. |
| 127 | + |
| 128 | + Specify this value if you want to pull the Application Database |
| 129 | + initContainer image from a private repository. |
111 | 130 |
|
112 | 131 | .. example::
|
113 | 132 |
|
114 |
| - .. code-block:: sh |
| 133 | + .. code-block:: yaml |
115 | 134 | :emphasize-lines: 2
|
116 | 135 |
|
117 | 136 | registry:
|
118 |
| - initOpsManager: quay.io/mongodb |
| 137 | + initAppDb: quay.io/mongodb |
119 | 138 |
|
120 |
| - * - ``registry.appDb`` |
121 |
| - - Repository from which the Application Database image is pulled. |
122 |
| - Specify this value if you want to pull the |onprem| image from a |
123 |
| - private repository. |
| 139 | + - |
| 140 | + |
| 141 | + * - | ``registry`` |
| 142 | + | ``.initOpsManager`` |
| 143 | +
|
| 144 | + - Repository from which the |onprem| initContainer image is |
| 145 | + pulled. This image contains the start-up scripts and readiness |
| 146 | + probe for |onprem|. |
| 147 | + |
| 148 | + Specify this value if you want to pull the |onprem| |
| 149 | + ``initContainer`` image from a private repository. |
124 | 150 |
|
125 | 151 | .. example::
|
126 | 152 |
|
127 |
| - .. code-block:: sh |
| 153 | + .. code-block:: yaml |
128 | 154 | :emphasize-lines: 2
|
129 | 155 |
|
130 | 156 | registry:
|
131 |
| - appDb: quay.io/mongodb |
| 157 | + initOpsManager: quay.io/mongodb |
132 | 158 |
|
133 |
| - * - ``registry.initAppDb`` |
134 |
| - - Repository from which the Application Database initContainer |
135 |
| - image is pulled. This image contains the start-up scripts and |
136 |
| - readiness probe for the Application Database. |
| 159 | + - |
137 | 160 |
|
138 |
| - Specify this value if you want to pull the Application Database |
139 |
| - initContainer image from a private repository. |
| 161 | + * - | ``registry`` |
| 162 | + | ``.operator`` |
| 163 | +
|
| 164 | + - Repository from which the |k8s-op-short| image is pulled. |
| 165 | + Specify this value if you want to pull the |k8s-op-short| image |
| 166 | + from a private repository. |
140 | 167 |
|
141 | 168 | .. example::
|
142 | 169 |
|
143 |
| - .. code-block:: sh |
| 170 | + .. code-block:: yaml |
144 | 171 | :emphasize-lines: 2
|
145 | 172 |
|
146 | 173 | registry:
|
147 |
| - initAppDb: quay.io/mongodb |
148 |
| -
|
149 |
| - * - ``operator.watchedResources`` |
150 |
| - - Custom resources that the |k8s-op-short| watches. |
151 |
| - |
152 |
| - The |k8s-op-short| installs the |k8s-crds| for and watches only |
153 |
| - the resources you specify. |
| 174 | + operator: quay.io/mongodb |
154 | 175 |
|
155 |
| - Accepted values are: |
| 176 | + - |
156 | 177 |
|
157 |
| - .. include:: /includes/list-tables/crds.rst |
| 178 | + * - | ``registry`` |
| 179 | + | ``.opsManager`` |
158 | 180 |
|
159 |
| - Default values are: ``mongodbusers``, ``mongodb``, and ``opsmanagers``. |
| 181 | + - Repository from which the |onprem| image is pulled. Specify this |
| 182 | + value if you want to pull the |onprem| image from a private |
| 183 | + repository. |
160 | 184 |
|
161 | 185 | .. example::
|
162 | 186 |
|
163 |
| - .. code-block:: sh |
| 187 | + .. code-block:: yaml |
164 | 188 | :emphasize-lines: 2
|
165 | 189 |
|
166 |
| - operator: |
167 |
| - watchedResources: |
168 |
| - - mongodbusers |
169 |
| - - mongodb |
170 |
| - - opsmanagers |
| 190 | + registry: |
| 191 | + opsManager: quay.io/mongodb |
| 192 | +
|
| 193 | + - |
| 194 | + |
| 195 | + |
0 commit comments