Commit Graph

75 Commits

Author SHA1 Message Date
Piotr Parczewski
4cc3cb9cd0
doc/cephadm: grammar / syntax in install.rst
Signed-off-by: Piotr Parczewski <piotr@stackhpc.com>
2023-01-31 09:30:07 +01:00
krambrod
930fa9150c
doc/cephadm: fix initial-ceph.conf example
Signed-off-by: krambrod <114069812+krambrod@users.noreply.github.com>
2022-12-05 09:36:10 +01:00
Zac Dover
e349645ee8 doc/cephadm: improve airgapping procedure grammar
Improve the grammar of the airgapping procedure.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-01 10:05:10 +10:00
Zac Dover
60aa262f2d doc/cephadm: format airgap install procedure
Format the procedure that explains how to install an airgapped cluster.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-30 14:31:17 +10:00
Zac Dover
292894dc92 doc/cephadm: add airgapped install procedure
Add a procedure describing an installation with an airgapped registry.

This commit ingests work done in https://github.com/ceph/ceph/pull/44346
that was abandoned for lo these past eleven months. The PR connected
with this commit supersedes that PR.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-30 13:56:52 +10:00
Zac Dover
5c217c1de5 doc/cephadm: s/ssh/SSH/ in doc/cephadm (complete)
This PR alters "ssh" to "SSH" in the text (that is, not in
commands) every location in the doc/cephadm/ directory where
"ssh" should be "SSH".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-25 09:09:11 +10:00
Zac Dover
c8f01d3a32 doc/cephadm: update install.rst
This commit addresses https://github.com/ceph/ceph/pull/43250,
which has remained unmerged for thirteen months. The issues
raised in that PR are addressed here.

This commit contributes to the simplification of the procedure
that explains how to install cephadm. More remains to be done
on this page, but the old PR had to be dealt with first.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-23 12:03:59 +10:00
Guillaume Abrioux
d43189c17b doc/cephadm: fix a typo
s/osd_crush_choose_leaf_type/osd_crush_chooseleaf_type

```
[ceph: root@adm-1 /]# ceph config set global osd_crush_choose_leaf_type 0
Error EINVAL: unrecognized config option 'osd_crush_choose_leaf_type'
[ceph: root@adm-1 /]# ceph config set global osd_crush_chooseleaf_type 0
[ceph: root@adm-1 /]#
```

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
2022-03-30 23:49:01 +02:00
Patrick C. F. Ernzer
7f243262f9 doc/cephadm: Add CentOS Stream install instructions
Signed-off-by: Patrick C. F. Ernzer <pcfe@pcfe.net>.
2022-02-15 17:28:07 +01:00
Melissa Li
2222f26a37 doc/cephadm: remove duplicate deployment scenario section
Signed-off-by: Melissa Li <melissali@redhat.com>
2022-01-18 16:53:04 -05:00
Melissa Li
0fad0fde9c doc/cephadm: warn about default enabling osd_memory_target_autotune
Fixes: https://tracker.ceph.com/issues/51562
Signed-off-by: Melissa Li <melissali@redhat.com>
2022-01-05 16:06:07 -05:00
Daniel Pivonka
2c29286b37 mgr/cephadm: store contianer registry credentials in config-key
Signed-off-by: Daniel Pivonka <dpivonka@redhat.com>
2021-12-01 12:30:00 -05:00
Sebastian Wagner
d93e8beab3
Merge pull request #43943 from sebastian-philipp/osd-memeory-hyperconverged
doc/cephadm: OSD memory autotuning for hyperconverged

Reviewed-by: Adam King <adking@redhat.com>
2021-11-25 17:27:26 +01:00
Melissa
e6e0344981
doc/cephadm: deployment scenarios single host and isolated environment
This PR adds a deployment scenarios section to the cephadm docs to document the single-host-defaults flag, and explain how to deploy in an isolated environment.

Signed-off-by: Melissa Li <melissali@redhat.com>
2021-11-24 15:02:37 +01:00
Melissa
a311e837d6
doc/cephadm: isolated environment and other deployment scenarios
This PR adds a section to the cephadm docs to describe how to install cephadm in different deployment scenarios (set cluster on single host, and deployment in an isolated environment or private network). 

Signed-off-by: Melissa Li <melissali@redhat.com>
2021-11-24 15:02:34 +01:00
Sebastian Wagner
08fdb42082
doc/cephadm: OSD memory autotuning for hyperconverged
Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-11-16 12:52:20 +01:00
Sebastian Wagner
41a487005c
doc/cephadm: Recommend osd_memory_target_autotune
In case the cluster runs on hardware that is used exclusively for
Ceph, let's recommend `osd_memory_target_autotune`

Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-11-05 10:53:14 +01:00
Zac Dover
d5f6d8ef33 doc/cephadm: update typo in install.rst
This PR changes the string

   use "--log-to-file" option during bootstrap

to

   use the "--log-to-file" option during bootstrap

The way that it was written makes it sound like it was
written by a native Russian speaker. But it was written
by me, a native English speaker, so this is on me.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-10-21 00:42:02 +10:00
Sage Weil
7500b821ae cephadm: add bootstrap --log-to-file option
Signed-off-by: Sage Weil <sage@newdream.net>
2021-07-07 12:14:36 -04:00
Zac Dover
1036edd69a doc/cephadm: removing "Octopus" from procedure
This PR removes "Octopus" from the curl-based installation
procedure.

After we moved on to Pacific, referring to Octopus looks wrong.
It looks wrong because it now is wrong.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-06-17 00:34:10 +10:00
zdover23
462c121653
Merge pull request #40502 from zdover23/wip-doc-podman-version-octopus-note-2021-30-Mar
doc/cephadm: add podman version note to install

Reviewed-by: Sebastian Wagner <sewagner@redhat.com>
2021-04-30 05:53:58 +10:00
Zac Dover
3043aaaa8a doc/cephadm: add podman version note to install
This PR adds a note to the cephadm installation
guide that informs users that only podman version
2.0.0 and higher work with Ceph, with the
exception of podman version 2.2.1, which does
not work with Ceph. There is also a note regarding
kubic stable 3.0.1 working, but only with newer
kernels.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-04-29 00:08:18 +10:00
Sage Weil
b6b85edfe5 doc/cephadm: document the default 'admin' label
Signed-off-by: Sage Weil <sage@newdream.net>
2021-04-27 09:45:54 -04:00
Sage Weil
b7e4f60178 mgr/cephadm: 'ceph orch client-keyring ...' commands to manage keyring files
Teach cephadm to manage keyring files on cluster hosts.  These keys must
already exist in the mon auth database--cephadm does not create them if
they don't exist (and will issue warnings to the log if they do not).

A ceph.conf is pushed implicitly along with the keyring file.

Each keyring added will be pushed to the hosts described by the placement
spec with the appropriate ownership and mode.  If the ownership, mode, or
path are modified, the files are rewritten or removed as need.

If the client-keyring entry is removed, the keyring files are removed.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-04-27 09:45:54 -04:00
Daniel Pivonka
b28fd9838e doc/cephadm: explicitly show host requirments in adding host section
Signed-off-by: Daniel Pivonka <dpivonka@redhat.com>
2021-03-23 14:56:33 -04:00
Jeff Layton
bf69cdc689 doc: fixes for cephadm documentation
Be sure to note that python 3 is a prerequisite. Minimal centos 8
installs don't have it, for instance.

Also, we probably don't want to hardcode an octopus URL into the
suggested curl command. Change it to fill that in with
"|stable-release|", which should always point to the latest released
version name.

Fixes: https://tracker.ceph.com/issues/49806
Signed-off-by: Jeff Layton <jlayton@redhat.com>
2021-03-17 20:58:56 +08:00
Josh
ffc08b930b doc/cephadm: use 'apt' to install cephadm on Ubuntu
Adjusted so Ubuntu command uses 'apt' and added Fedora since that uses 'dnf'.
2021-03-07 19:16:21 +08:00
Sebastian Wagner
8287a34aea
Merge pull request #39744 from zdover23/wip-doc-cephadm-install-install-cephadm-rewrite-2021-Feb-28
doc/cephadm: rewrite "install cephadm"

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-03-02 12:05:30 +01:00
Zac Dover
1b626b9895 doc/cephadm: rewrite "install cephadm"
This PR breaks the "Deploying a New Ceph Cluster"
section into several sub-sections, so that each sub-section
pertains to only one subject. I've also added some explanatory
text that puts the instructions into context more than they were
before.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-03-02 05:06:00 +10:00
Zac Dover
2ec313caba doc/cephadm: rewrite "b.strap a new cluster"
This PR rewrites the section "Bootstrap A New
Cluster" in the Cephadm Guide, in the Install
Chapter. I've broken this section up into what
seem to me to be the topics that the content
naturally divides into.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-03-02 04:20:35 +10: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
46a203a5c6 doc/cephadm: Add iscsi
Fixes https://tracker.ceph.com/issues/49488

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
8d07e35b2f doc/cephadm: group NFS 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
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
Sebastian Wagner
a4179acbce doc/cephadm: troubleshooting: manually deploy MGR
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-18 13:05:27 +01:00
Paul Cuzner
af00a33322 cephadm: updated doc text
The phrase "recommended"  has been removed.

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2021-02-02 14:22:43 +13:00
Paul Cuzner
509f171a08 cephadm: install doc updated to include cluster-network parameter
Install guide updated to include a description of the --cluster-network
parameter. The text also links to the complete definition for cluster-network
on the rados/configuration/network-config-ref page.

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2021-02-02 14:22:43 +13:00
Sebastian Wagner
eed40cf636 doc/cephadm: /etc/ceph is created automaticlly now
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-07 12:52:19 +01:00
Sebastian Wagner
28cc065271 doc/cephadm: CephFS: Encourage users to call ceph fs volume create
Manually deploying MDS daemons is an advanced topic.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-07 12:52:19 +01:00
Zac Dover
6d4033d441 doc/cephadm: improve install guide
- Repair broken lists.
- Add bash prompt directives.
- Add code-block directives.
- Add command markup.
- Improve English grammar.
- Fix prompt indentation.

Fixes: https://tracker.ceph.com/issues/48023
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-03 19:35:50 +10: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
Sebastian Wagner
cb529acaf4
Merge pull request #36496 from Daniel-Pivonka/cephadm-44926
mgr/cephadm: rgw update period after realm, zone creation

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-21 11:40:17 +02:00
Daniel-Pivonka
70b11a1a83 mgr/cephadm: rgw update period after realm, zone creation
Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
2020-08-18 15:54:31 -04:00
Sebastian Wagner
c625a51635
Merge pull request #36538 from zdover23/wip-docs-45678-fix
doc/cephadm: Remove shell alias

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-11 01:15:54 +02:00
Sebastian Wagner
75baae3528 doc/cephadm: Remove shell alias
Turns out, the alias doesn't work for files.

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

Fixes:

```
$ ceph orch apply -i myfile.yaml
ERROR: no such file or directory: myfile.yaml
```

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-08-10 17:50:54 +10:00
Daniel-Pivonka
131001c453 mgr/cephadm: streamline rgw deployment
cephadm will create realm, zonegroup, and zone if needed before creating rgw service

fixes: https://tracker.ceph.com/issues/43681
Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
2020-07-29 14:23:07 -04:00