(DOCSP-39109): Backport DOCSP-38158 to v7.0. (#190)

corryroot · corryroot · commit ca47d85fd2ad · 2024-05-02T17:59:48.000-04:00
@NameThatFollows, I drafted the following updates for Local Mode support for MongoDB Shell 2.0.  - [DOCSP-38158](https://jira.mongodb.org/browse/DOCSP-38158) - [STAGING](https://preview-mongodbcorryroot.gatsbyjs.io/ops-manager/DOCSP-38158/tutorial/configure-local-mode/#configure-mongodb-agents-to-use-remote--hybrid--or-local-downloads) - [LATEST BUILD LOG](https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=6633d9d8b67dbf804a64090f) - [ ] [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/core/requirements.txt b/source/core/requirements.txt
@@ -1,3 +1,5 @@
+.. _om-system-reqs:
+
 ============================
 |onprem| System Requirements
 ============================
diff --git a/source/includes/api/compressed-file-response.rst b/source/includes/api/compressed-file-response.rst
@@ -1 +1 @@
-This endpoint returns either a ``zip`` or ``.tar.gz`` compressed file based on your **fileFormat** parameter.
+This endpoint returns either a ``.zip`` or ``.tar.gz`` compressed file based on your **fileFormat** parameter.
diff --git a/source/includes/install/db-tools-separate-from-server.rst b/source/includes/install/db-tools-separate-from-server.rst
@@ -1,7 +1,7 @@
 MongoDB Community and Enterprise Server installation binaries no longer
 include the :dl:`MongoDB Database Tools <database-tools>`. You must
 download and install the :dl:`MongoDB Database Tools <database-tools>`
-separately, in the ``TGZ`` format. Check the 
+separately, in the ``.tgz`` format. Check the 
 :doc:`release notes </release-notes/application>` to determine
 which version of the :dl:`MongoDB Database Tools <database-tools>` you
 should install.
diff --git a/source/includes/steps-configure-local-mode.yaml b/source/includes/steps-configure-local-mode.yaml
@@ -84,38 +84,39 @@ content: |
             .. include:: /includes/head-database-backup-deprecated.rst
 
 ---
-title: "Download the required MongoDB archives."
+title: "Download the required binaries."
 stepnum: 2
 level: 4
 ref: download-binaries
 content: |
 
+   Review the list that you prepared, in the 
+   :ref:`om-determine-binaries` section before this 
+   procedure, of the binaries that you need to store locally and 
+   download.
+
    Using a computer connected to the Internet, go to the
    :dl:`MongoDB Download Center <enterprise>` and download the MongoDB
    binary archives for the appropriate platforms and versions.
 
-   Binaries are stored as compressed archives (``TGZ`` for all platforms except Windows,  and ``ZIP`` for Windows).
+   Binaries are stored as compressed archives (``.tgz`` for all platforms except Windows,  and ``.zip`` for Windows).
 
    .. note::
 
       If you download a binary archive using Microsoft Edge, the
       archive downloads with a ``.gz`` extension instead of a ``.tgz``
       extension. Change this file extension to ``.tgz`` before continuing.
+   
+   a. Download the Community Server, Enterprise Server, or both.
 
-   If you do not have a list of which versions you require, return to
-   the :guilabel:`Prerequisites` section of this tutorial and review
-   the :guilabel:`Determine which Binaries to Store Locally and Download` section.
-
-   .. tabs::
+      .. tabs::
 
-      tabs:
-        - id: community
-          name: Community Server
-          content: |
+         .. tab:: Community Server
+            :tabid: community
 
             To download MongoDB Community Server:
 
-            a. Go to the :guilabel:`MongoDB Download Center`.
+            i. Go to the :guilabel:`MongoDB Download Center`.
 
             #. Click :guilabel:`Servers` and then click
                :dl:`MongoDB Community Server <community>`.
@@ -132,27 +133,26 @@ content: |
 
             #. In the :guilabel:`Package` dropdown menu, click the
                desired packaging for the download. By default, this
-               menu displays an archive file format: ``ZIP`` for
-               Windows, ``TGZ`` for all other platforms.
+               menu displays an archive file format: ``.zip`` for
+               Windows, ``.tgz`` for all other platforms.
 
             #. Click :guilabel:`Download`.
 
             To download an older version of the Community Server:
 
-            a. Click the :guilabel:`All Version Binaries` link to the
+            i. Click the :guilabel:`All Version Binaries` link to the
                right of the :guilabel:`Download` button.
 
             #. Download the **archive file** for each MongoDB host
                platform that |onprem| manages.
 
-        - id: enterprise
-          name: Enterprise Server
-          content: |
-
+         .. tab:: Enterprise Server
+            :tabid: enterprise
+    
             To download
             :product:`MongoDB Enterprise Server <mongodb-enterprise-advanced>`:
 
-            a. Go to the :guilabel:`MongoDB Download Center`.
+            i. Go to the :guilabel:`MongoDB Download Center`.
 
             #. Click :guilabel:`Servers` and then click
                :dl:`MongoDB Enterprise Server <enterprise>`.
@@ -169,37 +169,42 @@ content: |
 
             #. In the :guilabel:`Package` dropdown menu, click the
                desired packaging for the download. By default, this
-               menu displays an archive file format: ``ZIP`` for
-               Windows, ``TGZ`` for all other platforms.
+               menu displays an archive file format: ``.zip`` for
+               Windows, ``.tgz`` for all other platforms.
 
             #. Click :guilabel:`Download`.
 
             To download an older version of the Enterprise Server:
 
-            a. To download the older versions, click
+            i. To download the older versions, click
                :guilabel:`Archived Releases`.
 
-            b. For each platform and MongoDB version you want to
+            #. For each platform and MongoDB version you want to
                download, click the link to the right of the
                :guilabel:`Archive` label.
 
+   #. Download the :dl:`MongoDB Database Tools <database-tools>` in 
+      the ``.tgz`` format.
+
+   #. (Optional) Download :dl:`MongoDB Shell <shell>`.
+
 ---
 title: "Populate all |onprem| hosts with the necessary MongoDB binaries and archives."
 stepnum: 3
 level: 4
 ref: populate-with-binaries
 content: |
 
-  On *all* your |onprem| hosts, copy all of the archived binaries (in ``TGZ``
-  for all platforms other than Windows, or ``ZIP`` for Windows) for
-  :dl:`MongoDB Server <enterprise>` and
-  :dl:`MongoDB Database Tools <database-tools>` into the
-  :setting:`Versions Directory`. Include each platform and version of
-  these binaries that you plan to support.
+  On *all* your |onprem| hosts, copy all of the archived binaries (in ``.tgz``
+  for all platforms other than Windows, or ``.zip`` for Windows) for
+  :dl:`MongoDB Server <enterprise>`,
+  :dl:`MongoDB Database Tools <database-tools>`, and :dl:`MongoDB Shell 
+  <shell>` into the :setting:`Versions Directory`. Include each 
+  platform and version of these binaries that you plan to support.
 
   :setting:`This directory <Versions Directory>` stores all of the
-  archived and extracted binaries. |onprem| needs these binaries in the ``TGZ``
-  or ``ZIP`` formats to install and upgrade MongoDB deployments and tools.
+  archived and extracted binaries. |onprem| needs these binaries in the ``.tgz``
+  or ``.zip`` formats to install and upgrade MongoDB deployments and tools.
 
 ---
 title: "Ensure that the |mms| Linux user can read files in the Versions Directory. (Linux only)"
diff --git a/source/release-notes.txt b/source/release-notes.txt
@@ -1,3 +1,5 @@
+.. _om-release-notes:
+
 =============
 Release Notes
 =============
diff --git a/source/tutorial/configure-local-mode.txt b/source/tutorial/configure-local-mode.txt
@@ -162,16 +162,30 @@ Configure {+mdbagent+}s to Use Remote, Hybrid, or Local Downloads
    .. tab:: Local Mode
       :tabid: local
 
-      Determine which Binaries to Store Locally and Download
-      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-      For all MongoDB versions and on all :ref:`platforms <ops-manager-operating-system>`
-      that |onprem| supports, MongoDB provides :dl:`Community <community>`
-      and :dl:`Enterprise <enterprise>` installation binaries that are
-      stored as compressed ``TGZ`` archives for all platforms except Windows
-      and as ``ZIP`` archives for Windows.
+      .. _om-determine-binaries:
+
+      Determine the Binaries to Store Locally and Download
+      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+      Use this section to create a list of the binaries that you need 
+      to store locally and download.
+
+      MongoDB Server
+      ++++++++++++++
+
+      Determine the version of MongoDB Server required for 
+      deployments, including the desired operating system, 
+      architecture, and Community or Enterprise editions.
+
+      For all MongoDB versions on all :ref:`platforms 
+      <ops-manager-operating-system>` that |onprem| supports, MongoDB 
+      provides :dl:`Community <community>` and :dl:`Enterprise 
+      <enterprise>` installation binaries that it stores as compressed 
+      ``.tgz`` archives for all platforms, except Windows, and as 
+      ``.zip`` archives for Windows.
       
-      Download ``TGZ` or `ZIP`` binaries for:
+      For local mode, you must download the ``.tgz`` or ``.zip`` binaries 
+      for:
 
       - Each platform and version that your current and planned
         MongoDB deployments run.
@@ -180,59 +194,81 @@ Configure {+mdbagent+}s to Use Remote, Hybrid, or Local Downloads
         :doc:`upgrade path </tutorial/upgrade-ops-manager>` of
         any existing MongoDB deployments you want to upgrade.
 
-      .. note::
+        .. note::
 
-         If you download a binary archive using Microsoft Edge, the
-         archive downloads with a ``.gz`` extension instead of a ``.tgz``
-         extension. Change this file's extension to ``.tgz`` before continuing.
+           If you download a binary archive using Microsoft Edge, the
+           archive downloads with a ``.gz`` extension instead of a 
+           ``.tgz`` extension. Change this file's extension to ``.tgz`` 
+           before you continue.
 
-      .. example::
+        .. example::
 
-         If you import an existing deployment of MongoDB 3.4
-         Community on Ubuntu 14.04 and want to upgrade it to
-         MongoDB 4.0 Enterprise on Ubuntu 14.04, you must
-         download and store all archived (``TGZ``) binaries for:
+           If you import an existing deployment of MongoDB 3.4
+           Community on Ubuntu 14.04 and want to upgrade it to
+           MongoDB 4.0 Enterprise on Ubuntu 14.04, you must
+           download and store all archived (``.tgz``) binaries for the 
+           following versions:
 
-         - MongoDB 3.4 Community Edition
-         - MongoDB 3.6 Community Edition
-         - MongoDB 4.0 Community Edition
-         - MongoDB 4.0 Enterprise Edition
+           - MongoDB 3.4 Community Edition
+           - MongoDB 3.6 Community Edition
+           - MongoDB 4.0 Community Edition
+           - MongoDB 4.0 Enterprise Edition
 
       - If you are running backups, you need the MongoDB binary for
-        the platform on which the |onprem| :opsmgr:`Backup Daemon </reference/glossary/#std-term-backup-daemon>`
+        the platform on which the |onprem| :opsmgr:`Backup Daemon 
+        </reference/glossary/#std-term-backup-daemon>`
         runs.
 
         .. example::
 
            If you are running a MongoDB replica set on MongoDB 3.6.8
            on a set of Ubuntu hosts and running |onprem| on Windows,
-           you must download and store archived binaries of MongoDB 3.6.8 for
-           Ubuntu (``TGZ``) and for Windows (``ZIP``).
+           you must download and store archived binaries of MongoDB 
+           3.6.8 for Ubuntu (``.tgz``) and for Windows (``.zip``).
 
-      - If you are running
-        :doc:`queryable backups </tutorial/query-backup>`,
-        you need the Enterprise edition of the MongoDB version that
-        your deployment runs.
+      - If you are running :doc:`queryable backups 
+        </tutorial/query-backup>`, you need the Enterprise edition of 
+        the MongoDB version that your deployment runs.
 
         .. example::
 
            If you are running a MongoDB replica set on MongoDB 3.6.8
            on a set of Ubuntu hosts and want to query backups from
            an |onprem| install on Windows, you must download and store
-           archived binaries of MongoDB Community 3.6.8 for Ubuntu (``TGZ``)
-           and MongoDB Enterprise 3.6.8 Windows (``ZIP``).
+           archived binaries of MongoDB Community 3.6.8 for Ubuntu 
+           (``.tgz``) and MongoDB Enterprise 3.6.8 Windows (``.zip``).
 
-      - If you are running |onprem| 4.4 or later, for each platform and
-        version that you need to support, download the
-        :dl:`MongoDB Database Tools <database-tools>`in the ``TGZ`` format
-        into the :setting:`Versions Directory`. These tools include
-        :dbtools:`/mongodump` and :dbtools:`/mongorestore`.
+      MongoDB Database Tools
+      ++++++++++++++++++++++
 
-        .. note::
+      Determine the version of MongoDB Tools that your |onprem| version
+      requires. Check the :ref:`mms-changelog` to see what MongoDB 
+      Tools version your |onprem| version requires. During |onprem| 
+      upgrades, ensure you have the latest version that your new 
+      version of |onprem| requires.
+
+      For each platform and version that you need to support, 
+      you must download the :dl:`MongoDB Database Tools 
+      <database-tools>` in the ``.tgz`` format into the 
+      :setting:`Versions Directory`. These tools include 
+      :dbtools:`mongodump </mongodump>` and :dbtools:`mongorestore 
+      </mongorestore>`.
+
+      .. note::
+
+         .. include:: /includes/install/db-tools-separate-from-server.rst
+
+         .. include:: /includes/install/use-agent-install-binaries.rst
 
-           .. include:: /includes/install/db-tools-separate-from-server.rst
+      MongoDB Shell
+      +++++++++++++
 
-           .. include:: /includes/install/use-agent-install-binaries.rst
+      If you have |onprem| 7.0.5 or later, you can optionally download 
+      {+mongosh+}. Determine the {+mongosh+} version that your |onprem| 
+      version uses. Check the :ref:`mms-changelog` to see what 
+      {+mongosh+} version your |onprem| version uses. During 
+      |onprem| upgrades, ensure you have the latest version that your 
+      new version of |onprem| uses.
 
       Configure {+mdbagent+}s to Use Local Downloads
       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/source/tutorial/install-on-prem-from-archive.txt b/source/tutorial/install-on-prem-from-archive.txt
@@ -1,6 +1,6 @@
-=====================================================
-Install |onprem| from a ``tar.gz`` or ``zip`` Archive
-=====================================================
+======================================================
+Install |onprem| from a ``tar.gz`` or ``.zip`` Archive
+======================================================
 
 .. default-domain:: mongodb
 
@@ -11,7 +11,7 @@ Install |onprem| from a ``tar.gz`` or ``zip`` Archive
    :class: singlecol
 
 This tutorial describes how to install |onprem| to Linux servers from a
-``tar.gz`` or ``zip`` archive. If you are instead upgrading an existing
+``tar.gz`` or ``.zip`` archive. If you are instead upgrading an existing
 deployment, please see :doc:`/tutorial/upgrade-ops-manager`.
 
 .. What is the role of the "root" user vs "mongodb-mms" user in an Ops Manager install
diff --git a/source/tutorial/start-and-stop-application.txt b/source/tutorial/start-and-stop-application.txt
@@ -15,7 +15,7 @@ Start the |mms| Server
 
 .. note::
 
-   If you installed from a ``tar.gz`` or ``zip`` archive, you must create
+   If you installed from a ``tar.gz`` or ``.zip`` archive, you must create
    a symlink located at the path ``/etc/init.d/mongodb-mms`` that points
    to the ``<install_dir>/bin/mongodb-mms``.
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _om-system-reqs:`
	`2`	`+`
`1`	`3`	`============================`
`2`	`4`	`\|onprem\| System Requirements`
`3`	`5`	`============================`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-This endpoint returns either a ``zip`` or ``.tar.gz`` compressed file based on your fileFormat parameter.
	`1`	+This endpoint returns either a ``.zip`` or ``.tar.gz`` compressed file based on your fileFormat parameter.
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _om-release-notes:`
	`2`	`+`
`1`	`3`	`=============`
`2`	`4`	`Release Notes`
`3`	`5`	`=============`