From 5b8fe4364b78c87196f7d9b9de915faf55ab6ce8 Mon Sep 17 00:00:00 2001 From: Andrew Aldridge Date: Mon, 11 Jan 2016 13:55:54 -0500 Subject: [PATCH] DOCS-6753: Document OS X and SLES 12 Enterprise installation --- source/includes/fact-platforms.rst | 8 ++++- source/includes/note-suse-ulimit.rst | 8 ++--- source/includes/release-base.yaml | 11 ++++++ source/includes/release-specifications.yaml | 16 +++++++++ ...ps-install-mongodb-enterprise-on-os-x.yaml | 34 +++++++++++++++++++ ...ps-install-mongodb-enterprise-on-suse.yaml | 20 ++++++++--- .../steps-install-mongodb-on-suse.yaml | 8 ++--- .../includes/toc-installation-enterprise.yaml | 4 +++ source/includes/toc-spec-installation.yaml | 5 +++ .../install-mongodb-enterprise-on-os-x.txt | 28 +++++++++++++++ .../install-mongodb-enterprise-on-suse.txt | 2 +- source/tutorial/install-mongodb-on-os-x.txt | 2 +- 12 files changed, 130 insertions(+), 16 deletions(-) create mode 100644 source/includes/steps-install-mongodb-enterprise-on-os-x.yaml create mode 100644 source/tutorial/install-mongodb-enterprise-on-os-x.txt diff --git a/source/includes/fact-platforms.rst b/source/includes/fact-platforms.rst index 861b7739d25..891bb90f2fd 100644 --- a/source/includes/fact-platforms.rst +++ b/source/includes/fact-platforms.rst @@ -39,12 +39,18 @@ - |checkmark| - - - * - SLES 11+ + * - SLES 11 - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| + * - SLES 12 + - |checkmark| + - + - + - + - * - Solaris 64-bit - |checkmark| - |checkmark| diff --git a/source/includes/note-suse-ulimit.rst b/source/includes/note-suse-ulimit.rst index 46b1e7c9108..e3cd9576c66 100644 --- a/source/includes/note-suse-ulimit.rst +++ b/source/includes/note-suse-ulimit.rst @@ -1,9 +1,9 @@ .. note:: - SUSE Linux Enterprise Server 11 and potentially other versions of SLES and - other SUSE distributions ship with virtual memory address space limited to 8 - GB by default. This *must* be adjusted in order to prevent virtual memory - allocation failures as the database grows. + SUSE Linux Enterprise Server and potentially other SUSE distributions ship + with virtual memory address space limited to 8 GB by default. You *must* + adjust this in order to prevent virtual memory allocation failures as the + database grows. The SLES packages for MongoDB adjust these limits in the default scripts, but you will need to make this change manually if you are using custom diff --git a/source/includes/release-base.yaml b/source/includes/release-base.yaml index 9d9af7125b2..499bc24cf5e 100644 --- a/source/includes/release-base.yaml +++ b/source/includes/release-base.yaml @@ -9,11 +9,22 @@ code: | mkdir -p mongodb cp -R -n mongodb-{{platform}}-{{builder}}-{{version}}/ mongodb --- +ref: _copy-release-ent +language: 'sh' +code: | + mkdir -p mongodb + cp -R -n mongodb-{{platform}}-{{builder}}-enterprise-{{version}}/ mongodb +--- ref: _untar-release language: 'sh' code: | tar -zxvf mongodb-{{platform}}-{{builder}}-{{version}}.tgz --- +ref: _untar-release-ent +language: 'sh' +code: | + tar -zxvf mongodb-{{platform}}-{{builder}}-enterprise-{{version}}.tgz +--- ref: _curl-release-ent language: 'sh' code: | diff --git a/source/includes/release-specifications.yaml b/source/includes/release-specifications.yaml index 4cc4dbf8804..7124d5b0c78 100644 --- a/source/includes/release-specifications.yaml +++ b/source/includes/release-specifications.yaml @@ -46,6 +46,14 @@ replacement: platform: 'osx' builder: 'x86_64' --- +ref: copy-release-ent-osx-x86_64 +source: + file: release-base.yaml + ref: _copy-release-ent +replacement: + platform: 'osx' + builder: 'x86_64' +--- ref: untar-release-linux-i686 source: file: release-base.yaml @@ -70,6 +78,14 @@ replacement: platform: 'osx' builder: 'x86_64' --- +ref: untar-release-ent-osx-x86_64 +source: + file: release-base.yaml + ref: _untar-release-ent +replacement: + platform: 'osx' + builder: 'x86_64' +--- ref: curl-release-ent-suse11 source: source: diff --git a/source/includes/steps-install-mongodb-enterprise-on-os-x.yaml b/source/includes/steps-install-mongodb-enterprise-on-os-x.yaml new file mode 100644 index 00000000000..4b9c026137a --- /dev/null +++ b/source/includes/steps-install-mongodb-enterprise-on-os-x.yaml @@ -0,0 +1,34 @@ +stepnum: 1 +ref: download-mongodb-enterprise +level: 4 +action: + pre: | + Download the latest production release of `MongoDB Enterprise + `_. +--- +stepnum: 2 +level: 4 +source: + file: steps-install-mongodb-on-linux.yaml + ref: extract +# The content of the following include is autogenerated: +action: + pre: | + .. include:: /includes/release/untar-release-ent-osx-x86_64.rst +--- +stepnum: 3 +level: 4 +source: + file: steps-install-mongodb-on-linux.yaml + ref: copy-archive +# The content of the following include is autogenerated: +action: + pre: | + .. include:: /includes/release/copy-release-ent-osx-x86_64.rst +--- +stepnum: 4 +level: 4 +source: + file: steps-install-mongodb-on-linux.yaml + ref: ensure-binaries-in-path +... diff --git a/source/includes/steps-install-mongodb-enterprise-on-suse.yaml b/source/includes/steps-install-mongodb-enterprise-on-suse.yaml index 2ca4310df57..5bf60dc3400 100644 --- a/source/includes/steps-install-mongodb-enterprise-on-suse.yaml +++ b/source/includes/steps-install-mongodb-enterprise-on-suse.yaml @@ -5,15 +5,25 @@ pre: | Add the repository so that you can install MongoDB using ``zypper``. action: - pre: | - Use the following command to specify the latest stable release of MongoDB. - language: sh - code: | - sudo zypper addrepo --no-gpgcheck https://repo.mongodb.com/zypper/suse/11/mongodb-enterprise/stable/x86_64/ mongodb + Specify the latest stable release of MongoDB using the command + appropriate for your version of SUSE: + + SUSE 11 + + .. code-block:: sh + + sudo zypper addrepo --no-gpgcheck "https://repo.mongodb.com/zypper/suse/11/mongodb-enterprise/stable/x86_64/" mongodb + + SUSE 12 + + .. code-block:: sh + + sudo zypper addrepo --no-gpgcheck "https://repo.mongodb.com/zypper/suse/12/mongodb-enterprise/stable/x86_64/" mongodb - pre: | If you'd like to install MongoDB packages from a previous :ref:`release series `, such as 2.6, you can specify the release series in the repository configuration. For - example, to restrict your system to the 2.6 release series, + example, to restrict your SUSE 11 system to the 2.6 release series, use the following command: language: sh code: | diff --git a/source/includes/steps-install-mongodb-on-suse.yaml b/source/includes/steps-install-mongodb-on-suse.yaml index 2dda8b2997f..1f6cb282e49 100644 --- a/source/includes/steps-install-mongodb-on-suse.yaml +++ b/source/includes/steps-install-mongodb-on-suse.yaml @@ -14,17 +14,17 @@ action: Use the following command: language: sh code: | - sudo zypper addrepo --no-gpgcheck https://repo.mongodb.org/zypper/suse/11/mongodb-org/3.2/x86_64/ mongodb + sudo zypper addrepo --no-gpgcheck https://repo.mongodb.org/zypper/suse/$(sed -rn 's/VERSION=.*([0-9]{2}).*/\1/p' /etc/os-release)/mongodb-org/3.2/x86_64/ mongodb - heading: For versions of MongoDB *earlier* than 3.2 pre: | To install MongoDB packages from a previous :ref:`release - series `, such as 2.6, you can + series `, such as 3.0, you can specify the release series in the repository configuration. For - example, to restrict your system to the 2.6 release series, + example, to restrict your SUSE 11 system to the 3.0 release series, use the following command: language: sh code: | - sudo zypper addrepo --no-gpgcheck http://downloads-distro.mongodb.org/repo/suse/os/x86_64/ mongodb + sudo zypper addrepo --no-gpgcheck https://repo.mongodb.org/zypper/suse/11/mongodb-org/3.0/x86_64/ mongodb --- title: Install the MongoDB packages and associated tools. stepnum: 2 diff --git a/source/includes/toc-installation-enterprise.yaml b/source/includes/toc-installation-enterprise.yaml index 0130dc7fb02..97f149c385f 100644 --- a/source/includes/toc-installation-enterprise.yaml +++ b/source/includes/toc-installation-enterprise.yaml @@ -3,6 +3,10 @@ name: Install on Linux description: | Install the official builds of MongoDB Enterprise on Linux-based systems. --- +file: /tutorial/install-mongodb-enterprise-on-os-x +name: Install on OS X +description: "Install the official build of MongoDB Enterprise on OS X" +--- file: /tutorial/install-mongodb-enterprise-on-windows name: Install on Windows description: | diff --git a/source/includes/toc-spec-installation.yaml b/source/includes/toc-spec-installation.yaml index 640287517bf..bcc6b75a349 100644 --- a/source/includes/toc-spec-installation.yaml +++ b/source/includes/toc-spec-installation.yaml @@ -74,6 +74,11 @@ source: ref: /tutorial/install-mongodb-enterprise-on-amazon --- level: 2 +source: + file: toc-installation-enterprise.yaml + ref: /tutorial/install-mongodb-enterprise-on-os-x +--- +level: 2 source: file: toc-installation-enterprise.yaml ref: /tutorial/install-mongodb-enterprise-on-windows diff --git a/source/tutorial/install-mongodb-enterprise-on-os-x.txt b/source/tutorial/install-mongodb-enterprise-on-os-x.txt new file mode 100644 index 00000000000..52000c5a3c6 --- /dev/null +++ b/source/tutorial/install-mongodb-enterprise-on-os-x.txt @@ -0,0 +1,28 @@ +================================== +Install MongoDB Enterprise on OS X +================================== + +.. default-domain:: mongodb + +Overview +-------- + +Use this tutorial to install :products:`MongoDB Enterprise +` on OS X systems. MongoDB Enterprise +is available on select platforms and contains support for several features +related to security and monitoring. + +.. admonition:: Platform Support + + MongoDB only supports OS X versions 10.7 (Lion) and later on Intel x86-64. + Versions of MongoDB Enterprise prior to 3.2 did not support OS X. + +Install MongoDB Enterprise +-------------------------- + +.. include:: /includes/steps/install-mongodb-enterprise-on-os-x.rst + +Run MongoDB Enterprise +---------------------- + +.. include:: /includes/steps/run-mongodb-on-linux.rst diff --git a/source/tutorial/install-mongodb-enterprise-on-suse.txt b/source/tutorial/install-mongodb-enterprise-on-suse.txt index fcc5a49ac16..3635a550a11 100644 --- a/source/tutorial/install-mongodb-enterprise-on-suse.txt +++ b/source/tutorial/install-mongodb-enterprise-on-suse.txt @@ -28,7 +28,7 @@ Considerations -------------- MongoDB only provides Enterprise packages for 64-bit builds of SUSE -Enterprise Linux version 11. +Enterprise Linux versions 11 and 12. .. include:: /includes/fact-use-distribution-package.rst diff --git a/source/tutorial/install-mongodb-on-os-x.txt b/source/tutorial/install-mongodb-on-os-x.txt index e9616d0aec1..7e2d83cb751 100644 --- a/source/tutorial/install-mongodb-on-os-x.txt +++ b/source/tutorial/install-mongodb-on-os-x.txt @@ -18,7 +18,7 @@ Use this tutorial to install MongoDB Community Edition on OS X systems. .. admonition:: Platform Support Starting in version 3.0, MongoDB only supports OS X versions 10.7 (Lion) - on Intel x86-64 and later. + and later on Intel x86-64. MongoDB Community Edition is available through the popular OS X package manager `Homebrew `_ or through the `MongoDB Download site