Commit Graph

378 Commits

Author SHA1 Message Date
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
Kefu Chai
fe785597e3
doc: add a link to ceph-deploy document 2020-10-07 00:20:58 +08:00
Ponnuvel Palaniyappan
d99d520493 doc: Fixed a number of typos in documentation
Signed-off-by: Ponnuvel Palaniyappan <pponnuvel@gmail.com>
2020-09-18 18:17:15 +01: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
Kefu Chai
ca1cca0abc doc: fix broken hyper link
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:18 +08:00
Kefu Chai
45f43be813 doc: define label before section title
so we can see the title of section when following the link

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:18 +08:00
Kefu Chai
fe07df9f19 doc: always refernce terms in case sensitive mode
to silence warning from sphinx like:

ceph/doc/install/ceph-deploy/quick-start-preflight.rst:5: WARNING: term node not found in case sensitive match.made a reference to Node instead.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:18 +08:00
Kefu Chai
7ca85e77d0 doc: replace luminous with |stable-release|
"luminous" is a magic number in these contexts, and we should use a
constant for representing it.

the "sphinx_substitution_extensions" sphinx extension is introduced for
performing the global subsitution.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:17 +08:00
Zac Dover
8aebd0fd57 doc/cephadm: index.rst: s/suites/suits/ typo fixed.
This commit changes the sentence "Choose the method that best suites
your needs." to "Choose the method that best suits your needs."

Fixes: https://tracker.ceph.com/issues/46359
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-07-05 19:18:31 +10: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
Zac Dover
f0fe087077 Add note warning against the :latest tag.
Signed-off-by: Zac Dover <zac.dover@gmail.com>

Incorporating mgfritch's improvements.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

s/docker/podman/ -- as per mgfritch's suggestion

Signed-off-by: Zac Dover <zac.dover@gmail.com>

s/: latest/:latest/

Signed-off-by: Zac Dover <zac.dover@gmail.com>

s/image ids/image IDs/ -- as per Alex Settle's suggestion.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

Add note warning against the :latest tag.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

s/image ids/image IDs/ -- as per Alex Settle's suggestion.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

Linked to container page from cephadm install page.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

Clarified the note directing readers to the container documentation.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-05-29 14:54:21 +10:00
Shengming Zhang
0376fe8e63 doc:replacing https://ceph.com/ by http://download.ceph.com/
Signed-off-by: Shengming Zhang <zhangsm01@inspur.com>
2020-05-23 13:40:41 +08:00
Kefu Chai
73f68ecb95
Merge pull request #33975 from jbwyatt4/jbwyatt4-need-disk-space-info
doc: added space requirement to "Build Prerequisites"

Reviewed-by: Deepika Upadhyay <dupadhya@redhat.com>
2020-04-15 07:51:05 +08:00
Tim
d7c7ccb439 Update index.rst
clean up "only only"

Signed-off-by: Tim <elatllat@gmail.com>
2020-04-11 08:30:08 -04: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
John Wyatt
b383280057 Doc: added space requirement to "Build Prerequisites"
Build prerequisites section does not include how much space Ceph
takes. A Ceph debug build can take 40 gigabytes by itself - double
the default size of many VMs by default, including CentOS 8 for
virt-manager. New contributors may be turned off or may not
understand why Ceph does not build. Also a warning on LVM taking
up too much disk space.

Signed-off-by: John B. Wyatt IV <jbwyatt4@gmail.com>
2020-03-26 17:04:08 -07: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
Kefu Chai
596565d6e7
Merge pull request #34101 from s1eke/master
doc: Fix some link errors about ceph-deploy

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-03-24 14:00:29 +08:00
Sage Weil
895b856aee Merge remote-tracking branch 'gh/octopus' 2020-03-23 20:09:41 -05:00
Sage Weil
41bc82f284 doc/install/get-packages: update package install instructions
- include cephadm method
- update to include new version URLs

Signed-off-by: Sage Weil <sage@redhat.com>
2020-03-23 12:40:19 -05: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
Sage Weil
6cb39e4aa8 Merge PR #34060 into master
* refs/pull/34060/head:
	Merge PR #34027 into octopus
	Merge PR #34045 into octopus
	Merge pull request #34035 from dillaman/wip-rbd-permissions
	mgr/progress: fix duration strings
	Merge PR #34014 into octopus
	Merge PR #34001 into octopus
	Merge PR #34011 into octopus
	qa/workunits/rbd: use context managers to control Rados lifespan
	Merge pull request #34032 from dillaman/wip-rbd-octopus-docs
	doc/releases/octopus: add additional RBD improvements
	qa/workunits/cephadm/test_cephadm: mark services unmanaged for test
	mgr/cephadm: do not reconfig unmanaged services
	Merge PR #33981 into octopus
	Merge pull request #34018 from ajarr/octopus-subvolume-clone-cancel
	qa/workunits/cephadm/test_cephadm: output file for pub key
	Merge PR #33866 into octopus
	Merge PR #34005 into octopus
	Merge PR #34013 into octopus
	mgr/cephadm: pytest: Enable SpecStore
	mgr/orchestrator: add test for default implementation for apply()
	python-common: validate ServiceSpec.service_type
	fixup mgr/cephadm: Fix ceph orch apply -i
	mgr/dashbaord: orchestrator service: Revert wait_api_result to a single completion
	mgr/orchestrator: `orch daemon add` accepts a yaml
	mgr/cephadm: apply_drivegroups() returns a single Completion
	mgr/cephadm: remove `trivial_result()`
	mgr/cephadm: Fix `ceph orch apply -i`
	Merge pull request #33994 from dillaman/wip-librbd-poll-event-race
	doc: document `clone cancel` command
	test: add `clone cancel` tests
	mgr/volumes: introduce "clone cancel" volume command
	mgr/volumes: allow canceling a single asynchronous job for a volume
	mgr/volumes: helper for looking up a clone entry index
	mgr/volumes: periodically check if clone operations should be canceled
	mgr/volumes: periodically check if copy operations should be canceled
	mgr/volumes: introduce 'canceled' state in clone op state machine
	qa/suites/rados/verify/validater/valgrind: tolerate SLOW_OPS
	qa/suites/rados/verify/validater/valgrind: less bluestore logging
	qa/suites/rados/verify/validater: increase heartbeat grace
	Revert "qa/suites/rados/verify: debug_ms = 1, osd_heartbeat_grace = 60"
	Revert "qa/suites/rados/verify/validator/valgrind: debug refs = 5"
	ceph_test_watch_notify: try notify 10x if ALLOW_TIMEOUTS is set
	ceph_test_rados_api_misc: ShutdownRace timeout if ALLOW_TIMEOUTS is set
	qa/suites/rados/verify: set ALLOW_TIMEOUTS for workunits
	doc/install: edits
	doc/cephadm: more edits
	doc/cephadm/install: edits
	doc/cephadm/adoption: improvements
	doc/cephadm/install: a few edits
	doc/cephadm/install: do not install ceph-common on host (by default)
	doc/cephadm: drop os recs link
	doc/cephadm/upgrade: improvements
	doc/cephadm/upgrade: document upgrade
	doc/cephadm/install: revamp install docs
	doc: reorganize cephadm docs
	doc/cephadm/administration: update docs on customizing SSH config
	doc/cephadm/administration: add a note about the 'removed' dir
	mgr/balancer: tolerate pgs outside of target weight map
	qa/workunits/cephadm/test_cephadm: --skip-monitoring-stack
	Merge PR #33974 into octopus
	Merge PR #33442 into octopus
	Merge PR #33997 into octopus
	Merge PR #34000 into octopus
	use quay octopus tip until 15.2 tag is available
	python-common: reduce output of ServiceSpec.to_json()
	python-common,mgr/cephadm: move assert_valid_host to service_spec
	mgr/cephadm: add HostAssignment.validate()
	mgr/dashboard: adapt create_osds interface change
	mon/MgrMonitor: make 'mgr fail' work with no arguments
	cephadm: add allow_ptrace option to enable SYS_PTRACE
	update default container images
	mgr/cephadm: limit number of times check host is performed in the serve loop
	Merge PR #33961 into octopus
	Merge PR #33952 into octopus
	Merge PR #33990 into octopus
	Merge PR #33955 into octopus
	Merge PR #33936 into octopus
	mgr/orch: add --all-available-devices to 'orch apply osd'
	qa/workunits/cephadm: --skip-mon-network when using 127.0.0.1
	cephadm: add tests
	qa/tasks/cephadm: pass -v to bootstrap
	mgr/cephadm: only try to place mons on hosts matching public_network
	mgr/cephadm: keep track of host networks, ips
	cephadm: automatically infer mon public_network, if we can
	cephadm: add list-networks command
	cephadm: bootstrap: deploy monitoring stack by default
	librbd: defer event socket completion until after callback issued
	cephadm: add-repo: add --version
	mgr/cephadm: respect 'unmanaged' flag in spec
	mgr/orch: orch ls: show <no spec> or <unmanaged> as appropriate
	mgr/orch: orch ls: rename SPEC -> PLACEMENT
	mgr/orch: add 'unmanaged' property to ServiceSpec
	cephadm: rename distro args in repo methods
	mgr/orch: combine 'orch daemon add <type> ...' into one command
	mgr/orch: combine 'orch apply <type> [<placement>]' into one command

Reviewed-by: Laura Paduano <lpaduano@suse.com>
2020-03-19 11:07:16 -05:00
Sage Weil
2fafbffdc9 doc/install: edits
Based on review by Alexandra Settle <asettle@suse.com>

Signed-off-by: Sage Weil <sage@redhat.com>
2020-03-17 17:53:07 -05:00
Sage Weil
d3075903cd doc/cephadm/upgrade: improvements
Signed-off-by: Sage Weil <sage@redhat.com>
2020-03-17 17:53:07 -05:00
Sage Weil
ce2066e623 doc: reorganize cephadm docs
- reorganized cephadm into a top-level item with a series of sub-items.
- condensed the 'install' page so that it doesn't create a zillion items
in the toctree on the left
- started updating the cephadm/install sequence (incomplete)

Signed-off-by: Sage Weil <sage@redhat.com>
2020-03-17 17:52:43 -05:00
Sage Weil
7f0c3c4f37 Merge remote-tracking branch 'gh/octopus' 2020-03-16 12:47:25 -05:00
Sebastian Wagner
d231eb90ce doc: Move ceph-deploy docs to doc/install/ceph-deploy
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-03-13 15:52:41 +01:00
Zac Dover
e3cf60d135 doc/install: rethink docs install page (similar to PR#33613)
This rearranges the list of installation methods, in accordance with Sage's and Sebastian W's wishes.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-03-12 01:28:28 +10:00
Sebastian Wagner
ba5cefa5fb doc/install: Rethink doc/install
What about having a list of the various installation possibilities?

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-02-28 14:19:40 +01: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
Rodrigo Severo
2422f6df67 doc/install/upgrading-ceph: using systemd commands in Ubuntu instructions
Before this change, we were using the "restart" command which is a symlink to
initctl(8). and it's offered by upstart. since ubuntu/vivid, ubuntu moved from
upstart to systemd.

Please see https://lists.ubuntu.com/archives/ubuntu-devel/2016-July/039465.html

Signed-off-by: Rodrigo Severo <rodrigo@fabricadeideias.com>
2020-01-13 16:55:21 -03:00
Rodrigo Severo
e8806c97d7 doc/install/upgrading-ceph: removing trailing spaces
Signed-off-by: Rodrigo Severo <rodrigo@fabricadeideias.com>
2020-01-10 11:33:45 -03:00
Changcheng Liu
767161a347 doc/rbd: correct software stack of VM with Ceph
Signed-off-by: Changcheng Liu <changcheng.liu@aliyun.com>
2019-12-16 19:49:09 +08:00
Sage Weil
b7f9f3651f doc/install/containers: note vX.Y.Z[-YYYYMMDD] tags
Signed-off-by: Sage Weil <sage@redhat.com>
2019-12-04 08:22:52 -06:00
Sage Weil
a15af0a053 Merge PR #31465 into master
* refs/pull/31465/head:
	doc/install/containers: add summary of containers and branches

Reviewed-by: Dan Mick <dmick@redhat.com>
2019-11-21 16:26:04 -06:00
Sage Weil
cf97ec9227 doc/install/containers: add summary of containers and branches
Signed-off-by: Sage Weil <sage@redhat.com>
2019-11-15 07:33:15 -06: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
Nathan Cutler
626daf4b20
Merge pull request #30598 from smithfarm/wip-doc-releases-toc
doc/releases: access main releases page from top-level TOC

Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
2019-11-05 13:18:25 +01:00
Nathan Cutler
e12ac2ddd1 doc/releases: access main releases page from top-level TOC
Before this commit, one had to go through the releases index to get to the main
releases page. This should be the other way around.

Also, the main releases page should not be called "schedule.rst" - while it
contains a release timeline, that's not its principal purpose. Rename the page
to "general.rst" and move the "Understanding the release cycle" section before
the timeline.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2019-09-27 12:49:43 +02:00
Michael Prokop
d98b3e36a9 doc: fix typos
s/amount of times/number of times/
s/assosciated/associated/
s/availabe/available/
s/Commiting/Committing/
s/Containter/Container/
s/dependant/dependent/
s/developement/development/
s/filesytem/filesystem/
s/guarenteed/guaranteed/
s/hiearchy/hierarchy/
s/intance/instance/
s/Interger/Integer/
s/mutiple/multiple/
s/nubmer/number/
s/occured/occurred/
s/overriden/overridden/
s/reseted/reset/
s/sytem/system/
s/unkown/unknown/

Signed-off-by: Michael Prokop <mika@grml.org>
2019-09-26 09:17:07 +02: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
Kai Wagner
03aa8b9643 doc: added openSUSE distros to the list and updated the releases
Signed-off-by: Kai Wagner <kwagner@suse.com>
2019-06-19 23:58:14 +02:00
Kefu Chai
afc6c1ea7b
Merge pull request #27201 from bstillwell/bootstrap-keyring-caps-doc-fix
doc: Add missing mgr cap for the bootstrap keyring

Reviewed-by: Kefu Chai <kchai@redhat.com>
2019-06-15 01:19:26 +08:00
Kefu Chai
cc1af444d7
Merge pull request #25099 from Thingee/master
doc: Adding US-Mid-West Mirror to docs

Reviewed-by: Kefu Chai <kchai@redhat.com>
2019-05-31 09:56:20 +08:00
Mike Perez
18048264e5 doc/install/mirrors: Adding US-Mid-West Mirror to docs
Signed-off-by: Mike Perez <thingee@gmail.com>
2019-05-31 09:06:55 +08: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
Jason Dillaman
65c8733b56 librados: revert librados3/libradoscc back to librados2
For backwards compatibility and upgrade reasons, the librados2
API needs to be preserved and it needs to continue to be compatible
with dependent libraries like librbd1.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-02-20 14:59:26 -05:00
Abhishek L
f9374b92fb
Merge pull request #23729 from daikk115/master
docs: Fixed swift client authentication fail

Reviewed-By: Abhishek Lekshmanan <abhishek@suse.com>
2019-01-14 11:00:27 +01:00