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

doc: update intro, quick start docs #16224

Merged
merged 9 commits into from Jul 11, 2017

Conversation

Projects
None yet
3 participants
@liewegas
Member

liewegas commented Jul 7, 2017

No description provided.

doc/index: minor cleanup
Signed-off-by: Sage Weil <sage@redhat.com>
@@ -1,5 +1,5 @@
======================
Installation (Quick)
Installation (ceph-deploy)

This comment has been minimized.

@tchaikov

tchaikov Jul 10, 2017

Contributor
/src/ceph/doc/start/index.rst:1: WARNING: Title overline too short.

======================
 Installation (ceph-deploy)
======================
- **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

This comment has been minimized.

@tchaikov

tchaikov Jul 10, 2017

Contributor

what is "This"?

| | | mds.node1 |
| | | osd.0 |
| | | mgr.node1 |
| | | mds.node1 |

This comment has been minimized.

@tchaikov

tchaikov Jul 10, 2017

Contributor

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.

liewegas added some commits Jul 7, 2017

doc/start/intro: updates
Signed-off-by: Sage Weil <sage@redhat.com>
doc/start/os-recommendations: updates
Signed-off-by: Sage Weil <sage@redhat.com>
doc/start: simplify quick start install process
Signed-off-by: Sage Weil <sage@redhat.com>
doc/start/quick-ceph-deploy: drop redundant warning
This is part of preflight.

Signed-off-by: Sage Weil <sage@redhat.com>
doc/start/quick-deph-deploy: update quick deploy instructions
- include mgr
- simplify
- remove references to old stuff as new

Signed-off-by: Sage Weil <sage@redhat.com>
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

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

s/authenticate/authentication/

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.

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

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

This comment has been minimized.

@liewegas

liewegas Jul 10, 2017

Member

Required for redundancy and HA...

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.

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

The same comment about requiring/recommending here.

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

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

and here too

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

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

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``

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

this is still useful to keep around because it can still happen. Any strong reasons why this needs to be removed?

This comment has been minimized.

@liewegas

liewegas Jul 10, 2017

Member

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}

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

was {netmask} wrong?

This comment has been minimized.

@liewegas

liewegas Jul 10, 2017

Member

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'?

#. 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.*

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

s/that whatever device you use/that the device/

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.

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

s/for form a quorum/to form a quorum/

For example::
To deploy additional manager daemons,::

This comment has been minimized.

@alfredodeza

alfredodeza Jul 10, 2017

Contributor

I don't think you need a trailing comma here

liewegas added some commits Jul 10, 2017

doc/start/intro: add parens to cephfs section
Signed-off-by: Sage Weil <sage@redhat.com>
doc/start/quick-ceph-deploy: fix typos etc
Signed-off-by: Sage Weil <sage@redhat.com>
@liewegas

This comment has been minimized.

Member

liewegas commented Jul 11, 2017

@alfredodeza ok to merge now?

@alfredodeza alfredodeza merged commit 7b45532 into ceph:master Jul 11, 2017

4 checks passed

Signed-off-by all commits in this PR are signed
Details
Unmodified Submodules submodules for project are unmodified
Details
make check make check succeeded
Details
make check (arm64) make check succeeded
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment