summaryrefslogtreecommitdiffstats
path: root/doc/cephadm (follow)
Commit message (Collapse)AuthorAgeFilesLines
* doc/cephadm: correct noteZac Dover4 days1-3/+4
| | | | | | | | | | Correct the English in a note in doc/cephadm/host-management.rst. This commit was made in response to https://github.com/ceph/ceph/pull/50340, which corrected some of this note in Quincy. Signed-off-by: Zac Dover <zac.dover@proton.me>
* Documentation changes for updating non-ceph image serviceShweta Bhosale2025-01-141-0/+16
| | | | | Fixes: https://tracker.ceph.com/issues/68979 Signed-off-by: Shweta Bhosale <Shweta.Bhosale1@ibm.com>
* Merge pull request #60690 from ↵Adam King2025-01-131-0/+12
|\ | | | | | | | | | | | | ShwetaBhosale1/fix_issue_68695_ceph_orch_commands_does_not_work_for_deployment_name_osd mgr/cephadm: ceph orch <start/stop/restart> commands should work for service name osd and command to updated service name for osd Reviewed-by: Adam King <adking@redhat.com>
| * Documentation changes for 'ceph orch osd set-spec-affinity' commandShweta Bhosale2024-12-051-0/+12
| | | | | | | | | | Fixes: https://tracker.ceph.com/issues/68695 Signed-off-by: Shweta Bhosale <Shweta.Bhosale1@ibm.com>
* | Merge pull request #58604 from adk3798/cephadm-rgw-no-multisite-trafficAdam King2025-01-131-0/+26
|\ \ | |/ |/| | | | | mgr/cephadm: allow disabling rgw_run_sync_thread through spec Reviewed-by: Redouane Kachach <rkachach@ibm.com>
| * doc/cephadm: documentation for RGW spec "disable_multisite_sync_traffic" optionAdam King2024-10-301-0/+26
| | | | | | | | Signed-off-by: Adam King <adking@redhat.com>
* | Merge pull request #60906 from ↵Anthony D'Atri2024-12-021-3/+3
|\ \ | | | | | | | | | | | | zdover23/wip-doc-2024-12-02-cephadm-services-mon-capitalize-ceph doc/cephadm: s/ceph/Ceph/ in mon.rst
| * | doc/cephadm: s/ceph/Ceph/ in mon.rstZac Dover2024-12-021-3/+3
| | | | | | | | | | | | | | | | | | s/ceph/Ceph/ in doc/cephadm/services/mon.rst where appropriate. Signed-off-by: Zac Dover <zac.dover@proton.me>
* | | Merge pull request #60412 from ↵Adam King2024-12-022-13/+11
|\ \ \ | |/ / |/| | | | | | | | | | | | | | | | | | | | ShwetaBhosale1/fix_issue_68605_modify_structure_of_default_images cephadm: Modify the structure of the default container images Reviewed-by: Adam King <adking@redhat.com> Reviewed-by: John Mulligan <jmulligan@redhat.com> Reviewed-by: Redouane Kachach <rkachach@ibm.com>
| * | cephadm: Modify the structure of the default container imagesShweta Bhosale2024-11-222-13/+11
| | | | | | | | | | | | | | | | | | Fixes: https://tracker.ceph.com/issues/68605?next_issue_id=68599 Signed-off-by: Shweta Bhosale <Shweta.Bhosale1@ibm.com>
* | | doc/cephadm: Improve "Curl-based Installation"Zac Dover2024-11-231-37/+50
| | | | | | | | | | | | | | | | | | Change the name of the section "curl-based installation" to "Using Curl to Install Cephadm", and improve the English in that section. Signed-off-by: Zac Dover <zac.dover@proton.me>
* | | doc/cephadm: Clarify "Deploying a new Cluster"Zac Dover2024-11-231-3/+3
|/ / | | | | | | | | | | | | | | | | Change the title of the section "Deploying a new Ceph cluster" to "Using cephadm to Deploy a New Ceph Cluster". This is part of the initiative to separate package-related documentation from container-based documenation. Signed-off-by: Zac Dover <zac.dover@proton.me>
* | Merge pull request #60588 from AlexonOliveiraRH/wip-doc-templatesAnthony D'Atri2024-11-191-3/+25
|\ \ | | | | | | doc/cephadm/services: Update monitoring.rst to add additional templates
| * | doc/cephadm/services: Update monitoring.rst to add additional templatesAlexon Oliveira2024-11-011-18/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The current documentation lacks a lot of other available templates as the source code here: https://github.com/ceph/ceph/tree/main/src/pybind/mgr/cephadm/templates/services v2 - This updated commit fixes the j2 extensions I left in the previous one wrongly. v3 - This updated commit changes the title as per PR's comment orientation Signed-off-by: Alexon Oliveira <alolivei@redhat.com>
| * | doc/cephadm/services: [v1] Update monitoring.rst to add additional templatesAlexon Oliveira2024-11-011-9/+31
| | | | | | | | | | | | | | | | | | | | | | | | The current documentation lacks a lot of other available templates as the source code here: https://github.com/ceph/ceph/tree/main/src/pybind/mgr/cephadm/templates/services Signed-off-by: Alexon Oliveira <alolivei@redhat.com>
* | | doc/cephadm: clean "Adv. OSD Service Specs"Zac Dover2024-11-061-20/+25
| | | | | | | | | | | | | | | | | | | | | Clean the English grammar and the .RST in the section "Advanced OSD Service Specifications" in the file doc/cephadm/services/osd.rst. Signed-off-by: Zac Dover <zac.dover@proton.me>
* | | doc/cephadm: link to "host pattern" matching sectZac Dover2024-11-062-2/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Link to the "Placement by Pattern Matching" section in doc/cephadm/services/index.rst from the "Advanced OSD Service Specifications" section in doc/cephadm/services/osd.rst. Fixes: https://tracker.ceph.com/issues/68812 Signed-off-by: Zac Dover <zac.dover@proton.me>
* | | doc/cephadm: Update operations.rstrhkelson2024-11-061-1/+1
|/ / | | | | | | | | | | | | Fixed typo 'no' to 'not' in sentence "If this test fails, cephadm will no be able to manage services on that host." Signed-off-by: rhkelson <119636079+rhkelson@users.noreply.github.com>
* | Merge pull request #60096 from adk3798/maintenance-mode-dead-hostAdam King2024-10-301-5/+10
|\ \ | |/ |/| | | | | mgr/cephadm: offline host handling for maintenance exit command Reviewed-by: John Mulligan <jmulligan@redhat.com>
| * doc/cephadm: document new flags on maintenance exit commandAdam King2024-10-161-5/+10
| | | | | | | | Signed-off-by: Adam King <adking@redhat.com>
* | Merge pull request #59982 from rkachach/fix_issue_mgmt_gw_high_availabilityAdam King2024-10-242-7/+54
|\ \ | | | | | | | | | | | | | | | | | | Adding HA support for mgmt-gateway and oauth2-proxy services Reviewed-by: Adam king <adking@redhat.com> Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com> Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
| * | doc/cephadm: adding documentation for mgmt-gateway HA setupRedouane Kachach2024-10-172-7/+54
| |/ | | | | | | Signed-off-by: Redouane Kachach <rkachach@ibm.com>
* | doc/cephadm: correct "ceph orch apply" commandZac Dover2024-10-221-1/+1
| | | | | | | | | | | | | | | | | | | | s/orch apply/ceph orch apply/ in a command where "ceph" was missing. This was reported by Eugen Block to Zac Dover on 22 Oct 2024 through Slack. Co-authored-by: Eugen Block <eblock@nde.ag> Signed-off-by: Zac Dover <zac.dover@proton.me>
* | orch: disk replacement enhancementGuillaume Abrioux2024-10-161-0/+69
|/ | | | | | | | | | This introduces a new `ceph orch device replace` command in order to improve the user experience when it comes to replacing the underlying device of an OSD. Fixes: https://tracker.ceph.com/issues/68456 Signed-off-by: Guillaume Abrioux <gabrioux@ibm.com>
* doc: remove note for smb3 supportSachin Prabhu2024-10-061-2/+0
| | | | | | | We support SMB2, SMB2.1 and SMB 3 at the moment. We are not limited to just SMB3 as noted in the documentation. Signed-off-by: Sachin Prabhu <sp@spui.uk>
* Merge pull request #59843 from adk3798/cephadm-oauth2-image-variable-nameAdam King2024-09-231-6/+6
|\ | | | | | | | | | | | | mgr/cephadm: update oauth2 proxy image variable name Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com> Reviewed-by: Guillaume Abrioux <gabrioux@ibm.com> Reviewed-by: Ken Dreyer <kdreyer@ibm.com>
| * doc/cephadm: don't hardcode default oauth2-proxy image into docsAdam King2024-09-181-6/+6
| | | | | | | | | | | | | | | | | | This makes it another place we need to update when changing the default image which is easy to forget. Instead, we can document how users can find the the image which will still hold even if we change what the default image is. Signed-off-by: Adam King <adking@redhat.com>
* | cephadm: Support Docker Live RestoreMichal Nasiadka2024-09-131-0/+4
|/ | | | | | | | | | | | | | | | | | | | | | | | Currently with Docker Live Restore [1] enabled and while restarting Docker Engine - all Ceph container images will get restarted, while the feature allows restarting docker.service without containers downtime. This is due to Requires=docker.service in systemd units templates, which mandates that on docker.service restart - the ceph container systemd units will be restarted as well. Reworking Requires= to Wants= that is a weaker version of the former, see [2]. Leaving After= entries, because they should allow systemd to correctly order the startup (first docker, then ceph containers). [1]: https://docs.docker.com/engine/daemon/live-restore/ [2]: https://www.freedesktop.org/software/systemd/man/latest/systemd.unit.html#Wants= Fixes: https://tracker.ceph.com/issues/68028 Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com>
* doc/cephadm: add malformed-JSON removal instructionsZac Dover2024-09-091-1/+15
| | | | | | | | Add instructions for removing malformed JSON that causes the cephadm module to fail to start, which in turn makes the orchestrator fail to start. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: Correct link to Prometheus docsMatthew Vernon2024-09-021-1/+1
| | | | | | | The link is to the `#http_sd_config` anchor in the prometheus config docs; that link only works without the trailing `/`. This correction would ideally get backported to at least reef & squid. Signed-off-by: Matthew Vernon <mvernon@wikimedia.org>
* doc: add documentation for (cluster_)public_addrs optionsJohn Mulligan2024-08-271-3/+25
| | | | | | | | Document the spec and resource options (they're basically the same) for specifying public addresses that will be managed automatically by CTDB. Signed-off-by: John Mulligan <jmulligan@redhat.com>
* doc/cephadm: how to get exact size_spec from deviceZac Dover2024-08-251-0/+33
| | | | | | | | Add instructions for retrieving the exact size of block devices. Fixes: https://tracker.ceph.com/issues/66754 Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: add clustering related items to smb docsJohn Mulligan2024-08-201-9/+30
| | | | Signed-off-by: John Mulligan <phlogistonjohn@asynchrono.us>
* Merge pull request #58460 from rkachach/fix_issue_oauth2_supportAdam King2024-08-202-0/+140
|\ | | | | | | | | adding support for SSO based on auth2-proxy Reviewed-by: Adam King <adking@redhat.com>
| * mgr/cephadm: adding oauth2-proxy cephadm serviceRedouane Kachach2024-08-142-0/+140
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | adding new oauth2-proxy service. The enable_auth flag enables SSO authentication via the oauth2-proxy service. The user must ensure the oauth2-proxy service is deployed before enabling this flag in the mgmt-gateway service. FQDN related changes: previously, we were obtaining the FQDN using a call to the Python socket library run inside the container. While this generally works, the FQDN returned inside a container can sometimes differ from the one obtained outside the container. This discrepancy could cause some issues. To ensure consistency, we now use the FQDN from the inventory, which provides the correct value as recognized on the host. Signed-off-by: Redouane Kachach <rkachach@ibm.com>
* | ceph-volume: add TPM2 token enrollment support for encrypted OSDsGuillaume Abrioux2024-08-121-0/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds the required changes to ceph-volume and cephadm in order to support deploying tpm2 token enrolled encrypted OSDs. Adding `--with-tpm` when deploying with `--dmcrypt` will enroll a tpm2 token to the corresponding LUKS2 devices. Example of a osd service spec: ``` service_type: osd service_id: tpm2_osds placement: host_pattern: '*' spec: data_devices: paths: - /dev/sdb encrypted: true tpm2: true ``` Signed-off-by: Guillaume Abrioux <gabrioux@ibm.com>
* | doc/cephadm/smb: Add missing user_sources option to service specAnoop C S2024-08-071-0/+5
|/ | | | Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
* doc/cephadm: edit "Using Custom Images"Zac Dover2024-07-301-27/+29
| | | | | | | | Edit the section "Using Custom Images" in doc/cephadm/services/monitoring.rst. Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com> Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/cephadm/upgrade: ceph-ci containers are hosted by quay.ceph.ioCasey Bodley2024-07-191-1/+1
| | | | Signed-off-by: Casey Bodley <cbodley@redhat.com>
* Merge pull request #57535 from rkachach/fix_issue_66095Adam King2024-07-102-0/+151
|\ | | | | | | | | | | Adding support for ceph mgmt-gateway Reviewed-by: Adam King <adking@redhat.com> Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
| * mgr/cephadm: adding documentation for cephadm mgmt-gateway serviceRedouane Kachach2024-07-092-0/+151
| | | | | | | | Signed-off-by: Redouane Kachach <rkachach@ibm.com>
* | doc: Correct link to "Device management"Matthew Vernon2024-07-091-2/+1
|/ | | | | | The current link goes to `cephadm/services/rados/operations/devices` which is a 404, it instead needs to be `rados/operations/devices/`. Signed-off-by: Matthew Vernon <mvernon@wikimedia.org>
* doc: clarify use of location: in host specMatthew Vernon2024-05-221-1/+5
| | | | | | | | It wasn't clear that you can specify more than one element of the CRUSH hierarchy in a spec file, nor that it might be useful to do so (e.g. to ensure the host ends up beneath the default root). So update the text to make it clearer, and similarly the example. Signed-off-by: Matthew Vernon <mvernon@wikimedia.org>
* doc/cephadm: add default monitor imagesZac Dover2024-04-301-0/+32
| | | | | | | | | Add a list of default monitor images to the documentation. This commit is made in response to a request from Eugen Block, and is made using the information developed by Mr Block here: https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/QGC66QIFBKRTPZAQMQEYFXOGZJ7RLWBN/. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/cephadm: remove downgrade reference from upgrade docsAdam King2024-04-231-2/+2
| | | | | | | | This has been in here for years, but cephadm will block attempted upgrades to lower versions and we generally don't want people to think this is supported or safe. Signed-off-by: Adam King <adking@redhat.com>
* doc/cephadm: document new --no-ceph-conf flag for `orch client-keyring set`Adam King2024-04-041-0/+7
| | | | Signed-off-by: Adam King <adking@redhat.com>
* doc/cephadm: add a file documenting the smb serviceJohn Mulligan2024-03-212-0/+206
| | | | Signed-off-by: John Mulligan <jmulligan@redhat.com>
* Merge pull request #56070 from phlogistonjohn/jjm-cephadm-sudo-cmd-auditingAdam King2024-03-191-0/+45
|\ | | | | | | | | cephadm: sudo cmd auditing Reviewed-by: Adam King <adking@redhat.com>
| * doc/cephdam: document limiting passwordless sudo commandsJohn Mulligan2024-03-171-0/+45
| | | | | | | | | | | | | | | | Based on the previous commits making the remote executables auditable and explicit, document the admin's ability to restrict password-less sudo access to only the set of commands cephadm actually uses. Signed-off-by: John Mulligan <jmulligan@redhat.com>
* | Merge pull request #56109 from anthonyeleven/improve-monitoringZac Dover2024-03-191-12/+16
|\ \ | | | | | | | | | | | | doc/cephadm/services: Improve monitoring.rst Reviewed-by: Zac Dover <zac.dover@proton.me>