wbtiger
/
foundationdb
mirror of https://github.com/apple/foundationdb.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added a few additional links in our documentation

This commit is contained in:
Evan Tschannen 2018-11-16 16:26:25 -08:00
parent ca313dadbf
commit 7bb1eee21c
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
documentation/sphinx/source/administration.rst
View File

@ -9,15 +9,18 @@ Administration
:hidden:
:titlesonly:
configuration
moving-a-cluster
tls
This document covers the administration of an existing FoundationDB cluster. We recommend you read this document before setting up a cluster for performance testing or production use.
.. note:: In FoundationDB, a "cluster" refers to one or more FoundationDB processes spread across one or more physical machines that together host a FoundationDB database.
To administer an externally accessible cluster, you need to understand basic system tasks. You should begin with how to :ref:`start and stop the database <administration-running-foundationdb>`. Next, you should review management of a cluster, including :ref:`adding <adding-machines-to-a-cluster>` and :ref:`removing <removing-machines-from-a-cluster>` machines, and monitoring :ref:`cluster status <administration-monitoring-cluster-status>` and the basic :ref:`server processes <administration_fdbmonitor>`. You should be familiar with :ref:`managing trace files <administration-managing-trace-files>` and :ref:`other administrative concerns <administration-other-administrative-concerns>`. Finally, you should know how to :ref:`uninstall <administration-removing>` or :ref:`upgrade <upgrading-foundationdb>` the database.
FoundationDB also provides a number of different :doc:`configuration <configuration>` options which you should know about when setting up a FoundationDB database.
.. _administration-running-foundationdb:
Starting and stopping

3
documentation/sphinx/source/technical-overview.rst
View File

@ -26,6 +26,8 @@ These documents explain the engineering design of FoundationDB, with detailed in
* :doc:`testing`: FoundationDB uses a combined regime of robust simulation, live performance testing, and hardware-based failure testing to meet exacting standards of correctness and performance.
* :doc:`kv-architecture` provides a description of every major role a process in FoundationDB can fulfill.
.. toctree::
:maxdepth: 1
:titlesonly:
@ -42,3 +44,4 @@ These documents explain the engineering design of FoundationDB, with detailed in
fault-tolerance
flow
testing
kv-architecture