Commit Graph

7056 Commits

Author SHA1 Message Date
Kefu Chai
5238f9f62b doc: fix broken hyper link
and always reference multisite.rst using tha label not the file.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:18 +08: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
253fd22896 doc: add sphinx.ext.mathjax for math-to-MathML rendering
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:18 +08:00
Kefu Chai
84e2808afb doc: fix broken hyper link
this link was broken in 1427905c47

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
Kefu Chai
cf357e17ab doc/conf.py: define CEPH_RADOS_API for breathe
otherwise we could have following errors:

Invalid C declaration: Expected identifier in nested name, got keyword: int [error at 18]
      CEPH_RADOS_API int rados_aio_append (rados_ioctx_t io, const char *oid, rados_completion_t completion, const char *buf, size_t len)
      ------------------^

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-28 20:35:21 +08:00
Kefu Chai
fa7ea35832 script/gen_state_diagram.py: s/python/python3/
python does not necessarily on a modern distro which has only python3,
so use python3 instead.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-28 20:35:21 +08:00
Kefu Chai
08255a48a7
Merge pull request #36762 from qwren/qat-doc-update
doc: the update for QAT Acceleration

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-08-28 10:48:52 +08:00
Sebastian Wagner
26f231f60a
Merge pull request #36572 from dmick/wip-cephadm-doc
doc/mgr: Clean up orchestrator.rst (spell/punct, awkward wording)

Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Varsha Rao <varao@redhat.com>
2020-08-27 17:07:33 +02:00
Sebastian Wagner
a80eafcf7a
Merge pull request #36330 from Devp00l/wip-46551
cephadm: Update error message on host failure

Reviewed-by: Michael Fritch <mfritch@suse.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-27 11:59:36 +02:00
Dan Mick
a2a9054202 doc/mgr: Clean up orchestrator.rst (spell/punct, awkward wording)
Signed-off-by: Dan Mick <dmick@redhat.com>
2020-08-26 20:07:10 +00:00
Patrick Donnelly
d2a3fcc728
Merge PR #36773 into master
* refs/pull/36773/head:
	mgr/volumes: Prevent subvolume recreate if trash is not-empty
	mgr/volumes: Disallow subvolume group level snapshots
	mgr/volumes: Add test case to ensure subvolume is marked
	mgr/volumes: handle idempotent subvolume marks
	mgr/volumes: Tests amended and added to ensure subvolume trash functionality
	mgr/volumes: Mark subvolume root with the vxattr ceph.dir.subvolume
	mgr/volumes: Move incarnations for v2 subvolumes, to subvolume trash
	mgr/volumes: maintain per subvolume trash directory
	mgr/volumes: make subvolume_v2::_is_retained() object property

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-08-26 10:46:07 -07:00
Shyamsundar Ranganathan
f97e57c28c mgr/volumes: Disallow subvolume group level snapshots
Fixes: https://tracker.ceph.com/issues/47154
Signed-off-by: Shyamsundar Ranganathan <srangana@redhat.com>
2020-08-26 13:41:26 -04:00
Stephan Müller
1bfb044518 cephadm: Update error message on host failure
Now the error message explains how to add the ssh key to the not
reachable host

Fixes: https://tracker.ceph.com/issues/46551
Signed-off-by: Stephan Müller <smueller@suse.com>
2020-08-25 12:58:17 +02:00
Qiaowei Ren
6488e116c3 doc: update QATzip doc for removing snappy and lz4 support
This patch update the documentation about QAT acceleration for encryption
and compression.

QATZip provide the interfaces for several compression algorithm, including
deflate, snapp and lz4, but currently only deflate can be accelerated by QAT
hardware.

Signed-off-by: Qiaowei Ren <qiaowei.ren@intel.com>
2020-08-25 15:39:47 +08:00
Sage Weil
c7244e7aad misc language changes: whitelist -> ignore etc
Signed-off-by: Sage Weil <sage@newdream.net>
2020-08-24 19:53:08 +00:00
Sage Weil
dfd01d7653 blacklist -> blocklist
Signed-off-by: Sage Weil <sage@newdream.net>
Signed-off-by: Neha Ojha <nojha@redhat.com>
2020-08-24 19:53:08 +00:00
Sebastian Wagner
20b679a892 doc/man/cephadm: Add missing parameters for ls
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-24 10:28:07 +02:00
Patrick Donnelly
3fb857cd04
Merge PR #36131 into master
* refs/pull/36131/head:
	doc: document cephfs mirroring dev work
	test: add tests for `ceph fs mirror` family of commands
	mds: track filesystem mirror peers in fsmap

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-08-21 18:40:42 -07:00
Kefu Chai
c8bfc66f2d
Merge pull request #35789 from Reperator/fix-ceph-objectstore-tool-docs
doc/man/8/ceph-objectstore-tool.rst: remove duplicate lines

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-08-21 18:31:20 +08:00
Kefu Chai
344d964b94
Merge pull request #36742 from hulksmaaash/patch-2
doc/rados: remove statement that ISA plugin only works on Intel chips

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-08-21 18:26:46 +08:00
Sebastian Wagner
cb529acaf4
Merge pull request #36496 from Daniel-Pivonka/cephadm-44926
mgr/cephadm: rgw update period after realm, zone creation

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-21 11:40:17 +02:00
Sebastian Wagner
95042ecce8
Merge pull request #36716 from jmolmo/dashboard_ports_2
cephadm: Allow users to use a custom dashboard ssl port

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-21 11:39:52 +02:00
Kefu Chai
ec73fea99e
Merge pull request #36680 from tchaikov/wip-mgr-disk-predict
pybind/mgr/diskprediction_cloud: remove mgr-diskprediction-cloud

Reviewed-By: Josh Durgin <jdurgin@redhat.com>
Reviewed-By: Zac Dover <zac.dover@gmail.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Laura Paduano <lpaduano@suse.com>
2020-08-21 09:46:54 +08:00
Robbie Williamson
ccee814ffc doc/rados: remove statement that ISA plugin only works on Intel chips
ISA-L supports aarch64 (Arm), not just Intel processors, as does Ceph (see #32171).

Signed-off-by: Robbie Williamson <robbie.williamson@arm.com>
2020-08-21 08:32:53 +08:00
Juan Miguel Olmo Martínez
08c4a53e79
cephadm: Allow users to use a custom dashboard ssl port
This modification allows the user to create a new bootstrap cluster using a predefined SSl port for the dashboard.
If firewall is enabled, any new manager daemon deployed in new hosts will take care of open the required ports for all the services enabled in the manager.

Two new parameters for cephadm tool (aka binary or standalone):
Command bootstrap:
--ssl-dashboard-port SSL_DASHBOARD_PORT
                      Port number used to connect with dashboard using SSL
Command deploy:
--tcp-ports TCP_PORTS
                      List of tcp ports to open in the host firewall

Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2020-08-20 13:56:59 +02:00
Kefu Chai
d4bf845890
Merge pull request #36702 from tchaikov/wip-doc-crimson
doc/dev/crimson: fix a typo

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2020-08-19 18:57:02 +08:00
Kefu Chai
9dd16638ea doc/mgr/diskprediction: add a configuration section
also link to monitoring, as diskprediction cannot function without
enabling monitoring.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-19 11:08:39 +08:00
Kefu Chai
9127866a6c doc/mgr/diskprediction.rst: remove references to diskprediction_cloud
since https://www.diskprophet.com is not accessible anymore, and this
feature is not available at the time of writing. let's drop the related
document.

Fixes: https://tracker.ceph.com/issues/46863
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-19 11:08:39 +08:00
Daniel-Pivonka
b59b480c3d doc/cephadm: remove ssh user limitation troubleshooting
Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
2020-08-18 16:46:35 -04:00
Daniel-Pivonka
70b11a1a83 mgr/cephadm: rgw update period after realm, zone creation
Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
2020-08-18 15:54:31 -04:00
Kefu Chai
3034b22227 doc/dev/crimson: fix a typo
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-19 00:13:04 +08:00
Sebastian Wagner
b0a62b639d
Merge pull request #36568 from jschmid1/remove_osd_spec
mgr/orchestrator: remove traces of ceph orch osd spec

Reviewed-by: Kiefer Chang <kiefer.chang@suse.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-18 15:38:36 +02:00
Kefu Chai
cb1143d4db
Merge pull request #36674 from tchaikov/wip-doc-crimson
doc/dev/crimson: note about script/ceph-debug-docker.sh

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2020-08-18 19:05:42 +08:00
Abhishek L
7b012a9799
Merge pull request #36669 from smithfarm/wip-nautilus-11
doc/releases: add Nautilus 14.2.11 to timeline

Reviewed-By: Kefu Chai <kchai@redhat.com>
Reviewed-By: Zac Dover <zac.dover@gmail.com>
Reviewed-By: Abhishek Lekshmanan <abhishek@suse.com>
2020-08-17 10:42:10 +02:00
Kefu Chai
f7bad43f9d
Merge pull request #36228 from vosdev/doc-mgr-crash-typo
doc/mgr/crash: Add missing command in rm example

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-08-17 11:17:02 +08:00
Kefu Chai
2a760c596d doc/dev/crimson: note about script/ceph-debug-docker.sh
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-16 23:14:21 +08:00
Nathan Cutler
2bbb857841 doc/releases: add Nautilus 14.2.11 to timeline
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2020-08-15 22:55:44 +02:00
Tiago Melo
bc0650b057 mgr/dashboard: Update list of supported browsers
Fixes: https://tracker.ceph.com/issues/46923

Signed-off-by: Tiago Melo <tmelo@suse.com>
2020-08-14 11:53:48 +00:00
Abhishek L
d0a18dd52e
Merge pull request #36570 from theanalyst/doc/releases/v14.2.11
doc: releases: notes for v14.2.11 nautilus

Reviewed-By: Neha Ojha <nojha@redhat.com>
Reviewed-By: Josh Durgin <jdurgin@redhat.com>
Reviewed-By: Patrick Donelly <pdonell@redhat.com>
2020-08-12 16:10:57 +02:00
Venky Shankar
bab0b1287d doc: document cephfs mirroring dev work
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2020-08-12 09:28:12 -04:00
Abhishek Lekshmanan
0ceb0beb4d doc: releases: notes for v14.2.11 nautilus
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2020-08-12 11:54:09 +02:00
Patrick Donnelly
dc06096a2d
Merge PR #36351 into master
* refs/pull/36351/head:
	qa/tasks/cephfs/nfs: Add tests for cluster config set and reset
	doc/cephfs/nfs: Update the doc about 'reset' and 'set' config interfaces
	mgr/volumes/nfs: Add interface for adding user defined configuration

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-08-11 15:55:52 -07:00
Lenz Grimmer
a21ff0c562
Merge pull request #36111 from vosdev/patch-2
doc/mgr/dashboard: Fix haproxy example to use ssl for backends

Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Stephan Müller <smueller@suse.com>
2020-08-11 18:09:24 +02:00
Joshua Schmid
f8b8e6f229
docs/mgr: remove traces of ceph orch osd spec
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-08-11 16:47:36 +02:00
Sebastian Wagner
c625a51635
Merge pull request #36538 from zdover23/wip-docs-45678-fix
doc/cephadm: Remove shell alias

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-11 01:15:54 +02:00
Varsha Rao
287da11921 doc/cephfs/nfs: Update the doc about 'reset' and 'set' config interfaces
Signed-off-by: Varsha Rao <varao@redhat.com>
2020-08-10 10:19:57 +00:00
Sebastian Wagner
75baae3528 doc/cephadm: Remove shell alias
Turns out, the alias doesn't work for files.

Fixes: https://tracker.ceph.com/issues/46701

Fixes:

```
$ ceph orch apply -i myfile.yaml
ERROR: no such file or directory: myfile.yaml
```

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-08-10 17:50:54 +10:00