Commit Graph

40 Commits

Author SHA1 Message Date
Ricardo Marques
49ba4a7b84 mgr/dashboard: User password should be optional
Fixes: https://tracker.ceph.com/issues/36031

Signed-off-by: Ricardo Marques <rimarques@suse.com>
2018-09-19 13:49:22 +01:00
Lenz Grimmer
44be910c30 doc: Updated Mgr Dashboard documentation
Fixed a typo, added a note about the embedding of Grafana dashboards
still being WIP.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-09-11 15:43:46 +02:00
Lenz Grimmer
4c61c67fa5 doc: Updated Mgr Dashboard feature description, added references
Reworded the description of the user/role management feature, clarified
that it can be configured on both the CLI and the WebUI. Added labels for
referencing the user/role management and SSL configuration sections.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-09-11 14:12:04 +02:00
Patrick Nawracay
7340e70d7f mgr/dashboard/backend: API to manage dashboard settings
Enables to change (set/unset) values of settings of the dashboard using
the REST API.

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

Signed-off-by: Patrick Nawracay <pnawracay@suse.com>
2018-08-10 11:32:25 +02:00
Volker Theile
670522ee31 mgr/dashboard: RGW proxy can't handle self-signed certificates
Fixes tracker.ceph.com/issues/24677

Signed-off-by: Volker Theile <vtheile@suse.com>
2018-08-03 08:48:05 +02:00
Volker Theile
2312839198 mgr/dashboard: Set timeout in RestClient calls
Set a default timeout of 45 seconds to all REST client calls. This can be customized via 'ceph dashboard set-rest-requests-timeout <seconds>'. Currently the REST client is only used by the RGW controller.

Signed-off-by: Volker Theile <vtheile@suse.com>
2018-07-27 14:03:06 +02: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
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
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
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
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
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
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
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
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
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
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
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
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
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
Nathan Cutler
baf4ad63e6 doc: mgr/dashboard.rst: adjust TCP port wording
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-03-28 11:01:03 +02:00
Nathan Cutler
b775260f81 doc: mgr/dashboard.rst: mgr initial modules can take a list
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-03-27 21:43:25 +02:00
Nathan Cutler
83d4a3c53f doc: mgr/dashboard.rst: mention ceph.conf and ceph mgr services
Also break down the "Configuration" section into three separate sub-sections
for clarity.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-03-27 21:43:25 +02:00
Lenz Grimmer
fa01c871cf doc: Updated dashboard v2 feature list
Updated the dashboard v2 feature list and description in the manual,
added missing features.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-03-06 19:23:52 +01:00
Lenz Grimmer
482074c2a3
mgr/dashboard_v2: Updated reference documentation
Updated the dashboard chapter in the manual to reflect the
changes introduced by Dashboard v2 (e.g. username/password).

Updated description to include a high-level overview of the features
available.

Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-03-05 13:07:16 +00:00
John Spray
fa14812cbb doc: update mgr/dashboard doc about standbys
Signed-off-by: John Spray <john.spray@redhat.com>
2018-01-09 22:23:33 +00:00
Nick Erdmann
6d285fff0d pybind/mgr/dashboard: add url_prefix
This adds a configuration variable url_prefix to the dashboard that
that is prepended to all URLs so you can access the dashboard at
http://$IP:$PORT/$PREFIX/. This is necessary if you wish to use a
reverse http proxy that forwards to the dashboard under a sub-path.

Fixes: http://tracker.ceph.com/issues/20568
Signed-off-by: Nick Erdmann <n@nirf.de>
2017-08-22 16:14:42 +00:00
Sage Weil
4eb1a518e3 mon: 'config-key put' -> 'config-key set'
Signed-off-by: Sage Weil <sage@redhat.com>
2017-07-26 14:10:08 -04:00
Sage Weil
fa8514e22d doc/mgr/dashboard: update dashboard docs to reflect new defaults
Also add not about load balancer.

Signed-off-by: Sage Weil <sage@redhat.com>
2017-07-10 09:48:50 -04:00
Sage Weil
289f5ed093 doc: update docs for enabling mgr modules
Signed-off-by: Sage Weil <sage@redhat.com>
2017-06-29 23:10:51 -04:00
Wido den Hollander
0f15e4e76b
doc: Mgr Dashboard docs update
More instructions on how to deploy the dashboard using ceph-mgr

Signed-off-by: Wido den Hollander <wido@42on.com>
2017-06-27 15:42:41 +02:00
Kefu Chai
774a856ec2 doc: document the setup of restful and dashboard plugins
Fixes: http://tracker.ceph.com/issues/20239
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-06-15 19:13:30 +08:00