Commit Graph

38 Commits

Author SHA1 Message Date
John Mulligan
fed4066a85 doc/dev/cephadm: describe advanced build options
Describe the advanced build options provided by build.py and how
to use `cephadm version --verbose` to print the internal metadata.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-11-06 13:38:23 -05:00
John Mulligan
421147f97c doc: add instructions for compiling cephadm
Now that cephadm is based on zipapp, add a short section to the
developer docs explaining how to build cephadm yourself.

Note: This commit is a cherry-pick of
9ad38033cc, which was introduced by John
Mulligan in #48180. This is one of three commits introduced in that PR,
and this cherry-pick cleans up omissions I (Zac Dover) inadvertently
introduced while attempting to rectify the merge conflicts in #51843. I
expect that one more cherry-picked commit (specifically,
d11cf0e82a, which cannot be merged easily
until d7921e88d6 has been merged into
main, for reasons that are too
Rick-and-Morty-there-should-never-be-more-than-one-dot to go into here)
will follow this one.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
(cherry picked from commit 9ad38033cc)
2023-05-31 21:44:21 +08:00
John Mulligan
d11cf0e82a doc: update the cephadm download instructions
Starting with reef, cephadm is a compiled (zipapp) python application.
The cephadm script has been renamed and thus the old curl-based
download instructions will no loner work. While cephadm still has
no dependencies outside the Python stdlib, this will be changed in
future versions so it is no longer appropriate to just download the
source file of cephadm and run it either.

This change updates the `Install cephadm` section of the doc to explain
how to acquire a "compiled" version of cephadm as well as:
* moving and tweaking the note that the two installation methods are
  distinct
* adding a new note linking to instructions on building cephadm
* moving the distribution-specific installations before the curl-based
  installation to subtly hint that we prefer you to get it using
  packages if you can
* Noting cephadm's minimal required python verision and how to run it
  with a particular python version.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-05-30 11:49:21 -04:00
John Mulligan
9ad38033cc doc: add instructions for compiling cephadm
Now that cephadm is based on zipapp, add a short section to the
developer docs explaining how to build cephadm yourself.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-05-30 11:49:21 -04:00
Josh Soref
94ade0cd16 orchestrator: fix spelling errors
* a new
* accommodated
* adopted
* appended
* because
* bootstrap
* bootstrapping
* brackets
* classes
* cluster
* compatible
* completely
* confusion
* daemon
* daemons
* dashboard
* enclosure
* existing
* explicit
* following
* format
* host
* implementation
* inferred
* keepalived
* kubic
* maintenance
* necessarily
* necessary
* network
* notifier
* octopus
* permanent
* presenting
* related
* see
* snapshot
* stateful
* the
* track
* version
* wasn't
* weird

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2023-04-26 09:21:42 -04:00
Pere Diaz Bou
0a07a82f70 cephadm/box: minor fixes
Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2023-01-19 10:12:09 +01:00
Ranjini Mandyam Narasiodeyar
ffea636176 doc/dev/cephadm: fix host maintenance enter/exit syntax -
Signed-off-by: Ranjini Mandyam Narasiodeyar <rmandyam@rmandyam.remote.csb>
2022-12-27 10:38:26 +05:30
Pere Diaz Bou
6f5ac1274b cephadm/box: Choose between docker or podman with --engine
With ./box.py --engine docker you can specify you want to use docker
instead of podman. With docker box.py command should be run with sudo.

Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-07-13 16:43:00 +02:00
Pere Diaz Bou
d4e6763a19 cephadm/box: Rootless podman box implementation
Even though box is a rootless podman container, there are some
capabilities that are need like SYS_ADMIN, NET_ADMIN and SYS_TIME.

In rootless podman chronyd is not capabable of using adjtimex syscall
so we had to add -x flag to chronyd entrypoint which states it will
not try to call that function.

To test run `./box.py -v cluster start`.

To fix: There are some problems with /dev permissions so osds cannot be
deployed still. `./box.py cluster start --expanded` won't fully work.

Details:
- Dockerfile:
  - Fedora image instead of centos.
  - Tons of basic packages aren't installed, therefore, those are
  explicitly installed.
  - Some container folders are created. It isn't clear/tested whether
  those are needed.
  - .box_container is an empty file to identify if a command is ran on
  containers (see box.py for usage).
- box.py
  - podman-compose is missing some features but it compensates with args
  as --podman-run-args so you can add some extra commands whenever
  podman-compose calls podman run.
  - sudo ./box.py cluster start will exit since it can be dangerous.
  - Added some sed trickeroo to modify chronyd options. (I don't know
  how can I pass OPTIONS to it :P)
 - host.py
   - setup_ssh now is need on every box container.
- util.py
  - rice command printing :3.
  - run multiple commands with a multiline string.

Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-07-08 10:02:53 +02: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
Adam King
7c6c715aa5 mgr/cephadm: some master -> main cleanup
Signed-off-by: Adam King <adking@redhat.com>
2022-06-06 15:18:08 -04:00
Pere Diaz Bou
dd1b5eb38c cephadm/box: default add hosts
Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-02-28 09:48:36 +01:00
Sebastian Wagner
9e8b2d8282
Merge pull request #44510 from rzarzynski/wip-cephadm-docfix
doc/cephadm: improve the development doc a bit

Reviewed-by: Sebastian Wagner <sewagner@redhat.com>
2022-01-17 10:21:45 +01:00
Radoslaw Zarzynski
4c58d71d2b doc/cephadm: improve the developer's guide a bit
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-01-10 14:18:00 +00:00
Radoslaw Zarzynski
e513869fd3 doc/cephadm: fix a typo in developing-cephadm.rst
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-01-10 14:15:23 +00:00
Alfonso Martínez
dae1b27022
Merge pull request #43580 from rhcs-dashboard/cephadm_box-docs
cephadm/box: DiD box documentation

Reviewed-by: Aashish Sharma <aasharma@redhat.com>
Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Avan Thakkar <athakkar@redhat.com>
Reviewed-by: sebastian-philipp <sewagner@redhat.com>
2022-01-04 17:24:44 +01: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
Pere Diaz Bou
36f0246f32 doc/cephadm: add DiD box documentation
Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2021-12-02 09:50:04 +01:00
karmab
064b8de309 doc: update kcli information 2021-09-29 17:07:53 +02:00
Adam King
35f895aa45 mgr/cephadm: remove cephadm exporter code
It's functionality has been effectively replaced by the cephadm agent

Signed-off-by: Adam King <adking@redhat.com>
2021-09-27 12:11:55 -04:00
Sebastian Wagner
9d30b96f04
doc/dev/cephadm: Define variables
Fixes: https://tracker.ceph.com/issues/47142
Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-07-07 11:47:59 +02:00
Sebastian Wagner
848fd9dc83
Merge pull request #41694 from jmolmo/kcli_cephadm_doc
doc: Add kcli utilization for development environments

Reviewed-by: Sebastian Wagner <sewagner@redhat.com>
2021-06-17 11:37:26 +02:00
Sebastian Wagner
5f1aa05563 doc/dev/cephadm: cephadm bootstrap --shared_ceph_folder
Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-06-08 12:16:49 +02:00
Juan Miguel Olmo Martínez
3b82624e0c
doc: Add kcli utilization for development environments
How to use kcli to create ceph clusters (cephadm) and made easy code changes in
manager modules.

Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-06-04 13:09:24 +02:00
Kefu Chai
ba285cbc98 doc/dev/cephadm: quote command with backquotes
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-28 23:29:56 +08:00
Sebastian Wagner
f82e374341 doc/dev/cephadm: scalability notes
Add a few notes about possible future scalability improvements

Co-authored-by: Joshua Schmid <jschmid@suse.de>
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-09 12:14:26 +01:00
Juan Miguel Olmo Martínez
bddb596011
doc: High level workflow for storage devices
A first document where to discuss how to improve and make more easy and effective for final users the storage devices and OSD management.

Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-01-20 13:17:53 +01:00
Sebastian Wagner
6b3c46f508 doc/dev: resurrect hidden dev/cephadm.rst
some time ago, a cephadm folder was added that did hide the
old dev documentation page.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-06 14:13:11 +01:00
pcuzner
bb462f2cb8
Merge branch 'master' into cephadm-exporter-docs 2020-12-10 09:39:45 +13:00
Paul Cuzner
ba485f2472 doc/dev/cephadm: update index links
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-10 09:37:13 +13:00
Paul Cuzner
f2791c0e26 doc/dev/cephadm: Add link to the index
Adds a link to the index for the compliance-check doc

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-04 13:58:06 +13:00
Paul Cuzner
1facc5e9a7 doc/dev/cephadm: Updates following feedback
Minor grammatical and formatting changes

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-04 13:56:20 +13:00
Paul Cuzner
7168cbf052 doc: moved design doc under doc/dev
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-04 13:56:20 +13:00
Paul Cuzner
875c94fd95 doc/dev/cephadm: minor updates to address PR feedback
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-03 12:17:37 +13:00
Paul Cuzner
fef0e12bf3 doc/dev/cephadm: document the cephadm exporter design
Development document defining the goals, requirements,
design and implementation details for the exporter mode
of the cephadm 'binary'

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-11-30 19:30:32 +13:00
Paul Cuzner
df1afd6b12 doc/dev/cephadm: Updates following PR feedback
Minor update adding an idea for future development as
per suggestion from @anthonyeleven

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-10-23 18:31:50 +13:00
Paul Cuzner
10f382c359 doc/dev/cephadm: add link for feature designs
Add a link from the main cephadm page to the index
within /dev/dev/cephadm

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-10-23 15:35:06 +13:00
Paul Cuzner
8f3ed063a7 doc/dev/cephadm: Doc defining the design for host maintenance
Initial PR to define/agree the scope and goals of providing
a host maintenance feature.

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-10-13 09:17:38 +13:00