Skip to content

DOCS-6796, DOCS-7621, DOCS-7626: administration reorg #2670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 99 additions & 1 deletion config/redirects.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1760,4 +1760,102 @@ type: 'redirect'
code: 303
outputs:
- 'before-v3.0'
...
---
from: '/administration/backup'
to: '/core/backups'
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /administration/configuration-and-maintenance
to: /administration/maintenance
type: 'redirect'
code: 303
outputs:
- 'before-v3.0'
---
from: /administration/data-management
to: /data-center-awareness
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /administration/maintenance
to: /administration/configuration-and-maintenance
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /administration/optimization
to: /administration/analyzing-mongodb-performance
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /administration/production-checklist
to: /administration/production-checklist-operations
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /administration/strategy
to: /administration
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /administration/tutorials
to: /administration
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /applications/design-notes
to: /administration/production-checklist-development
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /core/administration
to: /administration
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /reference/administration
to: /administration
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /tutorial/admin-manage-journaling
to: /tutorial/manage-journaling
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /tutorial/backup-small-sharded-cluster-with-mongodump
to: /tutorial/backup-sharded-clusters
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
---
from: /tutorial/restore-single-shard
to: /tutorial/restore-sharded-cluster
type: 'redirect'
code: 303
outputs:
- 'after-v3.0'
...
4 changes: 4 additions & 0 deletions config/sphinx_local.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ theme:
jira: 'DOCS'
sitename: 'MongoDB Docs'
nav_excluded:
- /administration
- /administration/production-checklist
- /administration/indexes-management
- /aggregation
Expand All @@ -23,6 +24,7 @@ theme:
- /core/auditing
- /core/authentication
- /core/authorization
- /core/backups
- /core/databases-and-collections
- /core/geohaystack
- /core/index-single
Expand All @@ -38,6 +40,7 @@ theme:
- /core/journaling
- /core/kerberos
- /core/map-reduce
- /core/operational-segregation
- /core/replica-set-architectures
- /core/replica-set-high-availability
- /core/replica-set-members
Expand All @@ -53,6 +56,7 @@ theme:
- /products/bi-connector
- /reference/command
- /text-search
- /tutorial/manage-the-database-profiler
- /core/index-text
- /reference/indexes
- /reference/method
Expand Down
21 changes: 15 additions & 6 deletions source/administration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,23 @@ MongoDB.

.. admin-introduction-end

.. only:: (website or singlehtml)

.. include:: /includes/toc/dfn-list-spec-administration-landing.rst

.. seealso:: The MongoDB Manual contains administrative documentation
and tutorials though out several sections. See
and tutorials thoughout several sections. See
:doc:`/administration/replica-sets` and
:doc:`/sharding` for additional tutorials and
information.

.. include:: /includes/toc/administration-landing.rst
.. class:: hidden

.. toctree::
:titlesonly:

/administration/production-notes
/administration/production-checklist-operations
/administration/production-checklist-development
Performance </administration/analyzing-mongodb-performance>
/administration/configuration-and-maintenance
/data-center-awareness
/core/backups
/administration/monitoring

15 changes: 12 additions & 3 deletions source/administration/analyzing-mongodb-performance.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=============================
Analyzing MongoDB Performance
=============================
===================
MongoDB Performance
===================

.. default-domain:: mongodb

Expand Down Expand Up @@ -251,3 +251,12 @@ Ensure that the value specified here (``100``, in this example) is above the

You must use the :operator:`$query` operator to access the ``query``
field of documents within ``system.profile``.

.. class:: hidden

.. toctree::
:titlesonly:

/tutorial/manage-the-database-profiler
/tutorial/transparent-huge-pages
/reference/ulimit
20 changes: 0 additions & 20 deletions source/administration/backup.txt

This file was deleted.

21 changes: 21 additions & 0 deletions source/administration/configuration-and-maintenance.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
=============================
Configuration and Maintenance
=============================

.. default-domain:: mongodb

This section describes routine management operations, including
updating your MongoDB deployment's configuration.

.. include:: /includes/toc/dfn-list-administration-configuration-and-maintenance.rst

.. class:: hidden

.. toctree::
:titlesonly:

/administration/configuration
/tutorial/upgrade-revision
/tutorial/manage-mongodb-processes
/tutorial/terminate-running-operations
/tutorial/rotate-log-files
20 changes: 0 additions & 20 deletions source/administration/data-management.txt

This file was deleted.

18 changes: 0 additions & 18 deletions source/administration/maintenance.txt

This file was deleted.

9 changes: 9 additions & 0 deletions source/administration/monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -492,3 +492,12 @@ lock.

If this lock exists, make sure that the balancer process is actively
using this lock.

.. class:: hidden

.. toctree::
:titlesonly:

/tutorial/monitor-with-snmp
/tutorial/monitor-with-snmp-on-windows
/tutorial/troubleshoot-snmp
23 changes: 0 additions & 23 deletions source/administration/optimization.txt

This file was deleted.

41 changes: 36 additions & 5 deletions source/administration/production-checklist-development.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
===========
Development
===========
=====================
Development Checklist
=====================

.. default-domain:: mongodb

Expand All @@ -10,8 +10,6 @@ Development
:depth: 1
:class: singlecol

.. COMMENT This file is included in another file. Keep the subtitle levels as is.

The following checklist, along with the
:doc:`/administration/production-checklist-operations`, provides
recommendations to help you avoid issues in your production MongoDB
Expand All @@ -34,17 +32,50 @@ Data Durability
Schema Design
~~~~~~~~~~~~~

Data in MongoDB has a *dynamic schema*. :term:`Collections
<collection>` do not enforce :term:`document` structure. This
facilitates iterative development and polymorphism. Nevertheless,
collections often hold documents with highly homogeneous
structures. See :doc:`/core/data-models` for more information.

.. cssclass:: checklist

- Determine the set of collections that you will need and the
indexes required to support your queries. With the exception of
the ``_id`` index, you must create all indexes explicitly: MongoDB
does not automatically create any indexes other than ``_id``.

- Ensure that your schema design supports your deployment type: if
you planning to use :term:`sharded clusters <sharded cluster>` for
horizontal scaling, design your schema to include a strong shard
key. The shard key affects read and write performance by
determining how MongoDB partitions data. See: :doc:`Impacts of
Shard Keys on Cluster Operations </core/sharding-shard-key>`
for information about what qualities a shard key should possess.
You cannot change the shard key once it is set.

- Ensure that your schema design does not rely on indexed arrays that
grow in length without bound. Typically, best performance can
be achieved when such indexed arrays have fewer than 1000 elements.

- Consider the document size limits when designing your schema.
The :limit:`BSON Document Size` limit is 16MB per document. If
you require larger documents, use :doc:`GridFS </core/gridfs>`.

Replication
~~~~~~~~~~~

.. cssclass:: checklist

- Use an odd number of replica set members to ensure that elections
proceed successfully. If you have an even number of members, use
an :term:`arbiter` to ensure an odd number of votes.

- Ensure that your secondaries remain up-to-date by using
:doc:`monitoring tools </administration/monitoring>` and by
specifying appropriate :doc:`write concern
</reference/write-concern>`.

- Do not use secondary reads to scale overall read throughput. See:
`Can I use more replica nodes to scale`_ for an overview of read
scaling. For information about secondary reads, see:
Expand Down
Loading