Commit Graph

54 Commits

Author SHA1 Message Date
Conrad Hoffmann
402d2eacbc doc: account for PG autoscaling being the default
The current documentation tries really hard to convince people to set
both `osd_pool_default_pg_num` and `osd_pool_default_pgp_num` in their
configs, but at least the latter has undesirable side effects on any
Ceph version that has PG autoscaling enabled by default (at least quincy
and beyond).

Assume a cluster with defaults of `64` for `pg_num` and `pgp_num`.
Starting `radosgw` will fail as it tries to create various pools without
providing values for `pg_num` or `pgp_num`. This triggers the following
in `OSDMonitor::prepare_new_pool()`:

- `pg_num` is set to `1`, because autoscaling is enabled
- `pgp_num` is set to `osd pool default pgp_num`, which we set to `64`
- This is an invalid setup, so the pool creation fails

Likewise, `ceph osd pool create mypool` (without providing values for
`pg_num` or `pgp_num`) does not work.

Following this rationale:

- Not providing a default value for `pgp_num` will always do the right
  thing, unless you use advanced features, in which case you can be
  expected to set both values on pool creation
- Setting `osd_pool_default_pgp_num` in your config breaks pool creation
  for various cases

This commit:

- Removes `osd_pool_default_pgp_num` from all example configs
- Adds mentions of the autoscaling and how it interacts with the default
  values in various places

For each file that was touched, the following maintenance was also
performed:

- Change interternal spaces to underscores for config values
- Remove mentions of filestore or any of its settings
- Fix minor inconsistencies, like indentation etc.

There is also a ticket which I think is very relevant and fixed by this,
though it only captures part of the broader issue addressed here:

Fixes: https://tracker.ceph.com/issues/47176
Signed-off-by: Conrad Hoffmann <ch@bitfehler.net>
2023-03-23 22:15:25 +01:00
Sandro Bonazzola
2bd9383934 doc/install: ensure to open ceph-mon firewall ports
doc/install: ensure to open ceph-mon firewall ports

Signed-off-by: Sandro Bonazzola <sbonazzo@redhat.com>
2021-10-19 11:37:58 +02:00
Ilya Dryomov
c22e44895d
Merge pull request #40965 from rokj/patch-3
doc: mention copying keyrings and adjust node names in manual deployment example

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2021-07-29 23:54:44 +02:00
Rok Jaklič
bcad5d9822 doc: adding missing command. changed node naming.
Signed-off-by: Rok Jaklič <rokj@rasca.net>
2021-07-29 09:49:13 +02:00
Abutalib Aghayev
413d344723 doc: Add a missing instruction to manual deployment guide.
Following the instructions as is results in the following error at step 15:

$ sudo -u ceph ceph-mon --mkfs -i node1 --monmap /tmp/monmap --keyring /tmp/ceph.mon.keyring
global_init: error reading config file.

Signed-off-by: Abutalib Aghayev <agayev@cs.cmu.edu>
2021-06-18 14:32:54 +08:00
Ivan Jager
5f017bed4a doc: Fix mds capabilities for manual deployment
Now matches auth-config-ref.rst, and actually works.

Signed-off-by: Ivan Jager <aij+git@mrph.org>
2020-12-20 05:50:08 -06:00
zdover23
acf80f111c
Merge pull request #34506 from ktdreyer/doc-rm-sysv-init
doc: remove SysV init reference in manual deployment walkthrough

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-23 16:10:30 +10:00
Robert Sander
1b42759e19 doc: remove references to ceph-deploy
The documentation still has many traces of ceph-deploy. This tool has
been deprecated with the Octopus release. This commit tries to remove
most of ceph-deploy occurences.

Signed-off-by: Robert Sander <r.sander@heinlein-support.de>
2020-09-02 21:14:36 +02:00
Zac Dover
15138ca4c8 doc/install: add sudo to command
This commit adds "sudo" to a ceph-authtool command
that is missing the "sudo".

Fixes: https://tracker.ceph.com/issues/46065
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-06-22 15:13:16 +10:00
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00
Ken Dreyer
52d0c37aa5 doc: remove SysV init reference in manual deployment walkthrough
Every other instruction in this document uses systemd. Drop the last
SysV init reference.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2020-04-09 16:42:12 -06:00
Kefu Chai
20efbfb507
Merge pull request #31453 from oneoneonepig/patch-2
doc: add sudo in ceph status command

Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-03-26 17:19:28 +08:00
Sean Fang
bb5802407c doc: Fix some link errors about ceph-deploy
Previously moved "ceph-deploy" did not change the link jump in it correctly

Signed-off-by: Sean Fang <silence.boy@live.cn>
2020-03-21 13:20:54 +08:00
oneoneonepig
5e8e277d74 doc: add sudo in ceph status command
The keyring is created with sudo privilege, the current normal user won't have access to it

Signed-off-by: Jeffrey Chu <peihuachu1112@gmail.com>
2020-02-05 05:32:43 +00:00
oneoneonepig
ef0f78971d Add chown ceph:ceph for /tmp/ceph.mon.keyring
The keyring will be 600 by default with the owner of the current user who issues the command, which will make command "sudo -u ceph ceph-mon --mkfs" fail since the user "ceph" don't have access to the keyring file.
Because of that, the mon data directory won't have keyring and when "sudo systemctl start ceph-mon" it will show error "unable to read magic from mon data"

Signed-off-by: Jeffrey Chu <peihuachu1112@gmail.com>
2019-11-11 04:50:49 +00:00
Patrick Donnelly
e7a7cf429e
doc: filesystem to file system
"Filesystem" is not a word (although fairly common in use).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-10 08:43:28 -07:00
Bryan Stillwell
6417b2530e doc: Add missing mgr cap for the bootstrap keyring
A manual deployment will fail to create OSDs unless the bootstrap-osd
keyring has read permissions to the mgr.

Signed-off-by: Bryan Stillwell <bstillwell@godaddy.com>
2019-03-26 14:03:32 -06:00
Casey Bodley
39f8375aee
Merge pull request #23660 from falcon78921/wip-multisite-docs
doc: updated multisite documentation

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2018-09-13 08:53:59 -04:00
Sage Weil
d6def8ba11 ceph-authtool: remove auid options
Signed-off-by: Sage Weil <sage@redhat.com>
2018-08-31 09:26:19 -05:00
James McClune
bb02216196 doc: used ref label for multisite link
Used the multisite ref label to link the Multi-Site page.
There's no federated config page in the latest docs.
The federated config page seems a little redundant. The multisite page's content
is very similar to the federated config. The multisite page also reflects best practices
when running radosgw's across geographic locations.

Fixes: http://tracker.ceph.com/issues/26997

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-08-23 19:52:08 -04:00
Brad Hubbard
2c755cef69 Remove upstart files and references
Nautilus is not supported on any distros still running upstart so these
are redundant.

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2018-08-20 12:59:34 +10:00
Alfredo Deza
c66300db83 doc/install add missing lvm subcommand for ceph-volume
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2018-03-01 14:22:01 -05:00
Sage Weil
59bdada5d5 mon/OSDMonitor: accept crush_device_class in 'osd new' json input
If provided, set the OSD device_class at OSD creation time.  This is
simpler than writing a file that the OSD has to read in and use to
set its initial device class, and also avoids a bit of sticky state
at the OSD that will make it keep trying to reset its device class on
startup if it ever gets cleared.

Note that we now ignore json input fields we don't understand, so remove
a test case.

Signed-off-by: Sage Weil <sage@redhat.com>
2018-02-08 12:34:49 -06:00
Alfredo Deza
3ed739e541 doc/install use ceph-volume in manual deployment steps
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-12-04 09:51:12 -05:00
Kefu Chai
e21cd99855 doc: update manual-deployment with latest code
rbd pool is not created by default any more.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-10-23 19:18:39 +08:00
Jens Rosenboom
bd0576652d Update docs for manual deployment
Fixes: http://tracker.ceph.com/issues/20309
Signed-off-by: Jens Rosenboom <j.rosenboom@x-ion.de>
2017-10-19 17:03:16 +00:00
Alfredo Deza
d3c4e4af35 doc/install use min_size 2 and default_size 4 as an example
Which prevents readin "min_size=1" and assuming it is an OK setting

Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-09-22 17:10:11 -04:00
Alfredo Deza
0071e1108b doc/install use the new mgr-administrator-guide label
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:08:08 -04:00
John Spray
cbd2e303e9 doc: update client.admin key refs to "mds 'allow'"
This is more correctly "mds 'allow *'".

In the RADOS user management page, refer the user
to the cephfs client auth docs, rather than attempting
to explain MDS cap syntax inline.

Signed-off-by: John Spray <john.spray@redhat.com>
2017-07-31 11:58:29 +01:00
Nick Erdmann
987024567c added mgr caps to manual deployment documentation
Signed-off-by: Nick Erdmann <n@nirf.de>
2017-07-28 19:16:27 +02:00
Sage Weil
454fdb6720 doc/install/manual-deployment: update osd creation steps
Signed-off-by: Sage Weil <sage@redhat.com>
2017-07-25 22:41:52 -04:00
Kefu Chai
254e07441c doc: kill sphinx warnings
* doc/release-notes.rst: escape asterisks not used for inline emphasis
    fix bad hyper links
* doc/rados/troubleshooting/troubleshooting-osd.rst: escape asterisks
    not used for inline emphasis
* doc/radosgw/index.rst: add orphan docs to toc
* doc/dev/perf_histograms.rst: indent block quote
* doc/install/manual-freebsd-deployment.rst: fix block quotes
* doc/mgr/administrator.rst: escape asterisks not used for inline emphasis
* doc/start/quick-rbd.rst: add missing hyper link target

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-07-07 11:50:33 +08:00
Sage Weil
0346998b5a doc: recommend against btrfs
Signed-off-by: Sage Weil <sage@redhat.com>
2017-06-30 13:54:18 -04:00
John Spray
fc8b8000b0 doc/install: reference mgr manual setup
Signed-off-by: John Spray <john.spray@redhat.com>
2017-06-14 09:54:26 -04:00
Kefu Chai
4b52a03859 doc: add descriptions for mon/mgr options
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-05-13 01:30:29 +08:00
Ken Dreyer
38c216fbf0 doc: clarify that "ms bind ipv6" disables IPv4
This was sort of described in doc/rados/configuration/ms-ref.rst
already. Add the same information to the other areas where we talk about
the ms bind ipv6 setting.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2017-02-08 10:31:15 -07:00
Peter Maloney
9fd92a5ecf doc: manual instructions to set up mds daemon
Signed-off-by: Peter Maloney <peter.maloney@brockmann-consult.de>
2016-09-17 22:29:49 +02:00
Bryan Stillwell
374e3c7b66 doc: Some commands also need sudo to run
Included sudo on some commands which need it to run properly and also
fixed a few grammar problems.

Signed-off-by: Bryan Stillwell <bryan.stillwell@twcable.com>
2016-05-05 18:29:38 -06:00
Vikhyat Umrao
c00945eb8b cleanup: remove obsolete option "filestore_xattr_use_omap"
This patch does cleanup for option "filestore_xattr_use_omap",
as this option was removed in #7408.

Fixes: #14356
Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
2016-01-22 18:01:09 +05:30
Mykola Golub
0d1e770391 mon: osd create: add optional 'id' parameter
Signed-off-by: Mykola Golub <mgolub@mirantis.com>
2015-04-12 14:25:45 +03:00
Ian Kelling
64851f5e18 doc: consistent alternate cluster name arguments
In doc/install/manual-deployment.rst at least.

Signed-off-by: Ian Kelling <iank@iankelling.org>
2015-03-18 16:47:55 -07:00
Kefu Chai
3cea092bf9 doc/install/manual-deployment: fix osd install doc
* should be using /var/lib/ceph/osd/{cluster-name}-{osd-num}/sysvinit
  instead of var/lib/ceph/osd/{cluster-name}-{hostname}/sysvinit, thanks
  to Kyle Hutson <kylehutson@ksu.edu>

Fixes: #10957
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-02-28 10:59:55 +08:00
Kefu Chai
24c943d021 doc/install/manual-deployment: s/mon/osd/ for osd install doc
Fixes: #10957
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-02-27 16:15:18 +08:00
Sage Weil
3bc429159f doc/install/manual-deployment: move 'done' comment up
It's the same for upstart and sysvinit.

Signed-off-by: Sage Weil <sage@redhat.com>
2014-08-28 14:34:27 -07:00
François Lafont
e5b67f75e0 Update doc
File 'sysvinit' is necessary to allow the start of mon at each reboot.
Signed-off-by: François Lafont <francois.lafont@crdp.ac-versailles.fr>
2014-08-06 23:53:48 +02:00
François Lafont
4b45e25bd2 Add handles for the ceph-mon starting with upstart 2014-08-06 01:38:20 +02:00
Aristoteles Neto
c2644b29e8 Update manual-deployment.rst
- When creating the OSD data, specify osd-uuid so that it matches when the osd is first created.
- Modify caps when adding osd auth to match what ceph-deploy does.
2014-05-21 10:20:55 +12:00
John Wilkins
ab907c5abc doc: Clarified Debian uses sysvinit.
Fixes: #7182

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-05-14 00:23:22 -07:00
John Wilkins
9cd67bb2af doc: Fixed hyperlink.
Fixes: #7558

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-03-14 15:45:51 -07:00
Christopher O'Connell
c278269535 Added a note that the ceph-osd command requires the cluster option.
Signed-off-by: Christopher O'Connell <jwriteclub@gmail.com>
2014-02-21 18:26:58 -08:00