(DOCSP-45424) Backporting changes from DOCSP-34257 on cloud-docs to OM v7.0 (#629)

amalhotra-mdb · web-flow · commit 2ae8887e0014 · 2024-12-19T11:43:06.000-05:00
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.
diff --git a/source/includes/steps-admin-edit-s3-blockstore.yaml b/source/includes/steps-admin-edit-s3-blockstore.yaml
@@ -11,46 +11,58 @@ ref: select-blockstore
 ---
 stepnum: 3
 level: 4
-title: "Update any values that need to be changed."
+title: "Update any editable values that need to be changed."
 ref: edit-blockstore
 content: |
 
-  In the :guilabel:`MongoDB Connection` column, update any values that
+  In the :guilabel:`MongoDB Connection` column, update any editable values that
   need to be changed in the following fields:
 
+
   .. list-table::
-     :widths: 20 10 70
+     :widths: 20 10 10 60
      :header-rows: 1
      :stub-columns: 1
 
      * - Field
        - Necessity
+       - Editable
        - Contents
 
+
      * - S3 Bucket Name
        - Required
+       - no
        - Type the name of the |s3| bucket where you want to host the
          the |s3ss|.
 
+
      * - Region Override
        - Conditional
+       - yes
        - Type the region where your |s3| bucket resides.
 
          Use this field only if your |s3| store's 
          **S3 Endpoint** doesn't support region scoping. Don't provide 
          a value for this field with |aws| S3 buckets.
 
+
      * - S3 Endpoint
        - Required
+       - yes
        - Type the |url| for this |s3| bucket.
 
+
      * - S3 Max Connections
        - Required
+       - yes
        - Type a positive integer indicating the maximum number of
          connections to this |s3| bucket.
 
+
      * - Path Style Access
        - Optional
+       - yes
        - Click if you want your |s3| bucket
          to use a path-style |url| endpoint
          (``s3.amazonaws.com/<bucket>``) instead of a
@@ -61,14 +73,18 @@ content: |
          |url| conventions, see the
          :aws:`AWS S3 documentation </AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro>`
 
+
      * - Server Side Encryption
        - Optional
+       - yes
        - Click to enable :aws:`server-side encryption
          </AmazonS3/latest/dev/UsingServerSideEncryption.html>`.
          Clear to disable server-side encryption.
 
+
      * - S3 Authorization Mode
        - Required
+       - yes
        - Select the method used to authorize access to the |s3| bucket
          specified in :guilabel:`S3 Bucket Name`.
 
@@ -85,21 +101,27 @@ content: |
                 your |s3| bucket. :guilabel:`AWS Access Key` and
                 :guilabel:`AWS Secret Key` fields are ignored.
 
+
      * - Keys with Custom CA Bundle
        - Conditional
+       - yes
        - Click :guilabel:`Choose file` to add a custom |certauth|
          chain. This chain can validate against a self-signed
          certificate on the |s3| bucket.
 
+
      * - AWS Access Key
        - Conditional
+       - yes
        - Type your |aws| Access Key ID.
 
          |mms| displays this field when you set
          :guilabel:`S3 Authorization Mode` to :guilabel:`Keys`.
 
+
      * - AWS Secret Key
        - Conditional
+       - yes
        - Type your |aws| Secret Access Key.
 
          |mms| displays this field when you set
@@ -110,6 +132,7 @@ content: |
 
      * - <hostname>:<port>
        - Required
+       - yes
        - Type in one or more hosts that comprise the |s3| Snapshot
          Store metadata database in the ``<hostname:port>`` format.
 
@@ -131,12 +154,14 @@ content: |
 
      * - MongoDB Auth Username
        - Optional
+       - yes
        - If you set this value:
 
          .. include:: /includes/tabsets/storage-settings-username.rst
 
      * - MongoDB Auth Password
        - Optional
+       - yes
        - If you set this value:
 
          .. include:: /includes/tabsets/storage-settings-password.rst
@@ -154,37 +179,46 @@ content: |
 
      * - Encrypted Credentials
        - Optional
+       - yes
        - Select if the credentials for the database were encrypted
          using the
          :doc:`credentialstool </tutorial/encrypt-user-credentials>`.
          The credentials include the Username, Password, |aws| Access
          Key ID and |aws| Secret Key.
 
+
      * - Use TLS/SSL
        - Optional
+       - yes
        - Select if the blockstore database only accepts connection
          encrypted using |tls|.
 
          Beyond this checkbox, to connect this |s3ss|
          using |tls|, you must enable
          :manual:`TLS on the S3 blockstore database </tutorial/configure-ssl>`.
 
+
      * - Connection Options
        - Optional
+       - yes
        - Type any additional :manual:`configuration file options
          </reference/configuration-options>` for the MongoDB instance.
          This field supports unescaped values only.
 
          For proper syntax, see :manual:`Connection String URI
          Format </reference/connection-string>` in the MongoDB manual.
 
+
      * - Assignment Labels
        - Optional
+       - yes
        - Type a comma-separated list of labels to assign the
          S3 blockstores to specific projects.
 
+
      * - Load Factor
        - Optional
+       - yes
        - Type any positive integer that expresses how much backup work
          you want this snapshot store to perform compared to another
          snapshot store.
@@ -263,6 +297,7 @@ content: |
 
      * - Write Concern
        - Required
+       - yes
        - Select your preferred
          :manual:`Write Concern</core/write-concern/>`:
 
diff --git a/source/includes/steps-admin-edit-s3-oplogstore.yaml b/source/includes/steps-admin-edit-s3-oplogstore.yaml
@@ -11,46 +11,57 @@ ref: select-oplogstore
 ---
 stepnum: 3
 level: 4
-title: "Update any values that need to be changed."
+title: "Update any editable values that need to be changed."
 ref: edit-oplog store
 content: |
 
-  In the :guilabel:`MongoDB Connection` column, update any values that
+  In the :guilabel:`MongoDB Connection` column, update any editable values that
   need to be changed in the following fields:
 
   .. list-table::
-     :widths: 20 10 70
+     :widths: 20 10 10 60
      :header-rows: 1
      :stub-columns: 1
 
      * - Field
        - Necessity
+       - Editable
        - Contents
 
+
      * - S3 Bucket Name
        - Required
+       - no
        - Enter the name of the |s3| bucket where you want to host the
          the |s3os|.
 
+
      * - Region Override
        - Conditional
+       - yes
        - Type the region where your |s3| bucket resides.
 
          Use this field only if your |s3| store's 
          **S3 Endpoint** doesn't support region scoping. Don't provide 
          a value for this field with |aws| S3 buckets.
 
+
      * - S3 Endpoint
        - Required
+       - no
        - Enter the |url| for this |s3| bucket.
 
+
      * - S3 Max Connections
        - Required
+       - yes
        - Enter a positive integer indicating the maximum number of
          connections to this |s3| bucket.
 
+
      * - Path Style Access
        - Optional
+       - yes
        - Click if you want your |s3| bucket
          to use a path-style |url| endpoint
          (``s3.amazonaws.com/<bucket>``) instead of a
@@ -61,14 +72,18 @@ content: |
          |url| conventions, see the
          :aws:`AWS S3 documentation </AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro>`
 
+
      * - Server Side Encryption
        - Optional
+       - yes
        - Click to enable :aws:`server-side encryption
          </AmazonS3/latest/dev/UsingServerSideEncryption.html>`.
          Clear to disable server-side encryption.
 
+
      * - S3 Authorization Mode
        - Required
+       - yes 
        - Select the method used to authorize access to the |s3| bucket
          specified in :guilabel:`S3 Bucket Name`.
 
@@ -87,30 +102,38 @@ content: |
                 learn more, see the :aws:`AWS documentation
                 </AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#attach-iam-role>`
 
+
      * - Keys with Custom CA Bundle
        - Conditional
+       - yes
        - Click :guilabel:`Choose file` to add a custom |certauth|
          chain. This chain can validate against a self-signed
          certificate on the |s3| bucket.
 
+
      * - AWS Access Key
        - Conditional
+       - yes
        - Enter your |aws| Access Key ID.
 
          |mms| displays this field when you set
          :guilabel:`S3 Authorization Mode` to :guilabel:`Keys`.
 
+
      * - AWS Secret Key
        - Conditional
+       - yes
        - Enter your |aws| Secret Access Key.
 
          |mms| displays this field when you set
          :guilabel:`S3 Authorization Mode` to :guilabel:`Keys`.
 
          |mms| doesn't display the existing :guilabel:`AWS Secret Key`.       
 
+
      * - <hostname>:<port>
        - Required
+       - yes
        - Enter in one or more hosts that comprise the |s3| Snapshot
          Store metadata database in the ``<hostname:port>`` format.
 
@@ -153,12 +176,15 @@ content: |
 
      * - MongoDB Auth Username
        - Optional
+       - yes
        - If you set this value:
 
          .. include:: /includes/tabsets/storage-settings-username.rst
 
+
      * - MongoDB Auth Password
        - Optional
+       - yes
        - If you set this value:
 
          .. include:: /includes/tabsets/storage-settings-password.rst
@@ -168,8 +194,10 @@ content: |
 
          .. include:: /includes/warning-plaintext-password.rst
 
+
      * - Encrypted Credentials
        - Optional
+       - yes
        - Select if the credentials for the database were encrypted
          using the
          :doc:`credentialstool </tutorial/encrypt-user-credentials>`.
@@ -178,15 +206,18 @@ content: |
 
      * - Use |tls-ssl|
        - Optional
+       - yes
        - Select if the |s3os| database only accepts connection
          encrypted using |tls|.
 
          Beyond this checkbox, to connect this |s3os|
          using |tls|, you must enable
          :manual:`TLS on the S3 oplog store database </tutorial/configure-ssl>`.
 
+
      * - Connection Options
        - Optional
+       - yes
        - Enter any additional :manual:`configuration file options
          </reference/configuration-options>` for the MongoDB instance.
          This field supports unescaped values only.
@@ -195,18 +226,23 @@ content: |
          URI Format </reference/connection-string>` in the MongoDB
          manual.
 
+
      * - Assignment Labels
        - Optional
+       - yes
        - Enter a comma-separated list of labels to assign the
          |s3os|\s to specific projects.
 
+
      * - Write Concern
        - Required
+       - yes
        - Select your preferred
          :manual:`Write Concern</core/write-concern/>`:
 
          .. include:: /includes/list-tables/write-concerns.rst
 
+
 ---
 stepnum: 4
 level: 4
