Commit Graph

476 Commits

Author SHA1 Message Date
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