Commit Graph

496 Commits

Author SHA1 Message Date
Patrick Donnelly
319b578b14
Merge PR #40972 into master
* refs/pull/40972/head:
	doc: add missing note about restoring allow_standby_replay
	doc: clarify distributed ephemeral pins new mechanism
	doc: update mds_autoscaler documentation to reflect recent changes

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2021-06-15 14:57:44 -07:00
Patrick Donnelly
f5fa58cb1f
doc: document new .mgr pool
And that pool names beginning with `.` are reserved names.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-06-11 19:35:17 -07:00
Patrick Donnelly
570c7ffc01
doc: update mds_autoscaler documentation to reflect recent changes
Notably, Sage changed how this worked in [1].

[1] 6d8c0e4722

Fixes: https://tracker.ceph.com/issues/51187
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-06-11 19:07:42 -07:00
hoamer
78bb36cb62 doc/mgr/administrator: add a more precise description for creating key
added a more precise description to handle filename when creating key for mgr

Signed-off-by: hoamer <kontakt@sebastian-neugebauer.de>
2021-06-04 16:56:56 +08:00
Kefu Chai
28b08874ae doc/mgr/modules: add a "debugging" section
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-06-02 16:58:58 +08:00
Kefu Chai
dfdcf2cf92 doc/mgr: use confval directive to define options
less repeating this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-28 07:44:44 +08:00
Kefu Chai
b87189f713 doc/mgr/influx: use :confval: directive
less repeating this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-25 08:59:29 +08:00
Kefu Chai
f2750a7912 doc/mgr/prometheus: use confval directive to define options
less repeating this way.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-11 16:05:04 +08:00
Kefu Chai
bb351842bc doc/rados/configuration/general-config-ref: use describe to define non-options
max_open_files is not generated from yaml files, so define it using
"describe" directive instead.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 22:21:43 +08:00
Kefu Chai
98dc0d4e85 doc/_ext: load options defined by mgr modules
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 20:54:42 +08:00
Kefu Chai
ed79c4f74a doc/mgr/modules: should use Option class for defining options
it is the encouraged way to define options nowadays.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-06 11:57:30 +08:00
Alfonso Martínez
335a91d20d mgr/dashboard: update documentation about creating NFS export.
- You learn first that orchestrator-managed clusters are detected automatically (therefore the documentation that follows is exclusively for user-defined clusters).
- Include nfs-ganesha in the security scope list.

Fixes: https://tracker.ceph.com/issues/50440
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-04-22 14:10:25 +02:00
Daniel Pivonka
41a1df1b96 doc/cephadm: fix rgw realm and zone flags
Signed-off-by: Daniel Pivonka <dpivonka@redhat.com>
2021-03-26 16:18:28 -04:00
Alfonso Martínez
58253a0002 mgr/dashboard: fix error notification shown when no rgw daemons are running.
- Adapted code to changes introduced in: https://github.com/ceph/ceph/pull/40220
- Improved error handling.
- Increased test coverage.
- Some refactoring.
- Simplified documentation about setting default daemon host and port.

Fixes: https://tracker.ceph.com/issues/49655
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-03-23 11:14:11 +01:00
Kefu Chai
1dbc932195 doc: use :ref: instead relative path for links
path is fragile when we move the file around, but link is more stable.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-22 01:41:53 +08:00
Kefu Chai
cdbc1a9f22 doc/mgr: fix formatting
a code block should start with "::".

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-12 00:32:45 +08:00
Sebastian Wagner
175ee83909 mgr/orch: replace def add_{type}(...) with generic add_daemon()
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-03-10 15:02:41 +01:00
Sebastian Wagner
b6a2dfc777
Merge pull request #39877 from liewegas/cephadm-rgw-simplification
mgr/cephadm: simplify handling for rgw

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
Reviewed-by: Or Friedmann <ofriedma@redhat.com>
2021-03-10 13:58:37 +01:00
Sage Weil
50bc491373 doc: update docs
Signed-off-by: Sage Weil <sage@newdream.net>
2021-03-09 14:29:39 -05:00
Jonas Jelten
4f98499bfa doc/mgr/crash: explain needed crash upload permissions
Signed-off-by: Jonas Jelten <jj@sft.lol>
2021-03-09 14:12:32 +01:00
Sebastian Wagner
d529f1db82 doc/mgr/orchestrator_modules: adapt to now orch interface
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-03-01 16:50:42 +01:00
Sebastian Wagner
a4aef4a49d doc/cephadm: move host labels to host mgmt
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
1033c46ad7 doc/cephadm: group MDS sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
b3846f6f6a doc/cephadm: group MON sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
0fb2ccb49b doc/cephadm: make custom containers its own chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
818ed4f202 doc/cephadm: group RGW mgmt sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
11fe5ef7cf doc/cephadm: group general service mgmt sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
74bcd7c5f6 doc/cephadm: group OSD mgmt sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
88e8e91f72 doc/cephadm: group host mgmt sections into one chapter
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Alfonso Martínez
94fe271b06 mgr/dashboard: select any object gateway on local cluster.
Dashboard backend settings:
- Refactoring: now accepting more than 1 type of value.
- RGW_API_ACCESS_KEY & RGW_API_SECRET_KEY accept string (backward compatibility: legacy behavior) as well as dictionary of strings for connecting multiple daemons.
- Ease of use: deprecated: mgr/dashboard/RGW_API_USER_ID: not useful anymore (kept for backward compatibility).

UI/UX:
- Created context component (to be shown only on rgw-related routes) for selecting operating daemon.
- Daemon selector only shown if there is more than 1 daemon running on a local cluster (to reduce cognitive load).

Fixes: https://tracker.ceph.com/issues/47375
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-02-24 08:21:11 +01:00
Sebastian Wagner
316b4ad614
Merge pull request #39472 from sebastian-philipp/doc-cephadm-host-labels
doc/orch: Host labels

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-02-19 13:28:51 +01:00
Sebastian Wagner
4cb501416d doc/orch: Host labels
Fixes: https://tracker.ceph.com/issues/45833
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-18 12:49:46 +01:00
Sebastian Wagner
5c872ace45 doc/cephadm: Disable automatic deployment of daemons
Fixes: https://tracker.ceph.com/issues/45767
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-16 16:11:06 +01:00
Paul Cuzner
a4f4a67fe7 mgr/orchestrator: doc updated to show optional parameter
Updated the orch status document to show the --detail option

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2021-02-03 11:47:49 +13:00
Mitsumasa KONDO
53639c2b01 doc/mgr/orchestrator: Unify the content of command and yaml
Signed-off-by: Mitsumasa KONDO <kondo.mitsumasa@gmail.com>
2021-02-01 18:13:12 +08:00
Sebastian Wagner
d055d855ea
Merge pull request #38686 from wornet-mwo/wip-doc-add-section-declarative-orch-cmd
doc: added section about retival of Service Specication

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-01-29 12:37:15 +01:00
Michael Wodniok
f857bcd622 doc: Applied text as suggested by @zdover23
Signed-off-by: Michael Wodniok <wodniok@wor.net>
2021-01-27 08:19:06 +01:00
Adam King
aeeffb07f1 mgr/cephadm: force flag for ok-to-stop and ok-to-stop for monitoring stack
Daemons that could cause data loss when stopped will always block.

Daemons that will only cause loss in availability should block but have
a workaround in the form of a force flag if the user is okay with the service
being down.

Also implements ok-to-stop for monitoring stack daemons that uses this system
of blocking on availability loss unless force flag is provided

Signed-off-by: Adam King <adking@redhat.com>
Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
2021-01-20 08:21:55 -05:00
Michael Wodniok
d97731969a
doc: changed commands as suggested by @sebastian-philipp
Signed-off-by: Michael Wodniok <wodniok@wor.net>

Co-authored-by: Sebastian Wagner <sebastian@spawnhost.de>
2021-01-19 13:15:32 +01:00
Michael Wodniok
a955306199 doc: added internal link
Linked from Service Status to retrieval of specificaton section as
`ceph orch ls --export` is also mentioned there.

Signed-off-by: Michael Wodniok wodniok@wor.net
2021-01-19 13:12:57 +01:00
Kefu Chai
ae7faa9db5 doc/mgr: document CLICommand and friends
the annotation and docstring are critical after we use them for
describing the command.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-01-15 23:11:58 +08:00
Daniel-Pivonka
a398fc239f cephadm: HA for RGW endpoints
Cephadm deploying keepalived and HAproxy for providing High availability for RGW endpoints

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

Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
Signed-off-by: Adam King <adking@redhat.com>
Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-01-08 17:00:51 -05:00
Michael Wodniok
84bdafe0e3 doc: added section about retival of Service Spec.
Signed-off-by: Michael Wodniok <wodniok@wor.net>
2020-12-22 10:48:32 +01:00
Alfonso Martínez
5d7ee7c1f0 mgr/dashboard: CLI commands: read passwords from file
Fixes: https://tracker.ceph.com/issues/48355

Signed-off-by: Alfonso Martínez <almartin@redhat.com>
Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2020-12-17 08:36:57 +01:00
zdover23
9838e03b01
Merge pull request #38580 from anthonyeleven/anthonyeleven/48301-underscores
doc: standardize config option names with interstitial underscores

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-12-17 01:11:53 +10:00
Nizamudeen A
3f50b05e25 mgr/dashboard: Updating the docs regarding the user lockout
Fixes: https://tracker.ceph.com/issues/40914
Signed-off-by: Nizamudeen A <nia@redhat.com>
2020-12-16 16:14:47 +05:30
Anthony D'Atri
21d68cf137 doc: standardize config option names to use interstitial underscores
Ceph config option names may use spaces, underscores, or by one reference hyphens
as interstitial separators. Most usage within the doc tree uses underscores,
though example conf files and especially structured lists of options mostly
use spaces. Mostly. Underscores help differentiate the config names from
surrounding text, and moreover facilitate scripting, grep, awk, etc and match
their form in src/common/options.cc.

This PR conforms these occurrences of option names to use interstitial underscores instead of spaces.

Fixes: https://tracker.ceph.com/issues/48301
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-12-15 13:55:38 -08:00
Ernesto Puerta
ba650bf561
Merge pull request #37937 from p-se/cd-alternative-grafana-fe-url
mgr/dashboard: enable different URL for users of browser to Grafana

Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2020-12-15 19:47:30 +01:00
Sebastian Wagner
453000af19 doc/cephadm: Add remove host to operations
Co-authored-by: Alexandra Settle <asettle@suse.com>
Co-authored-by: Kefu Chai <tchaikov@gmail.com>
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-12-09 12:34:16 +01:00
Patrick Seidensal
676f82923d mgr/dashboard: enable different URL for users of browser to Grafana
Fixes: https://tracker.ceph.com/issues/47386

Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
2020-12-04 17:08:29 +01:00