doc: update intro, quick start docs #16224
Conversation
Signed-off-by: Sage Weil <sage@redhat.com>
doc/start/index.rst
Outdated
| @@ -1,5 +1,5 @@ | |||
| ====================== | |||
| Installation (Quick) | |||
| Installation (ceph-deploy) | |||
There was a problem hiding this comment.
/src/ceph/doc/start/index.rst:1: WARNING: Title overline too short.
======================
Installation (ceph-deploy)
======================
doc/start/intro.rst
Outdated
|
|
||
| - **Monitors**: A :term:`Ceph Monitor` maintains maps of the cluster | ||
| state, including the monitor map, manager map, the OSD map, and the | ||
| CRUSH map. This is critical cluster state required for Ceph daemons |
doc/start/quick-ceph-deploy.rst
Outdated
| | | | mds.node1 | | ||
| | | | osd.0 | | ||
| | | | mgr.node1 | | ||
| | | | mds.node1 | |
There was a problem hiding this comment.
nit, would be better if we can use spaces here even sphinx will remove the leading spaces and tabs before feeding this diagram to ditaa.
Signed-off-by: Sage Weil <sage@redhat.com>
Signed-off-by: Sage Weil <sage@redhat.com>
Signed-off-by: Sage Weil <sage@redhat.com>
Signed-off-by: Sage Weil <sage@redhat.com>
This is part of preflight. Signed-off-by: Sage Weil <sage@redhat.com>
- include mgr - simplify - remove references to old stuff as new Signed-off-by: Sage Weil <sage@redhat.com>
doc/start/intro.rst
Outdated
| state, including the monitor map, manager map, the OSD map, and the | ||
| CRUSH map. This is critical cluster state required for Ceph daemons | ||
| to coordinate with each other. Monitors are also responsible for | ||
| managing authenticate between daemons and clients. At least three |
There was a problem hiding this comment.
s/authenticate/authentication/
doc/start/intro.rst
Outdated
| CRUSH map. This is critical cluster state required for Ceph daemons | ||
| to coordinate with each other. Monitors are also responsible for | ||
| managing authenticate between daemons and clients. At least three | ||
| monitors are normally required for redundancy and high availability. |
There was a problem hiding this comment.
I thought 3 monitors is recommended, not required. If it is required, then we can s/normally// otherwise we should say recommended. If we want emphasis on the recommendation then we could use strongly recommended
There was a problem hiding this comment.
Required for redundancy and HA...
doc/start/intro.rst
Outdated
| storage utilization, current performance metrics, and system load. The | ||
| Ceph Manager daemons also host python-based plugins to manage and expose | ||
| Ceph cluster information, including a `dashboard`_ and `REST API`_. At least | ||
| two managers are normally required for redundancy and high availability. |
There was a problem hiding this comment.
The same comment about requiring/recommending here.
doc/start/intro.rst
Outdated
| data, handles data replication, recovery, backfilling, rebalancing, | ||
| and provides some monitoring information to Ceph Monitors and | ||
| Managers by checking other Ceph OSD Daemons for a heartbeat. At | ||
| least 3 Ceph OSDs are normally required for redundancy and high |
doc/start/intro.rst
Outdated
| behalf of the :term:`Ceph Filesystem` (i.e., Ceph Block Devices and | ||
| Ceph Object Storage do not use MDS). Ceph Metadata Servers allow | ||
| POSIX file system users to execute basic commands like ``ls``, | ||
| ``find``, etc. without placing an enormous burden on the Ceph |
There was a problem hiding this comment.
this can be wrapped in ():
basic commands (like `ls` and `find`) without placing [...]
If it must have the etc then it needs a comma:
like ``ls``, ``find``, etc., without placing [...]
| @@ -25,181 +25,137 @@ are in this directory when executing ``ceph-deploy``. | |||
| if you are logged in as a different user, because it will not issue ``sudo`` | |||
| commands needed on the remote host. | |||
|
|
|||
| .. topic:: Disable ``requiretty`` | |||
There was a problem hiding this comment.
this is still useful to keep around because it can still happen. Any strong reasons why this needs to be removed?
There was a problem hiding this comment.
Just that there were a bunch of other similar pitfalls (e.g., passwordless sudo, firewalld, etc) and it doesn't make sense to duplicate them all here. Seems better to keep the directions as concise as possible?
| #. Install Ceph. :: | ||
|
|
||
| ceph-deploy install {ceph-node}[{ceph-node} ...] | ||
| public network = {ip-address}/{bits} |
There was a problem hiding this comment.
i think of netmask a bitmask, e.g. '255.255.255.0'. not sure what you call the trailing bit of a CIDR-style '1.2.3.4/24'.
https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation is sort of ambiguous. maybe 'prefix bits'?
doc/start/quick-ceph-deploy.rst
Outdated
|
|
||
| #. Check your cluster's health. :: | ||
| #. Add three OSDs. For the purposes of these instructions, we assume you have an | ||
| unused disk in each node called ``/dev/vdb``. *Be sure that whatever device you use is not currently in use and does not contain any important data.* |
There was a problem hiding this comment.
s/that whatever device you use/that the device/
doc/start/quick-ceph-deploy.rst
Outdated
| run multiple Ceph Monitors so that the failure of a single Ceph | ||
| Monitor will not bring down the Ceph Storage Cluster. Ceph uses the | ||
| Paxos algorithm, which requires a majority of monitors (i.e., greather | ||
| than *N/2* where *N* is the number of monitors) for form a quorum. |
There was a problem hiding this comment.
s/for form a quorum/to form a quorum/
doc/start/quick-ceph-deploy.rst
Outdated
|
|
||
| For example:: | ||
| To deploy additional manager daemons,:: |
There was a problem hiding this comment.
I don't think you need a trailing comma here
Signed-off-by: Sage Weil <sage@redhat.com>
Signed-off-by: Sage Weil <sage@redhat.com>
|
@alfredodeza ok to merge now? |
No description provided.