Skip to content

Commit 10750fb

Browse files
jvincent-mongodbjvincent-mongodb
authored
DOCSP-38362v7.0 -- backport to v7.0 (#236)
backport to v7.0 - [DOCSP-number](https://jira.mongodb.org/browse/DOCSP-38362) - [STAGING](https://preview-mongodbjvincentmongodb.gatsbyjs.io/ops-manager/DOCSP-38362v7.0/) - [LATEST BUILD LOG](https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=665e2caccf5bec1c291348cb) ### 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 a8d1b46 commit 10750fb

20 files changed

+195
-2
lines changed

‎source/api.txt

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,43 @@ API
1010
:depth: 1
1111
:class: singlecol
1212

13+
The {+admin-api+} exposes REST endpoints that allow programmatic access and
14+
management of {+onprem+}. API requests accept JSON as body parameters,
15+
and the API responses are also JSON.
16+
17+
Section Overview
18+
----------------
19+
20+
:ref:`{+admin-api+} Principles <public-api-principles>`
21+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22+
23+
Learn about how the {+onprem+}\'s Public REST API exposes programmatic access to
24+
Ops Manager's features in this section.
25+
26+
:ref:`{+onprem+} Administration API Resources <admin-backup-api-resources>`
27+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28+
29+
Learn about each endpoint that the {+onprem+} API exposes, including the
30+
path to send your request to, any optional and required parameters, and the
31+
values that the {+admin-api+} returns.
32+
33+
:ref:`{+admin-api+} Administration API Error Codes <api-error-codes>`
34+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35+
36+
Learn about the various error codes that the {+admin-api+} might send in this section.
37+
38+
:ref:`{+admin-api+} Access Configuration <configure-api-access>`
39+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40+
41+
Learn about {+admin-api+} configuration details for generating
42+
an {+admin-api+} key in this section.
43+
44+
:ref:`{+admin-api+} Administration API Tutorials <api-tutorials>`
45+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46+
47+
Learn how you can perform varioius {+admin-api+} actions, such as
48+
deploying a cluster, rotating a key file and more in this section.
49+
1350
.. toctree::
1451
:titlesonly:
1552
:hidden:
@@ -18,4 +55,4 @@ API
1855
/reference/api
1956
/reference/api-error-codes
2057
/tutorial/configure-public-api-access
21-
/tutorial/nav/api-tutorials
58+
/tutorial/nav/api-tutorials

‎source/core/api.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _public-api-principles:
2+
13
=======================
24
Public |api| Principles
35
=======================

‎source/tutorial/add-servers-automation.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _add-servers-automation:
2+
13
================================
24
Provision Servers for Automation
35
================================

‎source/tutorial/add-shard-using-automation.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _add-shard-using-automation:
2+
13
================================
24
Add a Shard to a MongoDB Cluster
35
================================

‎source/tutorial/change-mongodb-version.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _change-mongodb-version:
2+
13
=============================
24
Change the Version of MongoDB
35
=============================

‎source/tutorial/configure-public-api-access.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _configure-api-access:
2+
13
====================
24
Configure API Access
35
====================

‎source/tutorial/convert-config-servers-to-replica-set.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _convert-config-servers-to-replica-set:
2+
13
=======================================
24
Convert Config Servers to a Replica Set
35
=======================================

‎source/tutorial/convert-replica-set-to-sharded-cluster.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _convert-replica-set-to-sharded-cluster:
2+
13
==========================================
24
Convert a Replica Set to a Sharded Cluster
35
==========================================

‎source/tutorial/convert-standalone-to-replica-set.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _convert-standalone-to-replica-set:
2+
13
=====================================
24
Convert a Standalone to a Replica Set
35
=====================================

‎source/tutorial/edit-replica-set.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _edit-replica-set:
2+
13
==================
24
Edit a Replica Set
35
==================

‎source/tutorial/manage-bi-connector.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _manage-bi-connector:
2+
13
============================
24
Manage BI Connector in |mms|
35
============================

‎source/tutorial/migrate-member-to-new-hardware.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _migrate-replica-set-member:
2+
13
============================================
24
Migrate a Replica Set Member to a New Server
35
============================================

‎source/tutorial/nav/add-servers.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,24 @@ Provision Servers
1010
:depth: 1
1111
:class: singlecol
1212

13+
{+onprem+} can automate operations for your MongoDB processes. {+onprem+} can manage existing processes and schedule new processes.
14+
15+
{+onprem+} polls the {+mdbagent+},
16+
which you must install on every MongoDB server to maintain alignment
17+
between your desired state and the actual state of your MongoDB server.
18+
19+
Section Overview
20+
----------------
21+
22+
:ref:`Provision Servers for Automation <add-servers-automation>`
23+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24+
25+
Learn how to provision MongoDB Automation Agents in this section.
26+
27+
:ref:`Provision a Migration Host <provision-migration-host>`
28+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29+
30+
Learn how to provision a MongoDB Migration Host in this section.
1331

1432
.. toctree::
1533
:titlesonly:

‎source/tutorial/nav/api-tutorials.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _api-tutorials:
2+
13
==========================================
24
{+admin-api+} Tutorials
35
==========================================

‎source/tutorial/nav/monitor-and-manage.txt

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,110 @@ Manage Deployments
1010
:depth: 1
1111
:class: singlecol
1212

13+
You can manage |service| clusters both manually and programatically
14+
with a variety of tools, such as the Atlas UI, the Atlas CLI, {+onprem+}
15+
and more.
16+
17+
Managing MongoDB clusters involves tasks such as editing a cluster configuration,
18+
upgrading an existing cluster, migrating to a new version of MongoDB and more.
19+
20+
Section Overview
21+
----------------
22+
23+
:ref:`View All Clusters <view-all-clusters>`
24+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25+
26+
Learn how to view all deployments that you have access to in your
27+
MongoDB Organization.
28+
29+
:ref:`Prepare for Cluster Maintenance <prepare-for-cluster-maintenance>`
30+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31+
32+
Learn how to prepare MongoDB clusters for maintenance and the resulting
33+
rolling restart for nodes in your cluster in this section.
34+
35+
:ref:`Edit a Deployment's Configuration <edit-deployment>`
36+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37+
38+
Learn how to modify a deployment's configuration and topology, including its
39+
MongoDB versions, storage engines, and numbers of hosts or shards.
40+
41+
:ref:`Manage BI Connector in {+onprem+} <manage-bi-connector>`
42+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43+
44+
Learn how to deploy and manage the |bic-full|.
45+
46+
:ref:`Calculate Suggested Indexes <calculate-suggested-indexes>`
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
49+
Learn how to analyze data on query patterns collected by the database
50+
profiler and suggest a set of indexes that could improve query performance
51+
.
52+
53+
:ref:`Edit a Replica Set <edit-replica-set>`
54+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55+
56+
Learn how to add, remove, and reconfigure members in a replica set directly in
57+
the {+onprem+} console.
58+
59+
:ref:`Convert a Standalone to a Replica Set <convert-standalone-to-replica-set>`
60+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
61+
62+
Learn how to convert a standalone instance to a replica
63+
set.
64+
65+
:ref:`Convert a Replica Set to a Sharded Cluster <convert-replica-set-to-sharded-cluster>`
66+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67+
68+
Learn how to convert a replica set to a sharded cluster.
69+
70+
:ref:`Migrate a Replica Set Member to a New Server <migrate-replica-set-member>`
71+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72+
73+
Learn how to replace one member of a managed replica set with another member from
74+
the {+onprem+} console.
75+
76+
:ref:`Convert Config Servers to a Replica Set <convert-config-servers-to-replica-set>`
77+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78+
79+
Learn how to ensure that your config servers are available and their metadata
80+
is consistent across the config servers.
81+
82+
:ref:`Add a Shard to a MongoDB Cluster <add-shard-using-automation>`
83+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84+
85+
Learn how to add a shard to a MongoDB sharded cluster.
86+
87+
:ref:`Remove a Shard from a MongoDB Cluster <remove-shard-using-automation>`
88+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
89+
90+
Learn how to remove a shard from a MongoDB sharded cluster.
91+
92+
:ref:`Stop Managing and/or Monitoring One Deployment <unmanage-deployment>`
93+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94+
95+
Learn how to manage, monitor, and back up your deployments without
96+
automation.
97+
98+
:ref:`MongoDB Processes <shut-down-deployment>`
99+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
100+
101+
Learn how to shut down, restart, sync, suspend, and resume a process running
102+
in {+onprem+}.
103+
104+
:ref:`MongoDB Versions <change-mongodb-version>`
105+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106+
107+
Learn how to change your MongoDB version and how to deploy a custom MongoDB
108+
build.
109+
110+
:ref:`Host Mappings <host-map>`
111+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112+
113+
Learn about host mappings and how {+onprem+} mananages and maintains host
114+
mappings.
115+
116+
13117
.. toctree::
14118
:titlesonly:
15119
:hidden:
@@ -29,4 +133,4 @@ Manage Deployments
29133
/tutorial/unmanage-deployment
30134
/tutorial/nav/mongodb-processes
31135
/tutorial/nav/mongodb-versions
32-
/tutorial/nav/host-mappings
136+
/tutorial/nav/host-mappings

‎source/tutorial/prepare-for-maintenance.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _prepare-for-cluster-maintenance:
2+
13
===============================
24
Prepare for Cluster Maintenance
35
===============================

‎source/tutorial/remove-shard-using-automation.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _remove-shard-using-automation:
2+
13
=====================================
24
Remove a Shard from a MongoDB Cluster
35
=====================================

‎source/tutorial/shut-down-deployment.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _shut-down-deployment:
2+
13
===========================
24
Shut Down MongoDB Processes
35
===========================

‎source/tutorial/suggest-indexes.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _calculate-suggested-indexes:
2+
13
===========================
24
Calculate Suggested Indexes
35
===========================

‎source/tutorial/unmanage-deployment.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _unmanage-deployment:
2+
13
==============================================
24
Stop Managing and/or Monitoring One Deployment
35
==============================================

0 commit comments

Comments
 (0)