Commit Graph

430 Commits

Author SHA1 Message Date
Rongqi Sun
29008b1d1a
Merge pull request #56379 from Svelar/doc_oE
doc/install: fix typos in openEuler-installation doc
2024-03-22 13:56:29 +08:00
Rongqi Sun
593ab1ad41 doc/install: fix typos in openEuler-installation doc
Signed-off-by: Rongqi Sun <sunrongqi@huawei.com>
2024-03-22 03:12:09 +00:00
Zac Dover
565bc95038 doc/install: add manual RADOSGW install procedure
Add a manual RADOSGW installation procedure to
doc/install/manual-deployment.rst. This procedure was developed by Janne
Johansson and reported to the ceph-users mailing list on 29 Jan 2024
here: https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/message/LB3YRIKAPOHXYCW7MKLVUJPYWYRQVARU/

Co-authored-by: Janne Johansson <icepic.dz@gmail.com>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-02 07:25:08 +10:00
Zac Dover
f5c87693ab doc/install: update "update submodules"
Remove misleading material that would give readers the wrong idea about
when stale submodules are present. This commit is made in response to
information given to me by Ilya Dryomov here: https://github.com/ceph/ceph/pull/54929#issuecomment-1859237986.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-12-19 19:15:57 +10:00
Daniel Clavijo Coca
ee2ee31d3f docs: Add information about OpenNebula integration
- Exclude doc build output from git
- Fix missing doc build dependency
- Also includes some involuntary automatically persistent linting by vscode

Co-authored-by: Ilya Dryomov <idryomov@redhat.com>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Co-authored-by: Zac Dover <zac.dover@proton.me>
Signed-off-by: Daniel Clavijo <dclavijo@opennebula.io>
2023-12-18 08:04:32 +10:00
Rishabh Dave
b1bf543127
Merge pull request #54210 from rishabh-d-dave/progress-submodule-update
add --progress flag to git submodule update commands

Reviewed-by: Xiubo Li <xiubli@redhat.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2023-11-01 10:59:59 +05:30
Rishabh Dave
eb6995436f cmake: add --progress flag to git submodule update commands
Ceph has lots of submodules that needs to be cloned before building
binaries from the repository. Seeing the progress when these submodules
are being cloned is useful, especially when developers/users have a
network issue or a slow network.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2023-10-31 23:14:49 +05:30
Zac Dover
7219897180 doc/install: simplify cephadm docs
Simplify the explanation of cephadm.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-10-29 21:47:04 +10:00
John Mulligan
c1a47f74ca doc: minor improvements of the cephadm section of the packages doc
* Don't call cephadm a script, it could be misleading
* Use the current release in the example for copy-pasters
* Improve grammar (I think)

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-08-14 14:23:05 -04:00
John Mulligan
336e8022b5 doc: do not recommend pulling cephadm from git
First off, these instructions are wrong because the file has been
renamed to cephadm.py, and will not succeed as written. Amusingly, due
to curl's default behavior (and my lack of access to a time machine) the
initial command will seem to have succeeded until the user discovers
that HTML delivered as part of the body of a 404 response is not an
executable script.

Furthermore, in preparation for Reef we updated the documentation in the
cephadm subsection to use the results of a build, rather than source
files, because reef now contains a "compiled" cephadm. Currently, the
contents of the compilation is essentially the same-old cephadm script
but that will no longer be the case in the very near future (see
7c6a2cad96405616719b85c740aabd98558c93ac). We missed this general
section of the Ceph docs that repeats the instructions to copy a raw
python file out of the Ceph tree on GitHub.  Update the section to
contain a simplified version of the instruction found in
doc/cephadm/install.rst.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-08-14 14:11:23 -04:00
liuqinfei
14c1f3ddd6 ceph.spec.in: add support for openEuler OS
The ceph main branch daily build on openEuler has been built.
https://github.com/openeuler-mirror/ceph-daily-build
The verification includes:
    - build ceph from source
    - run unit test
    - build RPM package

Signed-off-by: liuqinfei <lucas.liuqinfei@huawei.com>
2023-06-25 18:55:03 +08:00
luo rixin
6da360833a doc: remove leveldb support from doc
Signed-off-by: luo rixin <luorixin@huawei.com>
2023-05-04 10:43:08 +08:00
Conrad Hoffmann
402d2eacbc doc: account for PG autoscaling being the default
The current documentation tries really hard to convince people to set
both `osd_pool_default_pg_num` and `osd_pool_default_pgp_num` in their
configs, but at least the latter has undesirable side effects on any
Ceph version that has PG autoscaling enabled by default (at least quincy
and beyond).

Assume a cluster with defaults of `64` for `pg_num` and `pgp_num`.
Starting `radosgw` will fail as it tries to create various pools without
providing values for `pg_num` or `pgp_num`. This triggers the following
in `OSDMonitor::prepare_new_pool()`:

- `pg_num` is set to `1`, because autoscaling is enabled
- `pgp_num` is set to `osd pool default pgp_num`, which we set to `64`
- This is an invalid setup, so the pool creation fails

Likewise, `ceph osd pool create mypool` (without providing values for
`pg_num` or `pgp_num`) does not work.

Following this rationale:

- Not providing a default value for `pgp_num` will always do the right
  thing, unless you use advanced features, in which case you can be
  expected to set both values on pool creation
- Setting `osd_pool_default_pgp_num` in your config breaks pool creation
  for various cases

This commit:

- Removes `osd_pool_default_pgp_num` from all example configs
- Adds mentions of the autoscaling and how it interacts with the default
  values in various places

For each file that was touched, the following maintenance was also
performed:

- Change interternal spaces to underscores for config values
- Remove mentions of filestore or any of its settings
- Fix minor inconsistencies, like indentation etc.

There is also a ticket which I think is very relevant and fixed by this,
though it only captures part of the broader issue addressed here:

Fixes: https://tracker.ceph.com/issues/47176
Signed-off-by: Conrad Hoffmann <ch@bitfehler.net>
2023-03-23 22:15:25 +01:00
Zac Dover
82d748ff59 doc/install: update index.rst
Update index.rst by making minor grammar improvements. This file was
long overdue for a backport to Reef, Quincy, and Pacific, so this commit
was a good way to pass a human eyeball over the text before making those
backports.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-03-08 11:52:12 +10:00
Zac Dover
e7669539ac doc/install: refine index.rst
Refine English sentences in doc/install/index.rst. Remove adverbial
phrases of time that refer to Nautilus-era features as "new", since that
was four years ago.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-22 03:24:37 +10:00
Zac Dover
f04001deb3 doc/install: link to "cephadm installing ceph"
Link to "Installing Ceph" in the cephadm documentation instead of (as
was the case before this commit) to the cephadm overview page. Anyone
who clicks on the "cephadm" link in the context of the
doc/install/index.rst page is more likely to expect installation
instructions than to expect an explanation of what cephadm is.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-19 11:50:17 +10:00
Patrick Donnelly
f1c523ac4d
Merge PR #49016 into main
* refs/pull/49016/head:
	doc/dev: remove release notes for major release branch
	doc: hard-code latest release link
	doc: remove rtd main checkout

Reviewed-by: Ilya Dryomov <idryomov@redhat.com>
2022-12-20 13:19:17 -05:00
Zac Dover
344ef1553e doc/install: update clone-source.rst
Beef up clone-source.rst. Repair semantics. Add internal references. Fix
a broken "git submodule foreach git clean -fdx" command.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-11 07:24:09 +10:00
Patrick Donnelly
1b5b89c696
doc: hard-code latest release link
This commit does not exist in main. It will be forward ported once the
release branches appropriately redirect /en/$release/releases to
/en/latest/releases.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
(cherry picked from commit 01986dffbd8caf366e328f7ab4650cbb76663d3e)
2022-11-28 08:37:27 -05:00
Zac Dover
22088630fd doc/install: update "Official Releases" sources
Remove "Docker Hub" from the list of locations from which Ceph can be
acquired.

This commit represents a second attempt to get
https://github.com/ceph/ceph/pull/49034 past the Jenkins CI tests, and
that PR was itself an attempt to incorporate the change in
https://github.com/ceph/ceph/pull/44310, which could not be merged
because the commit message associated with that PR did not begin with
the string "doc", which meant that the "Signed-off-by" check failed.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-24 05:26:48 +10:00
Venky Shankar
2427c05614
Merge pull request #47874 from petrutlucian94/dokany_v2
dokan: switch to Dokany v2

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-10-27 18:18:36 +05:30
Zac Dover
e55c3b114b doc/dev: add submodule-update link to dev guide
This commit links to the procedure in install/clone-source.rst that
explains how to update submodules.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-13 03:30:42 +10:00
Zac Dover
9382a90342 doc/install: improve updating submodules procedure
This commit beefs up the "Updating Submodules" procedure,
which (prior to this commit) was quite brief.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-12 18:27:42 +10:00
Zac Dover
5c17509b0a doc/install: clone-source.rst s/master/main
s/master/main in doc/install/clone-source.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-06 14:30:07 +10:00
Lucian Petrut
6bf7a7ef31 doc/cephfs: update Dokany requirement
We've switched to Dokany v2, so we're updating the docs
accordingly.

Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2022-08-30 14:04:54 +00:00
Matthew Taylor
a0d82e2704 doc: Remove inactive Ceph mirrors.
hk.ceph.com - notified mirror maintainer list of mirror decommission on 2020-08-31
us-east.ceph.com - mirror has been offline for years.

Signed-off-by: Matthew Taylor <matthew.taylor@digitalpacific.com.au>
2022-08-19 09:47:26 +08: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
Laura Flores
f2b75166a2
Merge pull request #43388 from e337/wip-doc-50499 2022-02-18 18:24:02 -06:00
Kefu Chai
9b5a77eb1a
Merge pull request #44707 from liumiaomiaoIntel/qatdoc
doc/radosgw: update QAT acceleration to specify the configuration

Reviewed-by: Kefu Chai <tchaikov@gmail.com>
2022-01-29 14:13:41 +08:00
Miaomiao Liu
6a7f1f6c37 doc/radosgw: update QAT acceleration to specify the configuration
add and change the configuration steps to enable latest version of QAT
driver on QAT based encryption and compression

Signed-off-by: Miaomiao Liu <miaomiao.liu@intel.com>
2022-01-29 12:41:37 +08:00
Guillaume Abrioux
203406b87e
Merge pull request #44192 from liuqinfei/docfix
doc: typo fixes in ceph-volume and install
2022-01-25 16:05:40 +01:00
Sebastian Wagner
62558af5a3
Merge pull request #42115 from sandrobonazzola/patch-2
doc/install: ensure to open ceph-mon firewall ports

Reviewed-by: Sebastian Wagner <sewagner@redhat.com>
2022-01-10 15:41:32 +01:00
Anthony D'Atri
ff96092cf0 doc/install: Update quay.io URL for ceph-ci builds
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2021-12-23 15:04:52 -08: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
liuqinfei
a859a9f1ba doc: typo fixes
Signed-off-by: liuqinfei <18138800392@163.com>
2021-12-02 23:19:34 +08:00
Sandro Bonazzola
2bd9383934 doc/install: ensure to open ceph-mon firewall ports
doc/install: ensure to open ceph-mon firewall ports

Signed-off-by: Sandro Bonazzola <sbonazzo@redhat.com>
2021-10-19 11:37:58 +02:00
Eunice Lee
8a16d95ae8 doc: fix reference to non-existent stable branch
Fixes: #50499

Signed-off-by: Eunice Lee (eunice337@gmail.com)
2021-10-01 13:00:03 -07:00
Sage Weil
d1c744ee53 doc/install/containers: quay.io!
Signed-off-by: Sage Weil <sage@newdream.net>
2021-08-04 09:38:49 -05:00
Ilya Dryomov
c22e44895d
Merge pull request #40965 from rokj/patch-3
doc: mention copying keyrings and adjust node names in manual deployment example

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2021-07-29 23:54:44 +02:00
Rok Jaklič
bcad5d9822 doc: adding missing command. changed node naming.
Signed-off-by: Rok Jaklič <rokj@rasca.net>
2021-07-29 09:49:13 +02:00
Kefu Chai
3a41134592 doc/install/get-packages: do not mention additional 3rd party packages
since we are able to build and run on ubuntu focal without extra
dependencies of 3rd party packages, there is no need to mention them.
actually all of the removed packages are available in ubuntu focal.
some of them have different package names though.

the same applies to el8.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-07-01 16:38:56 +08:00
Kefu Chai
71e6adac35 doc/install/get-packages: s/el7/el8/
since we don't build for el7 anymore. replace all occurrences of el7 with
el8.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-07-01 16:38:56 +08:00
Sandro Bonazzola
136dbdef66 doc/install/get-packages: point to current stable release
Point to pacific for downloading the cephadm script

Co-authored-by: Kefu Chai <tchaikov@gmail.com>
Signed-off-by: Sandro Bonazzola <sbonazzo@redhat.com>
2021-06-22 20:48:06 +08:00
Abutalib Aghayev
413d344723 doc: Add a missing instruction to manual deployment guide.
Following the instructions as is results in the following error at step 15:

$ sudo -u ceph ceph-mon --mkfs -i node1 --monmap /tmp/monmap --keyring /tmp/ceph.mon.keyring
global_init: error reading config file.

Signed-off-by: Abutalib Aghayev <agayev@cs.cmu.edu>
2021-06-18 14:32:54 +08:00
Varsha Rao
dfc6a0e0e7 doc/install: replace do_cmake note with link to ceph README
Ceph README.md doc already has the do_cmake note and other build related info.

Signed-off-by: Varsha Rao <varao@redhat.com>
2021-03-26 12:20:00 +05:30
Varsha Rao
36e001b04e doc/install: Update about ninja
'ninja' replaced 'make' in this PR[1]. This patch updates the doc about it.

[1] https://github.com/ceph/ceph/pull/39826

Signed-off-by: Varsha Rao <varao@redhat.com>
2021-03-26 12:20:00 +05:30
Kefu Chai
bd0a87fb5c doc/install/windows-troubleshooting: fix typo
and tweak the format a little bit

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-25 01:03:34 +08:00
Lucian Petrut
8e4fe67100 doc: update Windows MSI link
Instead of having a direct download link, we'll point to the
download page, which will eventually contain other MSI versions as
well (e.g. Quincy).

While at it, we're simplifying the document a bit, dropping
information that's also included in the manual install guide.

Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2021-03-17 10:49:11 +00:00
Lucian Petrut
76a38a6b10 doc: reorganize Windows docs
Most of the Windows documentation is currently included in the
README.windows.rst file.

To make it more accessible, we're moving most of it to the
"doc/" folder, adding the following pages:

* Installing Ceph on Windows
* RBD on Windows
* Windows troubleshooting

We'll keep the build and manual install instructions in
README.windows.rst. Note that ceph-dokan already has a separate
doc page.

Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2021-03-15 15:15:32 +00:00
Sebastian Wagner
97338d7343 doc/install/index_manual: remove cephadm from toctree
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-03-04 18:18:33 +01:00