Commit Graph

117 Commits

Author SHA1 Message Date
John Spray
061ffa508e
Merge pull request #22792 from jcsp/wip-mgrmodule-none-docs
mgr: improve docs for MgrModule methods
2018-07-24 10:36:44 +01:00
John Spray
4fddb181de doc/mgr: add docs for missing functions
Some functions had docstrings but were
not linked into plugins.rst, some needed
more text added.

Signed-off-by: John Spray <john.spray@redhat.com>
2018-07-23 22:02:51 +01:00
John Spray
6ca387f275 doc: update mgr plugin page for remote calls
Signed-off-by: John Spray <john.spray@redhat.com>
2018-07-20 13:07:17 -04:00
Wido den Hollander
21fbfc9c3a
mgr/dashboard: Add option to disable SSL
Although is preferred and should be enabled by default users might
want to disable SSL as the dashboard might be running behind a proxy
which terminates the SSL.

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

Signed-off-by: Wido den Hollander <wido@42on.com>
2018-07-11 10:49:22 +02:00
Sage Weil
6dbf8ad2ec Merge PR #22703 into master
* refs/pull/22703/head:
	doc/mgr: add doc for crash mgr module
	qa/suites/rados/mgr: Add test_crash
	qa/tasks/mgr: add test_crash, call from test_module_selftest
	qa/tasks/{ceph_manager.py,vstart_runner.py}: allow kwargs in raw_*
	mgr/pybind/crash: handle crashdumps

Reviewed-by: John Spray <john.spray@redhat.com>
2018-07-04 14:22:18 -05:00
John Spray
414d94ae42 doc/dashboard: don't advise mgr_initial_modules
This setting tends to confuse people, as it's only respected
on the very first startup of the cluster.  Instead, mention
it (with appropriate caveats) on the general mgr admin
page.

Signed-off-by: John Spray <john.spray@redhat.com>
2018-07-03 09:48:56 +01:00
Dan Mick
eb1103e94d doc/mgr: add doc for crash mgr module
Signed-off-by: Dan Mick <dan.mick@redhat.com>
2018-06-29 14:53:14 -07:00
Jos Collin
a703e22bc4 doc: s/doc/ref for dashboard urls
Replaced :doc: with :ref: as per https://github.com/ceph/ceph/pull/22750#discussion_r198895040.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-06-29 20:19:56 +05:30
Jos Collin
1007a19b7e doc: Updated dashboard doc references
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-06-28 16:02:06 +05:30
Jos Collin
22f205718a doc: updated the overview and glossary for dashboard
* Updated the overview of dashboard to avoid many paragraphs,
some outdated statements, etc.
* Updated glossary, glossary references and urls
* Dropped unnecessary term *module* in possible places
* Unified the new dashboard name as *Ceph Manager Dashboard*

Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-06-28 16:01:30 +05:30
Ricardo Dias
1538d570ad
doc/mgr/dashboard: user and role management documentation
Signed-off-by: Ricardo Dias <rdias@suse.com>
2018-06-26 12:28:54 +01:00
Jos Collin
72f14881ae doc/dashboard: fix formatting on Grafana instructions
The whole list was in a code block, instead of just the snippets.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-06-26 09:10:15 +05:30
Sage Weil
37d20dfdc5 Merge PR #22661 into master
* refs/pull/22661/head:
	mgr: remove unused [get|set]_store_json fns

Reviewed-by: Sage Weil <sage@redhat.com>
Reviewed-by: Dan Mick <dmick@redhat.com>
2018-06-22 13:00:20 -05:00
Lenz Grimmer
c37c5dd43e
Merge pull request #22658 from joscollin/wip-doc-dashboard-numbers
doc: Fixed the wrong numbers in mgr/dashboard.rst

Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
2018-06-21 15:21:12 +02:00
John Spray
62f90da7db mgr: remove unused [get|set]_store_json fns
These were little used helpers, now totally unused!

Signed-off-by: John Spray <john.spray@redhat.com>
2018-06-21 14:13:36 +01:00
Jos Collin
8b2cfef596 doc: Fixed the wrong numbers in mgr/dashboard.rst
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-06-21 17:37:44 +05:30
John Spray
7ed8bc0e41
doc/dashboard: fix formatting on Grafana instructions
The whole list was in a code block, instead of just the snippets.

Signed-off-by: John Spray <john.spray@redhat.com>
2018-06-21 11:31:19 +01:00
Dan Mick
d9cabf2b04 doc/mgr/plugins.rst: explain more about the plugin command protocol
Signed-off-by: Dan Mick <dan.mick@redhat.com>
2018-06-19 16:45:06 -07:00
John Spray
c731f2a170 doc/mgr: note need for module.py file in plugins
This is kind of a kludgy thing but let's at least
document it!

Signed-off-by: John Spray <john.spray@redhat.com>
2018-06-19 10:19:06 +01:00
Patrick Nawracay
bd2196b6ca mgr/dashboard: Add token authentication to Grafana proxy
Enables token authentication for the Grafana proxy as additional option
to username/password authentication. The authentication method has to be
set, too.

    $ ceph dashboard set-grafana-api-token <token>	   # default: ''
    $ ceph dashboard set-grafana-api-auth-method <method>  # default: ''

Possible values for the authentication method are 'password' and
'token'.

Signed-off-by: Patrick Nawracay <pnawracay@suse.com>
2018-06-14 13:54:00 +02:00
Lenz Grimmer
7b3a7306b6
Merge pull request #21644 from p-na/grafana-proxy
mgr/dashboard: Grafana proxy backend

Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Ricardo Dias <rdias@suse.com>
Reviewed-by: Ricardo Marques <rimarques@suse.com>
Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Tatjana Dehler <tdehler@suse.com>
2018-06-06 12:17:31 +02:00
Patrick Nawracay
30b5d72d2d mgr/dashboard: Add Grafana proxy
Add the ability to connect the dashboard with a Grafana instance to
display graphs from Grafana incorporated into the dashboard.

Possible configuration options:

$ ceph dashboard set-grafana-api-host <host> # Default: 'localhost'
$ ceph dashboard set-grafana-api-port <port> # Default: 3000
$ ceph dashboard set-grafana-api-scheme <scheme> # Default: 'http'

The configuration can be checked using a GET request to the API endpoint
`/api/grafana/status`. It returns a JSON response in the following
format:

    {
	"available": False,
	"message": "<error message>",
    }

The message is not returned if Grafana is available.

The Grafana proxy is reachable through
`http(s)://<host>/api/grafana/proxy`.

Signed-off-by: Patrick Nawracay <pnawracay@suse.com>
2018-06-06 11:11:27 +02:00
Wido den Hollander
b7cc66e809
mgr/dashboard: Listen on port 7000 by default and not 8080
Port 8080 is a common alternative HTTP port used for web traffic.

The dashboard however uses SSL (which can not be turned off) and for
that purpose we should either use 8443.

Historically the dashboard would run on port 7000 so to keep this backwards
compatibility the dashboard should bind again on TCP 7000.

Signed-off-by: Wido den Hollander <wido@42on.com>
2018-06-05 16:55:45 +02:00
Kefu Chai
d96e20321f
Merge pull request #21864 from LenzGr/documentation-fixes
doc: fixed restful mgr module SSL configuration commands

Reveiwed-by: John Spray <john.spray@redhat.com>
2018-06-01 16:12:19 +08:00
Boris Ranto
7f468f4d51 doc/prometheus: Mention the long running avg types
Signed-off-by: Boris Ranto <branto@redhat.com>
2018-05-30 16:13:36 +02:00
John Spray
89f173c76a
Merge pull request #22157 from ceph/wip-doc-clear-config
doc/mgr: mention how to clear config setting

Reviewed-by: Patrick Nawracay <pnawracay@suse.com>
2018-05-29 15:00:21 +01:00
Enming Zhang
a157db0133 doc: fix a typo in doc/mgr/telegraf.rst
Signed-off-by: Enming Zhang <enming.zhang@umcloud.com>
2018-05-28 10:25:46 +08:00
John Spray
0ab068d0dd
doc/mgr: mention how to clear config setting
Signed-off-by: John Spray <john.spray@redhat.com>
2018-05-22 18:55:00 +01:00
Mohamad Gebai
1e2bf1ec8c doc: add documentation for iostat
Signed-off-by: Mohamad Gebai <mgebai@suse.com>
2018-05-21 23:47:09 -04:00
Sage Weil
7f04b17234
Merge pull request #21982 from tchaikov/mgr-brag
mgr/telemetry: Add Ceph Telemetry module to send reports back to project
2018-05-20 21:34:12 -05:00
Lenz Grimmer
32e0660556 doc: Updated dashboard documentation (features, SSL config)
Updated Ceph manager dashboard documentation: added SSL to the
feature overview, added new section about configuring SSL certificates.
Rearranged installation instructions for setting host name and port.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-05-17 17:34:36 +02:00
Sage Weil
5d8027ca70
Merge pull request #21937 from yanghonggang/balancer-list
mgr/balancer: add cmd to list all plans

Reviewed-by: Sage Weil <sage@redhat.com>
2018-05-16 16:05:49 -05:00
Lenz Grimmer
1f57ad8e18 doc/releases/mimic: Updated dashboard description
Fixed typo and slightly reworked the description of the mgr
dashboard in the "Major changes" section. Updated the
description in the "Notable changes" section as well by adding
a note about creating an SSL certificate.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-05-15 18:14:47 +02:00
Lenz Grimmer
5b77331a25 doc: fixed restful mgr module SSL configuration commands
Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-05-14 18:24:47 +02:00
Wido den Hollander
394b10049e mgr/telemetry: Add Ceph Telemetry module to send reports back to project
This Manager Module will send statistics and version information from
a Ceph cluster back to telemetry.ceph.com if the user has opted-in on sending
this information.

Additionally a user can tell that the information is allowed to be made
public which then allows other users to see this information.

Signed-off-by: Wido den Hollander <wido@42on.com>
(cherry picked from commit 8f6137d162)
2018-05-14 23:34:25 +08:00
Yang Honggang
99245c6982 mgr/balancer: add cmd to list all plans
Signed-off-by: Yang Honggang <yanghonggang@umcloud.com>
2018-05-12 13:26:13 +00:00
Wido den Hollander
d15d510bab
mgr/telegraf: Telegraf module for Ceph Mgr
Telegraf is a agent for collecting and reporting metrics.

It has multiple inputs and can send data to various outputs like
for example InfluxDB or ElasticSearch.

This module works by using the socket_listener of Telegraf and can
send data over UDP, TCP and a local Unix Socket.

Signed-off-by: Wido den Hollander <wido@42on.com>
2018-05-09 16:00:15 +02:00
Volker Theile
ad997b54c2 mgr/dashboard: Refactor RGW backend
- Do some polishing in the docs.
- Refactor RgwClient::is_service_online() method. The system is considered as online if the response structure is valid. The response content itself is not validated in this case.
- Relocate NoCredentialsException and derive it from RequestException.

Signed-off-by: Volker Theile <vtheile@suse.com>
2018-05-07 11:58:25 +02:00
John Spray
4f98ff5e06
Merge pull request #21557 from jan--f/mgr-prometheus-fix-metadata-labels
mgr: prometheus fix metadata labels

Reviewed-by: John Spray <john.spray@redhat.com>
2018-05-04 10:56:24 +01:00
Lenz Grimmer
acc94ded43 doc: Update dashboard feature list (RGW management)
Updated feature list in the dashboard documentation to also
mention the RGW user/bucket management capabilities.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-05-02 15:49:51 +02:00
John Spray
b869bfadd9
Merge pull request #21671 from jan--f/mgr-module-config-doc
doc/mgr/plugins: add note about distinction between config and kv store

Reviewed-by: John Spray <john.spray@redhat.com>
2018-04-30 12:42:18 +01:00
Lenz Grimmer
ef86ee1eb0 doc: Updated dashboard feature list.
Updated the dashboard documentation and added recently merged
RBD management features (flatten, clone, copy)

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-04-27 14:17:58 +02:00
Jan Fajerski
331a826a9f doc/mgr/prometheus: add instructions to correlate metrics
Add another option to correlate metrics from the node_exporter and Ceph
using label_replace.

Signed-off-by: Jan Fajerski <jfajerski@suse.com>
2018-04-26 17:22:42 +02:00
Jan Fajerski
9a888ea7ee doc/mgr/plugins: add note about distinction between config and kv store
Signed-off-by: Jan Fajerski <jfajerski@suse.com>
2018-04-26 12:01:59 +02:00
Yaarit Hatuka
b19e11a6c8 pybind/mgr: add 'hello world' mgr module skeleton
This simple 'hello' mgr module prints 'hello world' to stdout and to out/mgr.x.log; for documentation purposes. Also added /doc/mgr/hello.rst.

Signed-off-by: Yaarit Hatuka <yaarithatuka@gmail.com>
2018-04-25 10:37:09 -04:00
John Spray
8453c0edba doc: update config-key->config in mgr module docs
Signed-off-by: John Spray <john.spray@redhat.com>
2018-04-23 10:14:31 -04:00
John Spray
5414b73800 doc: update mgr plugin guide
...for recent config changes.  Explain about MgrModule.OPTIONS,
and explain the new store/config distinction.

Signed-off-by: John Spray <john.spray@redhat.com>
2018-04-23 10:14:31 -04:00
Lenz Grimmer
580852e229 doc: updated dashboard feature list (added new RGW details, Pools)
Updated the dashboard feature list in the documentation to mention
the possibility to list Ceph pools and the RGW users and their buckets.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-04-20 18:11:07 +02:00
Lenz Grimmer
3666365460 doc: updated the dashboard feature list
Updated and improved the Mgr Dashboard feature list: added RBD management
features.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-04-20 09:50:33 +02:00
Lenz Grimmer
e9706e60de doc: Improved dashboard documentation
Moved content (RGW access configuration) from the dashboard `README.rst`
into the reference manual. Made various textual improvements to both the
README and the documentation.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-04-16 15:46:24 +02:00