Commit Graph

626 Commits

Author SHA1 Message Date
Sage Weil
7cc4c91dce doc/mgr/nfs: add section on updating an nfs cluster
Signed-off-by: Sage Weil <sage@newdream.net>
2021-08-11 11:32:35 -05:00
Sage Weil
6f8bdfbb90 Merge PR #42252 into master
* refs/pull/42252/head:
	mgr/dashboard: set rgw credentials: fix api tests
	mgr/dashboard: run-frontend-e2e-tests.sh: remove unneeded rgw setting
	mgr/dashboard: rgw service creation form: add realm and zone to service spec.
	mgr/dashboard: connect-rgw: rename to set-rgw-credentials; refactoring
	mgr/dashboard: connect-rgw: adaptation and test coverage
	mgr/cephadm: re-check dashboard <-> rgw creds when rgw daemons created/destroyed
	mgr/dashboard: add 'dashboard connect-rgw' command
	doc/mgr/dashboard: simplify dashboard+rgw config docs

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Juan Miguel Olmo <jolmomar@redhat.com>
2021-08-11 11:28:28 -04:00
Sage Weil
3331a0a7ea Merge PR #42691 into master
* refs/pull/42691/head:
	mgr/nfs: add --port to 'nfs cluster create' and port to 'nfs cluster info'
	qa/suites/orch/cephadm/smoke-roleless: test taking ganeshas offline
	qa/tasks/vip: exec with bash -ex
	qa/suites/orch/cephadm: separate test_nfs from test_orch_cli

Reviewed-by: Varsha Rao <varao@redhat.com>
2021-08-10 16:37:38 -04:00
Alfonso Martínez
6e20ef1dd3 mgr/dashboard: connect-rgw: rename to set-rgw-credentials; refactoring
- Rename the dashboard command to better reflect its behavior.
- Rename '_radosgw_admin' method to 'send_rgwadmin_command' for consistency with
  'send_mon_command' and move it to the mgr_module.py .
- Cleanup: remove unneeded rgw settings.
- Better error handling and test coverage.

Fixes: https://tracker.ceph.com/issues/44605
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-08-10 14:06:03 +02:00
Sage Weil
599116a068 doc/mgr/dashboard: simplify dashboard+rgw config docs
Signed-off-by: Sage Weil <sage@newdream.net>
2021-08-10 14:06:03 +02:00
Sage Weil
8ebe341198 mgr/nfs: add --port to 'nfs cluster create' and port to 'nfs cluster info'
Fixes: https://tracker.ceph.com/issues/51787
Signed-off-by: Sage Weil <sage@newdream.net>
2021-08-09 11:41:08 -04:00
Ernesto Puerta
3582bbc034
doc,mgr/dashboard: clarify SSO documentation
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2021-08-06 19:31:42 +02:00
Laura Flores
1734647008
doc/mgr/telemetry: fix formatting problem
There was strange bolding and bullet point placement due to a missing new line in the perf description.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-07-28 10:11:17 -05:00
Josh Durgin
624068d244
Merge pull request #42322 from ljflores/wip-lflores-telemetry-docs
doc/mgr/telemetry: update Telemetry Module docs to include perf channel

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-07-27 17:31:33 -07:00
Sage Weil
9aeefbc666 doc/mgr/rook: update title
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-27 10:47:55 -04:00
Sage Weil
7d3443412c doc/mgr/nfs: reference customizing ingress
Link to the cephadm docs on modifying the service directly.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-27 10:47:55 -04:00
Sage Weil
b5a32d632d doc/mgr/nfs: add section for manual ganesha config; reframe
This documentation is incomplete because this mode of operation is not
tested/validated.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-27 10:47:55 -04:00
Sage Weil
8d9db910f7 doc/mgr/nfs: document ingress in more detail
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:17 -04:00
Sage Weil
0448a8d39d doc/mgr/nfs: typo
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:17 -04:00
Sage Weil
684c6a2dba doc/mgr/nfs: add note about incomplete ingress
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:17 -04:00
Sage Weil
ad5fe4452d mgr/nfs: add --squash option to 'nfs export create rgw ...'
The cephfs variant already has it.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:17 -04:00
Sage Weil
8b96d9c22b doc/mgr/nfs: revisions
- clean up language
- move config hierarchy to the bottom (this is an implementation detail
that is only useful if managing ganesha externally)

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-26 16:23:06 -04:00
Kefu Chai
9e5986c441 doc/mgr/administrator: document mgr_disabled_modules
this option prevent mgr from loading specified modules. which could
be handly when debugging issues with always_on_modules.

and document mgr_standby_modules as well.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-07-20 11:09:09 +08:00
Ernesto Puerta
64dbe17fdb
Merge pull request #42188 from votdev/issue_51408_motd
mgr/dashboard: Add configurable MOTD or wall notification

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Nizamudeen A <nia@redhat.com>
Reviewed-by: Paul Cuzner <pcuzner@redhat.com>
Reviewed-by: Tatjana Dehler <tdehler@suse.com>
Reviewed-by: sebastian-philipp <NOT@FOUND>
Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2021-07-19 19:56:50 +02:00
Sage Weil
62e4ea5ff1 doc/mgr/nfs: fix 'export apply', pool name
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-15 09:47:39 -04:00
Sage Weil
3cfd779e5b doc/cephfs/fs-nfs-exports: document new export apply capabilities
- import list
- import ganesha conf

Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-14 16:20:11 -04:00
Sage Weil
01c006c2de Merge PR #42041 into master
* refs/pull/42041/head:
	mgr/restful: ignore min/max_size
	test/crush: drop min/max_size refs
	qa/workunits/mon/pool_ops: remove test for min/max_size check
	qa: scrub a few remaining mentions of ruleset
	qa/standalone/mon/osd-*: fix tests
	PendingReleaseNotes: note min/max_size removal
	mgr/dashboard: remove max/min_size and ruleset
	mon/OSDMonitor: fix calls to CrushTester
	crush: eliminate min_size and max_size
	test/cli/crushtool: reunumber rulesets in test maps
	crushtool: require min/max or num-rep for --test
	crush: remove last traces of 'ruleset'
	test/cli/crushtool: use 'id' instead of 'ruleset' in crush inputs
	crushtool: take --min-rep and --max-rep explicitly
	crush/CrushTester: drop --ruleset
	doc: scrub 'ruleset' from docs
	src/erasure-code: rule, not ruleset
	mon/OSDMonitor: remove check_crush_rule() callers
	mon/OSDMonitor: rule, not ruleset
	crushtool: remove check for overlapped ruels
	crush/CrushWrapper: get_osd_pool_default_crush_replicated_ruleset -> rule
	crush: remove find_rule()
	mon/OSDMonitor: use pool's crush rule directly
	osd/OSDMap: drop checks for ruleset == ruleid
	osd/OSDMap: use pool's crush rule_id directly
	mon/PGMap: use pool's crush_rule directly
	mon/OSDMonitor: remove crush ruleset->rule rewrite

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Avan Thakkar <athakkar@redhat.com>
2021-07-14 14:38:59 -04:00
Volker Theile
f7f163e75c mgr/dashboard: Add configurable MOTD or wall notification
Fixes: https://tracker.ceph.com/issues/51408

Signed-off-by: Volker Theile <vtheile@suse.com>
2021-07-14 10:48:49 +02:00
Laura Flores
f318eed2a4 doc/mgr/telemetry: update Telemetry Module docs to include perf channel
PR #42074 adds a new perf channel to the Telemetry Module. With this commit, the docs will reflect that addition. Within the Telemetry Module docs, I explain the purpose of the new perf channel as well as some use cases of the metrics that will be collected under the channel.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-07-13 20:44:44 +00:00
Varsha Rao
387369373c doc/mgr/nfs: update about RGW exports
This patch just moves the RGW exports created using nfs module to mgr/nfs
document. The RGW requirements will be updated in a different PR.

Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 15:04:54 +05:30
Varsha Rao
5db2b48f14 doc/mgr/nfs: update cephfs export create command about client and squash arguments
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 14:37:39 +05:30
Varsha Rao
ce7fef695b doc/mgr/nfs: update nfs links
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 14:37:39 +05:30
Varsha Rao
29f28563ec doc/mgr/nfs: add missing cluster_id to export info command
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 14:37:39 +05:30
Varsha Rao
c79b797465 doc/cephfs: move nfs doc under mgr docs
Fixes: https://tracker.ceph.com/issues/51428
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-07-13 14:37:39 +05:30
Sage Weil
8976fcf476 doc: scrub 'ruleset' from docs
Signed-off-by: Sage Weil <sage@newdream.net>
2021-06-28 18:34:31 -04:00
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
Kefu Chai
48515e9b8d
Merge pull request #38265 from Rethan/doc-prometheus-config-key
doc/mgr/prometheus: update 'config-key set' to 'config set' for consistency

Reviewed-by: Mykola Golub <mgolub@suse.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-26 19:52:10 +08:00
haoyixing
f5fd172559 doc/mgr/prometheus: update 'config-key set' to 'config set' for consistency
Elsewere in mgr/prometheus use the 'config set' way, so update the only 'config-key set'
to make it consistent.

Signed-off-by: haoyixing <haoyixing@kuaishou.com>
2020-11-26 14:23:56 +08:00
zdover23
eefa5e33ff
Merge pull request #38088 from anthonyeleven/anthonyeleven/docs-47627
doc/mgr: document dashboard configuration unsetting

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-25 22:10:41 +10:00
Anthony D'Atri
3ea3975ad0 doc/mgr: document dashboard configuration unsetting
Fixes: https://tracker.ceph.com/issues/47627
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-24 10:03:34 -08:00
Anthony D'Atri
9c67b80495 doc/mgr: Fix msgr2 TCP port in a couple of examples
Fixes: https://tracker.ceph.com/issues/47976
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-19 22:58:10 -08:00
Lenz Grimmer
610a2426a9
Merge pull request #37641 from henyxia/dev/henyxia/add-mgr-dashboard-prom-ssl-verify
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Patrick Seidensal <pnawracay@suse.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2020-11-09 15:07:57 +01:00
Volker Theile
1927809b0b doc/mgr/orchestrator: Add hints related to custom containers to the docs
Fixes: https://tracker.ceph.com/issues/48113

Signed-off-by: Volker Theile <vtheile@suse.com>
2020-11-04 14:39:44 +01:00
Varsha Rao
a251cea714 doc/mgr/orchestrator: Update about nfs add in rook
"nfs add" is no longer supported in rook. Instead "apply nfs" should be used to
deploy nfs-ganesha daemons.

Signed-off-by: Varsha Rao <varao@redhat.com>
2020-11-03 12:13:10 +05:30
Varsha Rao
23b9fb6456 doc/mgr/orchestrator: Update about "{mds, rgw} add" status in rook
"mds add" and "rgw add" are no longer supported in rook. Their implementation
was removed by commits 56cfeb6 and 0580297. Instead "apply mds" and "apply rgw"
is preferred.

Signed-off-by: Varsha Rao <varao@redhat.com>
2020-10-28 19:16:35 +05:30
Jean "henyxia" Wasilewski
0f230ea49b mgr/dashboard: add ssl verify option for prometheus and alert manager
Fixes: https://tracker.ceph.com/issues/47863

Signed-off-by: Jean "henyxia" Wasilewski <henyxia@revs0.com>
2020-10-26 21:51:32 +01:00
Patrick Donnelly
e5f917aa1c
Merge PR #37707 into master
* refs/pull/37707/head:
	doc: document the mds_autoscaler mgr plugin

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-10-20 08:21:22 -07:00
Milind Changire
50e680cb50 doc: document the mds_autoscaler mgr plugin
The MDS Autoscaler provides automation to maintain a required count of
MDSs in the system.
The MDS count in the system can be afected by:
* max_mds config option
* standby_count_wanted config option
* death of an active MDS Rank

Fixes: https://tracker.ceph.com/issues/46884
Signed-off-by: Milind Changire <mchangir@redhat.com>
2020-10-20 09:19:48 +05:30
Kiefer Chang
a5aaaa69cc doc/dashboard: add information for Orchestrator NFS-Ganesha clusters
Fixes: https://tracker.ceph.com/issues/46492
Signed-off-by: Kiefer Chang <kiefer.chang@suse.com>
2020-10-19 19:11:17 +08:00
Joshua Schmid
b38bc14525 docs: <orch osd spec> is no longer present
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-10-02 10:22:55 +02:00
Courtney Caldwell
ca2261781e
mgr/dashboard/api: generate offline API docs
Generate Sphinx documentation from OpenAPI YAML spec:
- Fixed Docs controller doc generation
- Now dashboard Python doesn't fails if dashboard/frontend/dist doesn't exist
- OpenAPI added to @ceph/api CODEOWNERS
- Renamed Ceph-Dashboard API to Ceph REST or RESTful API.
- OpenAPI Docs: fixed decorators and docstrings.
- Sphinx Docs: updated dashboard and dev ones.

Co-authored-by: Ernesto Puerta <epuertat@redhat.com>
Fixes: https://tracker.ceph.com/issues/45863
Signed-off-by: Courtney Caldwell <ccaldwel@redhat.com>
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2020-09-28 12:03:03 +02:00
Kefu Chai
e492447fde
Merge pull request #37236 from jschmid1/osd_rm_doc_fix
docs: remove docs should say osd_id instead of svc_id

Reviewed-by: Michael Fritch <mfritch@suse.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-09-24 15:51:05 +08:00
Lenz Grimmer
e066050636
Merge pull request #37136 from p-se/cd-add-per-rbd-graphs
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Kiefer Chang <kiefer.chang@suse.com>
Reviewed-by: Laura Paduano <lpaduano@suse.com>
2020-09-23 12:59:06 +02:00
Anthony D'Atri
815263b583 doc/man: Add optional reweight-by-utilization args
doc/mgr: Grammar and wording for Prometheus labels
doc/rados: Spelling and clarity

Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-09-20 22:47:01 -07: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
Joshua Schmid
d7d1267686
docs: s/svc_id/osd_id
Fixes: https://tracker.ceph.com/issues/47402
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-09-18 14:33:40 +02:00
Volker Theile
7219377cfc cephadm: Introduce 'container' specification to deploy custom containers
Fixes: https://tracker.ceph.com/issues/46666

Signed-off-by: Volker Theile <vtheile@suse.com>
2020-09-17 10:04:11 +02:00
Lenz Grimmer
b17ca08037
Merge pull request #35956 from ishanrai05/hover
mgr/dashboard: Display description on mouse hover

Reviewed-by: Tiago Melo <tmelo@suse.com>
2020-09-16 13:49:54 +02:00
Joshua Schmid
25e5b8726d
Merge pull request #36898 from sebastian-philipp/doc-fix-orch-apply-mgr
doc/mgr: fix outdated `orch apply` docs.
2020-09-16 10:04:28 +02:00
Patrick Seidensal
0c0e6ee496 mgr/dashboard: update dashboard docs with RBD image monitoring paragraph
Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
2020-09-14 14:33:17 +02:00
Ishan Rai
40b5cad9e4 mgr/dashboard: display description on mouse hover
Fixes: https://tracker.ceph.com/issues/36607

Signed-off-by: Ishan Rai <ishanrai05@gmail.com>
2020-09-11 18:27:02 +00: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
Lenz Grimmer
3f3cd6c989
Merge pull request #36222 from ishanrai05/docs
doc: Create new chapter about the Dashboard's landing page

Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Stephan Müller <smueller@suse.com>
2020-09-02 08:51:15 +02:00
Ishan Rai
605d95c23d doc: create new chapter about the Dashboard's landing page
Fixes: https://tracker.ceph.com/issues/46415

Signed-off-by: Ishan Rai <ishanrai05@gmail.com>
2020-08-31 20:20:42 +05:30
Sebastian Wagner
f3bd8f2569 doc/mgr: fix outdated orch apply docs.
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-31 10:14:20 +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
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
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
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
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
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
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
5a15c730c2
Merge pull request #36151 from jschmid1/osd_support_reweight_impl
mgr/cephadm: rework osd removals/replacements

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-07-31 13:28:18 +02:00
Joshua Schmid
9606f4d602 doc/cephadm: adjust osd removal docs
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-07-31 10:23:59 +02:00
Joshua Schmid
a55c1dd0fa mgr/osd_support: remove module and all traces
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-07-31 10:11:45 +02:00
Varsha Rao
195f28a614 doc/mgr/orchestrator: Fix formatting and examples in create OSDs
Signed-off-by: Varsha Rao <varao@redhat.com>
2020-07-30 15:28:47 +02:00
Kefu Chai
5756643f45
Merge pull request #34928 from p-se/wip-pse-revise-monitoring-doc
mgr/dashboard: revise monitoring documentation

Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Stephan Müller <smueller@suse.com>
2020-07-28 20:49:58 +08:00
Sebastian Wagner
1125a805bd doc/cephadm: status doesn't show a progress
Fixes: https://tracker.ceph.com/issues/45858

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-07-27 16:50:05 +02:00
Michael Fritch
7906460483
doc/mgr/orchestrator: add missing OSD service_id
example for deploying multiple specs via yaml was missing the service_id

Fixes: https://tracker.ceph.com/issues/46377
Signed-off-by: Michael Fritch <mfritch@suse.com>
2020-07-22 16:41:58 -06:00
Daniel Vos
44911d1191 doc/mgr/dashboard: haproxy example to use ssl for backends
HAProxy talks to backends over http by default. Ceph mgr dashboard now only accepts https traffic.
This change configures haproxy to use https for communication with backends. `ssl` implies `check-ssl` making `check-ssl` is no longer neccesary.

Fixes: https://tracker.ceph.com/issues/46678
Signed-off-by: Daniël Vos <danielvos@outlook.com>
2020-07-22 21:00:13 +02:00
Daniel Vos
67e344290d doc/mgr/crash: Add missing command in rm example
Example to remove a crash id was missing the crash subcommand.

Fixes: https://tracker.ceph.com/issues/46676
Signed-off-by: Daniël Vos <danielvos@outlook.com>
2020-07-22 20:18:02 +02:00
Joshua Schmid
a8e21a114b doc: add notes about --dry-run
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-07-22 16:01:56 +02:00
Laura Paduano
43f47cbeb3
Merge pull request #36098 from s0nea/wip-doc-dashboard-nfs-issue
doc/mgr/dashboard: add note about known NFS issue

Reviewed-by: Sebastian Krah <skrah@suse.com>
Reviewed-by: Varsha Rao <varao@redhat.com>
Reviewed-by: Laura Paduano <lpaduano@suse.com>
2020-07-22 09:59:11 +02:00
Tatjana Dehler
4318f0e638 doc/mgr/dashboard: add note about known NFS issue
Add a note about a known NFS issue in relation to
the pool configuration to the documentation.

Fixes: https://tracker.ceph.com/issues/46530
Signed-off-by: Tatjana Dehler <tdehler@suse.com>
2020-07-15 12:09:23 +02:00
Juan Miguel Olmo Martínez
da62f752c5
doc/mgr/orchestrator: Add information about unmanaged parameter
Explain parameter 'unmanaged' in OSDs creation and deletion

Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2020-06-30 13:58:15 +02:00
Kefu Chai
e39c79ce3e
Merge pull request #35572 from p-se/wip-pse-prometheus-mod-cache
mgr/prometheus: improve cache

Reviewed-by: Boris Ranto <branto@redhat.com>
2020-06-24 11:32:16 +08:00
Patrick Seidensal
d6369ac159 mgr/dashboard: revise monitoring documentation
Fixes: https://tracker.ceph.com/issues/45406

Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
2020-06-22 11:55:29 +02:00
Patrick Seidensal
fa69d8e111 mgr/prometheus: improve Prometheus module cache
Improve cache by running requests in a thread and prevent multiple
requests to Ceph from multiple sources (e.g. Prometheus instances) which
increase load on the manager.

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

Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
2020-06-22 10:46:29 +02:00
Sebastian Wagner
b0bbef91f0 doc/mgr/orch: Update documentation to the new CLI
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-06-18 11:17:46 +02:00
Sebastian Wagner
55e608d796 doc/cephadm: Add chapter about FQDNs
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-06-15 15:26:11 +02:00
Sebastian Wagner
3204457917 doc/orch: How to update an existing specification
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-06-09 10:57:30 +02:00
Sebastian Wagner
a46d582422 doc/mgr: add docs for unmanaged=True
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-06-05 10:51:16 +02:00
Joshua Schmid
e9600666e0
doc/cephadm: align to all-available-devices flag
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-06-03 16:01:11 +02:00
Daniel-Pivonka
fed98dfab1 mgr/cephadm: cephadm bootstrap add --apply-spec <cluster.yaml>
Have a single command when setting up a cluster for Day 1

example spec

---
service_type: host
addr: jmo-node-00
hostname: jmo-node-00
labels:
- test
- test2
---
service_type: host
addr: jmo-node-01
hostname: jmo-node-01
labels:
- grafana
---
service_type: host
addr: jmo-node-02
hostname: jmo-node-02
---
service_type: grafana
placement:
  label: "grafana"
---
service_type: osd
placement:
  host_pattern: '*'
data_devices:
  all: true

Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
2020-05-28 12:26:48 -04:00
Sebastian Wagner
9e1e02508f
Merge pull request #34902 from p-se/wip-pse-doc-prom-security
mgr/dashboard: document Prometheus' security model

Reviewed-by: Alexandra Settle <asettle@suse.com>
Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Tatjana Dehler <tdehler@suse.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2020-05-27 12:22:44 +02:00
Patrick Seidensal
34765e9215 mgr/dashboard: document Prometheus' security model
Fixes: https://tracker.ceph.com/issues/45377

Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
2020-05-25 16:50:53 +02:00
Sebastian Wagner
e11db13559
Merge pull request #34668 from zdover23/wip-doc-ceph-orch-zap-45128
doc/ceph orch: Add ceph orch zap command

Reviewed-by: Joshua Schmid <jschmid@suse.de>
2020-05-14 13:39:49 +02:00
Zac Dover
845b05419a Incorporating sebastian-philipp's suggestions.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-05-13 03:05:56 +10:00
Tatjana Dehler
a241a00452 doc/mgr/dashboard: Add troubleshooting guide
Fixes: https://tracker.ceph.com/issues/25196
Signed-off-by: Tatjana Dehler <tdehler@suse.com>
2020-05-06 17:16:33 +02:00
Michael Fritch
586eb6ccb9
doc/mgr/orchestrator: update iscsi
`apply iscsi` and `add iscsi` are implemented in cephadm

Signed-off-by: Michael Fritch <mfritch@suse.com>
2020-05-04 12:28:05 -06:00
Lenz Grimmer
9334471340
Merge pull request #33991 from SchoolGuy/monitoring/rbd-image-details
mgr/dashboard/grafana: Add rbd-image details dashboard

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Jan Fajerski <jfajerski@suse.com>
Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Patrick Seidensal <pnawracay@suse.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2020-05-04 09:59:53 +02:00
Sebastian Wagner
ef8a2cde4f
Merge pull request #34707 from jschmid1/fix_orch_docs
doc/orchestrator: adapt to new syntax, add more examples

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-04-30 10:36:54 +02:00
Lenz Grimmer
dc9973a7fb
Merge pull request #33462 from s0nea/wip-dashboard-telemetry-report
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Kiefer Chang <kiefer.chang@suse.com>
Reviewed-by: Patrick Seidensal <pnawracay@suse.com>
Reviewed-by: Stephan Müller <smueller@suse.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2020-04-29 17:22:50 +02:00
Tatjana Dehler
18875ef337 mgr/dashboard: add telemetry report component
Add a telemetry component in order to give the user the
possibility to configure the telemetry module in a more
guided fashion. The component offers broader explanations,
shows a preview of the generated report and asks the user
to accept the license before enabling the module.

Fixes: https://tracker.ceph.com/issues/43956
Signed-off-by: Tatjana Dehler <tdehler@suse.com>
2020-04-29 16:34:00 +02:00