Commit Graph

626 Commits

Author SHA1 Message Date
Laura Flores
24dcb42d41
Merge pull request #55067 from yaarith/telemetry-pool-flags
mgr/telemetry: add pool flags
2024-01-23 12:22:32 -06:00
Yaarit Hatuka
937aa7ec21 mgr/telemetry: add pool flags
Pool flags can help us learn how certain features are being used, for
example, the "crimson" flag implies a crimson cluster.

We add a basic_pool_flags collection to the "basic" channel for this
purpose.

Signed-off-by: Yaarit Hatuka <yaarit@redhat.com>
2024-01-05 17:44:30 +00:00
Zac Dover
03656c02a7 doc/mgr: document lack of MSWin NFS 4.x support
Document that no version of Microsoft Windows supports mounting an NFS
v4.x export natively, as of the time of this commit.

This commit has been made in response to an anonymous note left on
https://pad.ceph.com/p/Report_Documentation_Bugs.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-01-01 10:10:42 +10:00
Ville Ojamo
4f9bd62f37
doc/mgr/ceph_api: Promptify example commands in index.rst
Use the more modern prompt block instead of
using code blocks for example commands.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-07-28 11:49:19 +07:00
Ville Ojamo
37ea3e50f0
doc/mgr/rgw.rst: add missing "ceph" command in cli specification
The line begins with a prompt so I would
expect it to be a "complete" command,
including the `ceph` binary to run with all
the various listed arguments.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-07-17 20:05:39 +07:00
Ville Ojamo
33b8fdb203
doc/mgr/rgw.rst: multisite typed wrong
Multisite is typed wrong as mutlisite so fix the spelling.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
2023-07-17 10:35:46 +07:00
Paul Cuzner
43b5f4b4f9 docs: fix nfs cluster create syntax
The ceph prefix was missing from the command
example.

Signed-off-by: Paul Cuzner <pcuzner@ibm.com>
2023-07-13 15:13:42 +12: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
John Mulligan
92ce0ae600 doc/cephadm: document haproxy protocol options
There are now two ways to run NFS with ingress using haxproxy. This
makes three distinct modes for ingress. Document these.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-05-26 10:43:11 -04:00
Zac Dover
4935ad8aed doc/mgr: edit "leaderboard" in telemetry.rst
Standardize the presentation of commands in the "Leaderboard" section of
doc/mgr/telemetry.rst.

Follow-up to https://github.com/ceph/ceph/pull/50977

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-05-23 06:11:39 +10:00
Adam King
9f3d21e020
Merge pull request #47199 from adk3798/osp-nfs-ha
mgr/cephadm: support for nfs backed by VIP

Reviewed-by: John Mulligan <jmulligan@redhat.com>
Reviewed-by: Redouane Kachach <rkachach@redhat.com>
2023-05-03 17:18:27 -04:00
Adam King
5de3312dec doc/cephadm: document keepalive only nfs
Signed-off-by: Adam King <adking@redhat.com>
2023-05-01 15:45:11 -04:00
Zac Dover
5a90d64b34 doc/mgr: update prompts in prometheus.rst
Update prompts in prometheus.rst so that they're unselectable.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-04-28 08:10:29 +10:00
Piotr Parczewski
b9b75dafe2
doc/mgr/prometheus: fix confval reference
Signed-off-by: Piotr Parczewski <piotr@stackhpc.com>
2023-04-15 23:16:35 +02:00
yaarith
e0a6d6aa70
Merge pull request #50699 from yaarith/telemetry-leaderboard-doc
mgr/telemetry: add leaderboard description and documentation

Reviewed-by: Zac Dover <zac.dover@proton.me>
Reviewed-by: Laura Flores <lflores@redhat.com>
Reviewed-by: Nizamudeen A <nia@redhat.com>
2023-04-10 13:55:36 -04:00
Avan Thakkar
5a058b8fb3 mgr/prometheus: introduce fetch_perf_counters_metrics module option
Fixes: https://tracker.ceph.com/issues/58164
Signed-off-by: Avan Thakkar <athakkar@redhat.com>

Introducing module option in prometheus module to enable/disable support for exporting ceph daemons
perf counters as prometheus metrics, by default this option will be disabled. The use case for this option
is in case if ceph-exporter deployment failed for any reason then user still can have option to fetch metrics
from promethues exporter.
2023-04-04 23:12:29 +05:30
Yaarit Hatuka
d51947fe8a mgr/telemetry: add leaderboard description and documentation
Users who are opted-in to telemetry can also opt-in to participating in
a leaderboard in the telemetry public dashboards
(https://telemetry-public.ceph.com/).

Users can also add a description of the cluster to publicly appear in
the leaderboard.

Signed-off-by: Yaarit Hatuka <yaarit@redhat.com>
2023-03-27 22:51:51 +00: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
Pere Diaz Bou
8e07fbd2ea
Merge pull request #48843 from rhcs-dashboard/expose_slow_ops
mgr/prometheus: expose daemon health metrics

Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
Reviewed-by: Avan Thakkar <athakkar@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Nizamudeen A <nia@redhat.com>
2022-12-20 12:25:32 +01:00
Pere Diaz Bou
5a2b7c25b6 mgr/prometheus: expose daemon health metrics
Until now daemon health metrics were stored without being used. One of
the most helpful metrics there is SLOW_OPS with respect to OSDs and MONs
which this commit tries to expose to bring fine grained metrics to find
troublesome OSDs instead of having a lone healthcheck of slow ops in the
whole cluster.

Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-12-20 09:44:49 +01:00
yaarith
3a8f2dcc51
Merge pull request #48214 from ljflores/wip-telemetry-bluestore-compression-mode
mgr/telemetry: add `basic_pool_options_bluestore` collection

Reviewed-by: Yaarit Hatuka <yaarit@redhat.com>
2022-12-13 14:34:45 -05:00
Adam King
08718ae283
Merge pull request #47708 from rkachach/fix_issue_57160
mgr/rgw: adding support for rgw multisite

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Ali Maredia <amaredia@redhat.com>
2022-12-07 10:43:44 -05:00
Redouane Kachach
dcde3df939
Addressing comments from the last review
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-10-19 10:42:20 +02:00
Redouane Kachach
5b6e99de1e
Removing docs for unused commands + fixing style issues
Adding logic to modify the master zonegroup endpoints
Do no call pull realm when modifying zone
Only update the endpoints if the modified zone is master
Adding support to set custom endpoints when creating realm or zone

Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-10-13 18:17:59 +02:00
Redouane Kachach
83b0ef406d
Addressing some of Ali comments
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-10-11 12:06:21 +02:00
Redouane Kachach
b94c2b685a
Addressing adking review comments
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-10-11 10:10:16 +02:00
Redouane Kachach
7fdb145f1a
Addressing review comments
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-10-06 11:08:14 +02:00
John Mulligan
764ccf998b doc/mgr/nfs: document --sectype option for export create commands
Add documentation for the option to specify the sectype (for enabling kerberos)
when creating a new export.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-10-05 10:25:06 -04: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
Laura Flores
b0650129e0 mgr/telemetry: add basic_pool_options_bluestore collection
Collects per-pool bluestore options, such as `bluestore_compression_mode`.

Signed-off-by: Laura Flores <lflores@redhat.com>
2022-10-04 18:15:22 +00:00
Redouane Kachach
d15a5dcfe2
mgr/rgw: Adding rgw multisite support
Fixes: https://tracker.ceph.com/issues/57160

Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-09-28 11:08:42 +02: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
Adam King
812be8465f
Merge pull request #47763 from phlogistonjohn/jjm-object-format-fixes
pybind/mgr: object_format.py decorator updates & docs

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
Reviewed-by: Redouane Kachach <rkachach@redhat.com>
2022-09-01 13:54:13 -04:00
Yuri Weinstein
4b0182efda
Merge pull request #47184 from ljflores/wip-telemetry-memory-stats
mgr/telemetry: add `perf_memory_metrics` collection to telemetry

Reviewed-by: Yaarit Hatuka <yaarithatuka@gmail.com>
Reviewed-by: Kamoltat (Junior) Sirivadhna <ksirivad@redhat.com>
2022-09-01 08:29:25 -07:00
Zac Dover
fc70ccde75 doc/mgr: update prompts in dboard.rst includes
This PR adds unselectable prompts to three files that are
transcluded in the doc/mgr/dashboard.rst file. These three
files are:

 1. debug.inc.rst
 2. feature_toggles.inc.rst
 3. motd.inc.rst

The addition of unselectable prompts to these three files
completes the work begun in PR#47810 (d8064b4), which sought
to bring dashboard.rst into line with the unselectable prompt
standard introduced by Kefu Chai in 2020.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-08-29 10:39:51 +10: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
Laura Flores
138eb5db67 doc/mgr: add perf_memory_metrics to the telemetry documentation
Signed-off-by: Laura Flores <lflores@redhat.com>
2022-08-24 22:07:14 +00: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
Zac Dover
2172b7ec98 doc/mgr: edit orchestrator.rst
This PR improves the English language in the "Orchestrator CLI"
section of the MGR documentation. It adds a couple of section
headers in order to signpost the information in the document
a bit more than had already been done, but it makes no major
structural changes to the presentation of the information here.

This PR was motivated by feedback from the 2022 Ceph User Survey
in which one of the respondents wrote "better ceph orch documen-
tation".

The final section on this page, "Current Implementation Status",
must be verified by someone who is familiar with the current state
of "ceph orch" and a date stamp should be applied to the top of
the section so that the word "current" has a meaningful referent.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-08-24 13:21:25 +10:00
John Mulligan
2a2d044247 doc/mgr: add a tutorial-esque section on object_format python module
It doesn't cover everything but should get most use cases started.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-08-23 13:01:45 -04:00
John Mulligan
30d3e5bab5 doc/mgr: fix quoting error in python example
Found by vim syntax highlighting. Thanks vim!

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-08-23 13:01:45 -04:00
John Mulligan
481776becf doc/mgr: use subsections for two approaches to exposing commands
This makes the content for each approach clearer and prepares
for a future sub-section.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-08-23 13:01:45 -04:00
Anthony D'Atri
f1235a8ee0 doc/mgr: Fix capitalization in orchestrator.rst
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-07-05 19:23:36 -07:00
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
Anthony D'Atri
fe2200527e
Merge pull request #46087 from rhcs-dashboard/update-centralized-logging-docs
doc: update docs for centralized logging
2022-07-03 16:32:59 -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
Redouane Kachach
df1aaacb7d
doc/cephadm: enhancing daemon operations documentation
Fixes: https://tracker.ceph.com/issues/54399

Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-06-20 11:44:49 +02:00
Konstantin Shalygin
4512270736 doc/mgr: Document wildcard to expose Prometheus metrics for all RBD pools and namespaces
Fixes: https://tracker.ceph.com/issues/47537

Signed-off-by: Konstantin Shalygin <k0ste@k0ste.ru>
2022-06-02 14:23:38 +07:00