Commit Graph

152 Commits

Author SHA1 Message Date
Anthony D'Atri
0b9e3c2f53
Merge pull request #61197 from bebehei/fix-haproxy-dashboard-docs
doc/mgr/dashboard: Fix HAProxy TLS example
2024-12-30 10:05:10 -05:00
Benedikt Heine
cb43999432 doc/mgr/dashboard: Fix HAProxy TLS example
With `ssl` set on the `server` option, HAProxy strips the TLS protocol
for all clients. You would need to connect to it with `http://<ip>:443`.

To have an active health check, which uses SSL, but does not strip it
for clients, you'd need to add:

- `check` to enable active health checks.
- `check-ssl` to instruct the health check to use TLS
- `verify none` to skip verification on the health check requests from
  HAProxy
- _REMOVE_ `ssl` to stop stripping TLS

The active health checks are required to not route any requests to the
inactive managers. These would redirect to any unusable IP from the
active mgr.

---

Alternatively you could add another certificate in the frontend and then
re-encrypt the traffic. But this would require tracking the certs also
in HAProxy.

Signed-off-by: Benedikt Heine <bebe@bebehei.de>
2024-12-30 15:26:16 +01:00
Mindy Preston
e63b967aeb doc/mgr/dashboard: fix TLS typo
Change "SSL/TSL" to "SSL/TLS"

Signed-off-by: Mindy Preston <mcpreston@icecube.wisc.edu>
2024-06-05 15:25:59 -05:00
Zac Dover
6cf06c60f7 doc/mgr: edit "Overview" in dashboard.rst
Edit and update the "Overview" section in doc/mgr/dashboard.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-07 22:00:09 +10:00
Zac Dover
e0838daa9b doc/mgr: edit "Resolve IP address to hostname before redirect"
Edit the section "Resolve IP address to hostname before redirect" in
doc/mgr/dashboard.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-06 05:12:55 +10:00
Zac Dover
7854503076 doc/mgr: explain error message - dashboard.rst
Explain that an error message received in response to
"redirect_resolve_ip_addr True" might be caused by having an
insufficiently recent release of Ceph running in your cluster.

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

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-04-27 08:51:58 +10:00
gsantella
d64c52150c doc/mgr/dashboard: fix a typo
Signed-off-by: Guido Santella <gsantella@southhills.edu>
2023-06-17 09:49:15 -04:00
Pedro Gonzalez Gomez
21dc93ae11 mgr/dashboard: add button toggle to switch between new and old landing page
Signed-off-by: Pedro Gonzalez Gomez <pegonzal@redhat.com>
2023-03-15 22:21:23 +01:00
zdover23
9cfd351ab2
Merge pull request #44564 from zdover23/wip-doc-2022-01-13-44150-cleanup-grafana-data-source-name
doc/mgr: name data source in "Man Install & Config"

Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by:  Laura Flores <lflores@redhat.com>
2022-10-05 19:51:03 +10:00
Nizamudeen A
1acdb44108
Merge pull request #47265 from s0nea/wip-dashboard-redirect-fqdn
mgr/dashboard: add option to resolve ip addr

Reviewed-by: Pegonzal <NOT@FOUND>
Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2022-09-23 10:59:24 +05:30
Tatjana Dehler
2e15f0f0d2
mgr/dashboard: add option to resolve ip addr
Add the option `redirect_resolve_ip_addr` to the dashboard module.
If the option is set to `True`, try to resolve the IP address before
redirecting from the passive to the active mgr instance.
If the option is set to `False`, follow the already known behavior.

Fixes: https://tracker.ceph.com/issues/56699
Signed-off-by: Tatjana Dehler <tdehler@suse.com>
2022-09-07 11:18:55 +02:00
Zac Dover
d8064b4681 doc/mgr: add prompt directives to dashboard.rst
This commit adds prompt directives (.. prompt:: bash $) to
the commands in dashboard.rst.

There are several ".. include::" directives in the dashboard.rst
file, which means that part of this page is sourced from elsewhere
than the dashboard.rst file. Because I have not yet added prompt
directives to those files, there is an inconsistency in the rendering
of this file. Most of the commands on this page have unselectable
prompts (unselectable prompts are the prompts that don't get added to
the buffer when you copy them to one of the clipboards). But the
commands on this page that come from those ".. include::" directives
do not yet have unselectable prompts.

This file is over 1600 lines long. It was perhaps not optimally wise
of me to have edited all of it in one fell swoop. It took many hours,
and carefully checking it will probably take at least one hour. I
suggest that whoever reviews this should not spend much time on it,
but should instead make a quick pass over the page and make sure that
it looks passable.

The English syntax on this page (and throughout the Dashboard doc-
umentation) will be tightened to remove ambiguity and to improve
readability in the near future, so hold all English-language-related
comments for a future pull request.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-08-26 01:56:41 +10:00
Nizamudeen A
79bbaa5553 docs: fix doc link pointing to master in dashboard.rst
Signed-off-by: Nizamudeen A <nia@redhat.com>
2022-08-24 16:11:00 +05:30
Anthony D'Atri
cf1415a2b2
Merge pull request #46919 from jsoref/spelling-docs
doc: Fix many spelling errors
2022-07-03 19:54:55 -07:00
Josh Soref
8abce157f1 doc: Fix many spelling errors
* administrators
* allocated
* allowed
* approximate
* authenticate
* availability
* average
* behavior
* binaries
* bootstrap
* bootstrapping
* capacity
* cephadm
* clients
* combining
* command
* committed
* comparison
* compiled
* consequences
* continues
* convenience
* cookie
* crypto
* dashboard
* deduplication
* defaults
* delivered
* deployment
* describe
* directory
* documentation
* dynamic
* elimination
* entries
* expectancy
* explicit
* explicitly
* exporter
* github
* hard
* healthcheck
* heartbeat
* heavily
* http
* indices
* infrastructure
* inherit
* layout
* lexically
* likelihood
* logarithmic
* manually
* metadata
* minimization
* minimize
* object
* of
* operation
* opportunities
* overwrite
* prioritized
* recipe
* records
* requirements
* restructured
* running
* scalability
* second
* select
* significant
* specify
* subscription
* supported
* synonym
* throttle
* unpinning
* upgraded
* value
* version
* which
* with

Plus some line wrapping and additional edits...

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2022-07-02 23:38:18 -04:00
Aashish Sharma
4ac2a3e5f7 doc: update docs for centralized logging
Signed-off-by: Aashish Sharma <aasharma@redhat.com>
2022-06-28 16:22:24 +05:30
Nizamudeen A
27592b7561 cephadm: change shared_folder directory for prometheus and grafana
After https://github.com/ceph/ceph/pull/44059 the monitoring/prometheus
and monitoring/grafana/dashboards directories are changed to
monitoring/ceph-mixins. That broke the shared_folders in the cephadm
bootstrap script.

Changed all the instances of monitoring/prometheus and
monitoring/grafana/dashboards to monitoring/ceph-mixins

Also, renaming all the instances of prometheus_alerts.yaml to
prometheus_alerts.yml.

Fixes: https://tracker.ceph.com/issues/54176
Signed-off-by: Nizamudeen A <nia@redhat.com>
2022-02-07 16:34:37 +05:30
Zac Dover
987713da33 doc/mgr: name data source in "Man Install & Config"
This PR specifies that the data source must be set to
be "Dashboard1" when you configure Grafana and Prometheus
manually.

This is a fixup of another PR which was created by Dr
Jake Grimmett. This is that PR:

Credit goes to Dr Jake Grimmett of Cambridge.

https://github.com/ceph/ceph/pull/44150/

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-01-13 08:46:20 +10:00
Dimitri Papadopoulos
7677651618
doc,man: typos found by codespell
Signed-off-by: Dimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
2021-12-15 12:04:36 +01:00
Alfonso Martínez
58a6ab2147 mgr/dashboard: NFS exports: API + UI: integration with mgr/nfs; cleanups
mgr/dashboard: move NFS_GANESHA_SUPPORTED_FSALS to mgr_module.py

Importing from nfs module throws AttributeError because as a side effect the dashboard module is impersonating the nfs module.
https://gist.github.com/varshar16/61ac26426bbe5f5f562ebb14bcd0f548

mgr/dashboard: 'Create NFS export' form: list clusters from nfs module

mgr/dashboard: frontend+backend cleanups for NFS export

Removed all code and references related to daemons. UI cleanup and adopted unit-testing for
nfs-epxort create form for CEPHFS backend. Cleanup for export list/get/create/set/delete endpoints.

mgr/dashboard: rm set-ganesha ref + update docs

Remove existing set-ganesha-clusters-rados-pool-namespace references as
they are no longer required. Moreover, nfs doc in dashboard doc is
updated accordingly to the current nfs status.

mgr/dashboard: add nfs-export e2e test coverage

mgr/dashboard: 'Create NFS export' form: remove RGW user id field.

- Improve bucket typeahead behavior.
- Increase version for bucket list endpoint.
- Some refactoring.

mgr/dashboard: 'Create NFS export' form: allow RGW backend only when default realm is selected.

When RGW multisite is configured, the NFS module can only handle buckets in the default realm.

mgr/dashboard: 'Create service' form: fix NFS service creation.

After https://github.com/ceph/ceph/pull/42073, NFS pool and namespace are not customizable.

mgr/dashboard: 'Create NFS export' form: add bucket validation.

- Allow only existing buckets.
- Refactoring:
  - Moved bucket validator from bucket form to cd-validators.ts
  - Split bucket validator into 2: bucket name validator and bucket existence (that checks either existence or non-existence).

mgr/dashboard: 'Create NFS export' form: path validation refactor: allow only existing paths.

Fixes: https://tracker.ceph.com/issues/46493
Fixes: https://tracker.ceph.com/issues/51479
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
Signed-off-by: Avan Thakkar <athakkar@redhat.com>
Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2021-10-18 12:58:54 +02:00
cypherean
e90ebc195e mgr/dashboard: report ceph tracker bug/feature through CLI/API
Fixes: https://tracker.ceph.com/issues/44851

Signed-off-by: Shreya Sharma <shreyasharma.ss305@gmail.com>
2021-08-24 22:37:52 +05:30
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
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
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
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
Sage Weil
8976fcf476 doc: scrub 'ruleset' from docs
Signed-off-by: Sage Weil <sage@newdream.net>
2021-06-28 18:34:31 -04: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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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