Commit Graph

111 Commits

Author SHA1 Message Date
Aaron Lauterer
0c2dcfce35 pveceph: destroy osd: rework to make it easier to read
* rephrased some parts
* split large paragraphs
* put CLI commands into own code blocks instead of being inline
* added step to wait until rebalance after OUT is finished

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 17:34:58 +01:00
Aaron Lauterer
c49d3f328c pveceph: annotate code blocks as bash
to have them set to the same highlighting scheme throughout the chapter

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 17:10:24 +01:00
Aaron Lauterer
41292dab6e pveceph: troubleshooting maintenance: rework to have CLI commands in blocks
having CLI commands in their own blocks instead of inline makes them
stand out quickly and a lot easier to copy & paste.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 17:10:02 +01:00
Alexander Zeidler
0a52307436 ceph: maintenance: revise and expand section "Replace OSDs"
Remove redundant information that is already described in section
“Destroy OSDs” and link to it.

Mention and link to the troubleshooting section, as replacing the OSD
may not fix the underyling problem.

Mention that the replacement disk should be of the same type and size
and comply with the recommendations.

Mention how to acknowledge warnings of crashed OSDs.

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2025-03-24 16:06:22 +01:00
Alexander Zeidler
84ba04863c ceph: osd: revise and expand the section "Destroy OSDs"
Existing information is slightly modified and retained.

Add information:
* Mention and link to the sections "Troubleshooting" and "Replace OSDs"
* CLI commands (pveceph) must be executed on the affected node
* Check in advance the "Used (%)" of OSDs to avoid blocked I/O
* Check and wait until the OSD can be stopped safely
* Use `pveceph stop` instead of `systemctl stop ceph-osd@<ID>.service`
* Explain cleanup option a bit more

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2025-03-24 16:06:22 +01:00
Alexander Zeidler
70b3fb96e1 ceph: troubleshooting: revise and add frequently needed information
Existing information is slightly modified and retained.

Add information:
* List which logs are usually helpful for troubleshooting
* Explain how to acknowledge listed Ceph crashes and view details
* List common causes of Ceph problems and link to recommendations for a
  healthy cluster
* Briefly describe the common problem "OSDs down/crashed"

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
[AL]: use old anchor to sub chapter that was kept to not break links
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 16:06:22 +01:00
Alexander Zeidler
402893065f ceph: correct heading capitalization
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2025-03-24 16:06:22 +01:00
Alexander Zeidler
dc1e865824 ceph: add anchors for use in troubleshooting section
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
[AL]: revert and fix subchapter anchor to autogenerated one to not break links
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2025-03-24 16:05:55 +01:00
Friedrich Weber
39dff49d81 ceph: fix two broken lists
The two lists were missing the initial empty line and were
consequently rendered as inline text, which made them hard to read.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
2024-11-19 12:03:40 +01:00
Thomas Lamprecht
c2ac9c8470 ceph: update some dead links
Having a optional linkchecker build-target might be nice to catch all
those broken links for sure when run every once in a while.

Reported-by: Melroy van den Berg <melroy89@protonmail.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-14 14:56:46 +01:00
Maximiliano Sandoval
6942acb508 fix some typos
found with:

    typos *.adoc

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2024-10-14 10:21:29 +02:00
Aaron Lauterer
ff3aca1073 ceph server: document full cluster shutdown
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
Reviewed-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-06-20 09:46:43 +02:00
Thomas Lamprecht
e2b3622a89 consistently use web UI and web interface wording
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-22 08:49:28 +01:00
Aaron Lauterer
d4ee0a1992 pvecm: expand on public/cluster networks
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2023-11-20 16:59:34 +01:00
Aaron Lauterer
4df8e368fa pveceph: fix typo
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2023-11-20 16:59:34 +01:00
Noel Ullreich
ff4ae05288 Fix spelling of command line/command-line
Commandline/command line/command-line where being used interchangeably,
which is not correct
(see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line).
use command-line when it is an adjective (e.g. "command-line interface")
and use command line when it is a noun (e.g. "change the setting from
the command line")

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-11-17 10:54:24 +01:00
Thomas Lamprecht
7367ba5beb ceph: add more details for private/public network usage and distinction
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-12 19:06:44 +01:00
Thomas Lamprecht
3885be3bd0 ceph: rework introduction and recommendation section
Add more headings, update some recommendations to current HW (e.g.,
network and NVMe attached SSD) capabilities and expand recommendations
taking current upstream documentation into account.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-12 18:59:30 +01:00
Matthias Heiserer
f226da0ef4 consistently capitalize Ceph
Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-11-09 15:39:58 +01:00
Aaron Lauterer
42135e5844 ceph ec: fix typos and reword some sections
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-06-28 15:57:00 +02:00
Thomas Lamprecht
81de7382b0 pveceph: fix typo
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-05-09 09:52:06 +02:00
Thomas Lamprecht
41791cf85d ceph: rework EC structure and unify example style
add separate create/add headings below introduction about EC and
streamline a few details like not using spaces in example
<param-name>

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-05-04 07:54:15 +02:00
Thomas Lamprecht
e9d331c5d8 ceph: ec: fix quoting of params and special values
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-05-04 07:32:57 +02:00
Aaron Lauterer
1273007159 pveceph: ec pool: add note about parameter usage on creation
Some optional parameters will only be used for the replicated metadata
pool.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-05-04 07:16:06 +02:00
Aaron Lauterer
cbb265a3d0 pveceph: add section about erasure code pools
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-04-29 14:29:41 +02:00
Thomas Lamprecht
54f20853fe pveceph: typo/language followups
Reported-by: Aaron Lauterer <a.lauterer@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-11-11 16:24:35 +01:00
Dominik Csapak
b631c35ee4 pveceph: improve documentation for destroying cephfs
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-11-11 16:21:40 +01:00
Dominik Csapak
f8bfcb41cd pveceph: update pgcalc url
currently the pgcalc tool is only available via waybackmachine of archive.org

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-08-25 18:33:13 +02:00
Oguz Bektas
3a433e9bb0 SPAM: [PATCH v2 docs] fix typos in various adoc files
checked for common misspellings. some of the changes (like favourite vs.
favorite or virtualization vs. virtualisation) are because of US vs. UK english

Reviewed-by: Dylan Whyte <d.whyte@proxmox.com>
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2021-04-29 13:26:28 +02:00
Thomas Lamprecht
94d7a98c23 ceph: update and add screenshots
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-04-26 19:07:30 +02:00
Thomas Lamprecht
513e2f5752 ceph: improve structure and existing screenshot placements
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-04-26 19:07:02 +02:00
Dylan Whyte
40e6c80663 ceph: section language fixup
Mostly fixes minor issues and makes it more in line with our writing
guide. Some sections were reworded for better readability.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-04-26 17:49:42 +02:00
Thomas Lamprecht
d56606c72a ceph: pools: reword, drop PG scale hint, autoscaler makes it obsolete
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-04-21 14:11:58 +02:00
Thomas Lamprecht
e79e0b9dbb ceph: osd: reword
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-04-21 14:11:29 +02:00
Thomas Lamprecht
6004d86bd4 ceph: followup: we use title-case
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-04-21 14:11:06 +02:00
Dominik Csapak
a0d289fff9 pveceph: order the fields according to gui
In the gui the order is different, so adpat the order here.
While we are at it fix the typo: s/Traget/Target/

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-04-21 13:58:07 +02:00
Dominik Csapak
5b9f923f1b pveceph: also mention editing of pools
We can now edit them as well so write that.
Also mention that the 'add as storage' checkbox is only visible when
creating a pool.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-04-21 13:58:07 +02:00
Dylan Whyte
47d62c847c ceph: add explanation on the pg autoscaler
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
Originally-by: Alwin Antreich <a.antreich@proxmox.com>
Edited-by: Dylan Whyte <d.whyte@proxmox.com>
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-25 19:26:17 +01:00
Dylan Whyte
c446b6bbc7 docs: ceph: explain pool options
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
Originally-by: Alwin Antreich <a.antreich@proxmox.com>
Edited-by: Dylan Whyte <d.whyte@proxmox.com>
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-25 19:25:15 +01:00
Thomas Lamprecht
b07ed53ea0 pveceph: fix typo
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-23 12:52:16 +01:00
Alwin Antreich
ef3efe511b ceph: add warning for min_size 1
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2020-10-30 15:35:05 +01:00
Alwin Antreich
b46a49edb1 update links to the ceph docs
* use a variable instead of hardcoded url+release name
* ceph migrated to readthedocs with a minor uri change
https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/AQZJG75IST7HFDW7OB5MNCITQOVAAUR4/

Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2020-10-14 12:28:23 +02:00
Alwin Antreich
d241b01b42 move footnote of Ceph's intro into TIP section
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2020-10-14 12:28:23 +02:00
Dominic Jäger
fc59c6d3d4 pveceph: Reducing number of PGs is possible
From Ceph Nautilus onwards reducing the number of placement groups is possible.

Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
2020-03-03 10:51:20 +01:00
Alwin Antreich
5b502340ad pveceph: reword memory precondition
and add the memory target for OSDs, included since Luminous. As well as
distinguish the memory usage between the OSD backends.

Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2020-02-19 15:54:56 +01:00
Thomas Lamprecht
5f318cc038 fix some typos
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-02-11 18:01:34 +01:00
Thomas Lamprecht
4bfe3e35cc followup: still have hyper-conv. in heading for ceph
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-01-28 18:19:47 +01:00
Tim Marx
4360c00f30 ceph: move ceph docs to own top level chapter
This change should help to make the meanwhile extensive documentation
about ceph more visible, therefore ceph now has it's own chapter which
is sorted more reasonable after the storage chapter. The formerly known
"hyper converged infrastructure" chapter is now integrated in the intro
chapter, as it only contains some general information about this topic,
which is not specific for ceph.

Signed-off-by: Tim Marx <t.marx@proxmox.com>
2020-01-28 18:19:47 +01:00
Alwin Antreich
c78cd2b6ee pveceph: fix spelling in section Trim/Discard
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2019-11-07 14:01:47 +01:00
Alwin Antreich
55d634e651 Fix: pveceph: broken ref anchor pveceph_mgr_create
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2019-11-07 13:37:07 +01:00