Skip to content

Commit 2ae8887

Browse files
(DOCSP-45424) Backporting changes from DOCSP-34257 on cloud-docs to OM v7.0 (#629)
<!-- Add a description of your PR here (optional) --> As part of DOCSP-45424, it was requested that we include the "editable" column in our OM docs v7.0, rather than only in 8.0 onwards. To do so, this is a backport of [the PR](https://github.com/10gen/mms-docs/pull/5319/files) that originally created the "editable" column, originally in the cloud-docs repo. - [DOCSP-45424](https://jira.mongodb.org/browse/DOCSP-45424) - [STAGING](https://deploy-preview-629--10gen-docs-ops-manager.netlify.app/tutorial/manage-s3-blockstore-storage/#edit-one-existing-s3-compatible-snapshot-store) - [LATEST BUILD LOG](https://app.netlify.com/sites/10gen-docs-ops-manager/deploys/676447fe086a4c00084850f1) ### Self-Review Checklist - [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [ ] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [ ] Resolve any new warnings or errors in the build. - [ ] Proofread for spelling and grammatical errors. - [ ] Check staging for rendering issues. - [ ] Confirm links are working.
1 parent 4ee2975 commit 2ae8887

File tree

2 files changed

+77
-6
lines changed

2 files changed

+77
-6
lines changed

source/includes/steps-admin-edit-s3-blockstore.yaml

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,46 +11,58 @@ ref: select-blockstore
1111
---
1212
stepnum: 3
1313
level: 4
14-
title: "Update any values that need to be changed."
14+
title: "Update any editable values that need to be changed."
1515
ref: edit-blockstore
1616
content: |
1717
18-
In the :guilabel:`MongoDB Connection` column, update any values that
18+
In the :guilabel:`MongoDB Connection` column, update any editable values that
1919
need to be changed in the following fields:
2020
21+
2122
.. list-table::
22-
:widths: 20 10 70
23+
:widths: 20 10 10 60
2324
:header-rows: 1
2425
:stub-columns: 1
2526
2627
* - Field
2728
- Necessity
29+
- Editable
2830
- Contents
2931
32+
3033
* - S3 Bucket Name
3134
- Required
35+
- no
3236
- Type the name of the |s3| bucket where you want to host the
3337
the |s3ss|.
3438
39+
3540
* - Region Override
3641
- Conditional
42+
- yes
3743
- Type the region where your |s3| bucket resides.
3844
3945
Use this field only if your |s3| store's
4046
**S3 Endpoint** doesn't support region scoping. Don't provide
4147
a value for this field with |aws| S3 buckets.
4248
49+
4350
* - S3 Endpoint
4451
- Required
52+
- yes
4553
- Type the |url| for this |s3| bucket.
4654
55+
4756
* - S3 Max Connections
4857
- Required
58+
- yes
4959
- Type a positive integer indicating the maximum number of
5060
connections to this |s3| bucket.
5161
62+
5263
* - Path Style Access
5364
- Optional
65+
- yes
5466
- Click if you want your |s3| bucket
5567
to use a path-style |url| endpoint
5668
(``s3.amazonaws.com/<bucket>``) instead of a
@@ -61,14 +73,18 @@ content: |
6173
|url| conventions, see the
6274
:aws:`AWS S3 documentation </AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro>`
6375
76+
6477
* - Server Side Encryption
6578
- Optional
79+
- yes
6680
- Click to enable :aws:`server-side encryption
6781
</AmazonS3/latest/dev/UsingServerSideEncryption.html>`.
6882
Clear to disable server-side encryption.
6983
84+
7085
* - S3 Authorization Mode
7186
- Required
87+
- yes
7288
- Select the method used to authorize access to the |s3| bucket
7389
specified in :guilabel:`S3 Bucket Name`.
7490
@@ -85,21 +101,27 @@ content: |
85101
your |s3| bucket. :guilabel:`AWS Access Key` and
86102
:guilabel:`AWS Secret Key` fields are ignored.
87103
104+
88105
* - Keys with Custom CA Bundle
89106
- Conditional
107+
- yes
90108
- Click :guilabel:`Choose file` to add a custom |certauth|
91109
chain. This chain can validate against a self-signed
92110
certificate on the |s3| bucket.
93111
112+
94113
* - AWS Access Key
95114
- Conditional
115+
- yes
96116
- Type your |aws| Access Key ID.
97117
98118
|mms| displays this field when you set
99119
:guilabel:`S3 Authorization Mode` to :guilabel:`Keys`.
100120
121+
101122
* - AWS Secret Key
102123
- Conditional
124+
- yes
103125
- Type your |aws| Secret Access Key.
104126
105127
|mms| displays this field when you set
@@ -110,6 +132,7 @@ content: |
110132
111133
* - <hostname>:<port>
112134
- Required
135+
- yes
113136
- Type in one or more hosts that comprise the |s3| Snapshot
114137
Store metadata database in the ``<hostname:port>`` format.
115138
@@ -131,12 +154,14 @@ content: |
131154
132155
* - MongoDB Auth Username
133156
- Optional
157+
- yes
134158
- If you set this value:
135159
136160
.. include:: /includes/tabsets/storage-settings-username.rst
137161
138162
* - MongoDB Auth Password
139163
- Optional
164+
- yes
140165
- If you set this value:
141166
142167
.. include:: /includes/tabsets/storage-settings-password.rst
@@ -154,37 +179,46 @@ content: |
154179
155180
* - Encrypted Credentials
156181
- Optional
182+
- yes
157183
- Select if the credentials for the database were encrypted
158184
using the
159185
:doc:`credentialstool </tutorial/encrypt-user-credentials>`.
160186
The credentials include the Username, Password, |aws| Access
161187
Key ID and |aws| Secret Key.
162188
189+
163190
* - Use TLS/SSL
164191
- Optional
192+
- yes
165193
- Select if the blockstore database only accepts connection
166194
encrypted using |tls|.
167195
168196
Beyond this checkbox, to connect this |s3ss|
169197
using |tls|, you must enable
170198
:manual:`TLS on the S3 blockstore database </tutorial/configure-ssl>`.
171199
200+
172201
* - Connection Options
173202
- Optional
203+
- yes
174204
- Type any additional :manual:`configuration file options
175205
</reference/configuration-options>` for the MongoDB instance.
176206
This field supports unescaped values only.
177207
178208
For proper syntax, see :manual:`Connection String URI
179209
Format </reference/connection-string>` in the MongoDB manual.
180210
211+
181212
* - Assignment Labels
182213
- Optional
214+
- yes
183215
- Type a comma-separated list of labels to assign the
184216
S3 blockstores to specific projects.
185217
218+
186219
* - Load Factor
187220
- Optional
221+
- yes
188222
- Type any positive integer that expresses how much backup work
189223
you want this snapshot store to perform compared to another
190224
snapshot store.
@@ -263,6 +297,7 @@ content: |
263297
264298
* - Write Concern
265299
- Required
300+
- yes
266301
- Select your preferred
267302
:manual:`Write Concern</core/write-concern/>`:
268303

source/includes/steps-admin-edit-s3-oplogstore.yaml

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,46 +11,57 @@ ref: select-oplogstore
1111
---
1212
stepnum: 3
1313
level: 4
14-
title: "Update any values that need to be changed."
14+
title: "Update any editable values that need to be changed."
1515
ref: edit-oplog store
1616
content: |
1717
18-
In the :guilabel:`MongoDB Connection` column, update any values that
18+
In the :guilabel:`MongoDB Connection` column, update any editable values that
1919
need to be changed in the following fields:
2020
2121
.. list-table::
22-
:widths: 20 10 70
22+
:widths: 20 10 10 60
2323
:header-rows: 1
2424
:stub-columns: 1
2525
2626
* - Field
2727
- Necessity
28+
- Editable
2829
- Contents
2930
31+
3032
* - S3 Bucket Name
3133
- Required
34+
- no
3235
- Enter the name of the |s3| bucket where you want to host the
3336
the |s3os|.
3437
38+
3539
* - Region Override
3640
- Conditional
41+
- yes
3742
- Type the region where your |s3| bucket resides.
3843
3944
Use this field only if your |s3| store's
4045
**S3 Endpoint** doesn't support region scoping. Don't provide
4146
a value for this field with |aws| S3 buckets.
4247
48+
4349
* - S3 Endpoint
4450
- Required
51+
- no
4552
- Enter the |url| for this |s3| bucket.
4653
54+
4755
* - S3 Max Connections
4856
- Required
57+
- yes
4958
- Enter a positive integer indicating the maximum number of
5059
connections to this |s3| bucket.
5160
61+
5262
* - Path Style Access
5363
- Optional
64+
- yes
5465
- Click if you want your |s3| bucket
5566
to use a path-style |url| endpoint
5667
(``s3.amazonaws.com/<bucket>``) instead of a
@@ -61,14 +72,18 @@ content: |
6172
|url| conventions, see the
6273
:aws:`AWS S3 documentation </AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro>`
6374
75+
6476
* - Server Side Encryption
6577
- Optional
78+
- yes
6679
- Click to enable :aws:`server-side encryption
6780
</AmazonS3/latest/dev/UsingServerSideEncryption.html>`.
6881
Clear to disable server-side encryption.
6982
83+
7084
* - S3 Authorization Mode
7185
- Required
86+
- yes
7287
- Select the method used to authorize access to the |s3| bucket
7388
specified in :guilabel:`S3 Bucket Name`.
7489
@@ -87,30 +102,38 @@ content: |
87102
learn more, see the :aws:`AWS documentation
88103
</AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#attach-iam-role>`
89104
105+
90106
* - Keys with Custom CA Bundle
91107
- Conditional
108+
- yes
92109
- Click :guilabel:`Choose file` to add a custom |certauth|
93110
chain. This chain can validate against a self-signed
94111
certificate on the |s3| bucket.
95112
113+
96114
* - AWS Access Key
97115
- Conditional
116+
- yes
98117
- Enter your |aws| Access Key ID.
99118
100119
|mms| displays this field when you set
101120
:guilabel:`S3 Authorization Mode` to :guilabel:`Keys`.
102121
122+
103123
* - AWS Secret Key
104124
- Conditional
125+
- yes
105126
- Enter your |aws| Secret Access Key.
106127
107128
|mms| displays this field when you set
108129
:guilabel:`S3 Authorization Mode` to :guilabel:`Keys`.
109130
110131
|mms| doesn't display the existing :guilabel:`AWS Secret Key`.
111132
133+
112134
* - <hostname>:<port>
113135
- Required
136+
- yes
114137
- Enter in one or more hosts that comprise the |s3| Snapshot
115138
Store metadata database in the ``<hostname:port>`` format.
116139
@@ -153,12 +176,15 @@ content: |
153176
154177
* - MongoDB Auth Username
155178
- Optional
179+
- yes
156180
- If you set this value:
157181
158182
.. include:: /includes/tabsets/storage-settings-username.rst
159183
184+
160185
* - MongoDB Auth Password
161186
- Optional
187+
- yes
162188
- If you set this value:
163189
164190
.. include:: /includes/tabsets/storage-settings-password.rst
@@ -168,8 +194,10 @@ content: |
168194
169195
.. include:: /includes/warning-plaintext-password.rst
170196
197+
171198
* - Encrypted Credentials
172199
- Optional
200+
- yes
173201
- Select if the credentials for the database were encrypted
174202
using the
175203
:doc:`credentialstool </tutorial/encrypt-user-credentials>`.
@@ -178,15 +206,18 @@ content: |
178206
179207
* - Use |tls-ssl|
180208
- Optional
209+
- yes
181210
- Select if the |s3os| database only accepts connection
182211
encrypted using |tls|.
183212
184213
Beyond this checkbox, to connect this |s3os|
185214
using |tls|, you must enable
186215
:manual:`TLS on the S3 oplog store database </tutorial/configure-ssl>`.
187216
217+
188218
* - Connection Options
189219
- Optional
220+
- yes
190221
- Enter any additional :manual:`configuration file options
191222
</reference/configuration-options>` for the MongoDB instance.
192223
This field supports unescaped values only.
@@ -195,18 +226,23 @@ content: |
195226
URI Format </reference/connection-string>` in the MongoDB
196227
manual.
197228
229+
198230
* - Assignment Labels
199231
- Optional
232+
- yes
200233
- Enter a comma-separated list of labels to assign the
201234
|s3os|\s to specific projects.
202235
236+
203237
* - Write Concern
204238
- Required
239+
- yes
205240
- Select your preferred
206241
:manual:`Write Concern</core/write-concern/>`:
207242
208243
.. include:: /includes/list-tables/write-concerns.rst
209244
245+
210246
---
211247
stepnum: 4
212248
level: 4

0 commit comments

Comments
 (0)