---
title: Charmhub | Deploy Ceph Osd using Charmhub - The Open Operator Collection
description: Deploy the latest version of Ceph Osd on any cloud.
url: https://charmhub.io/ceph-osd/actions
---

# Ceph Osd

[OpenStack Charmers](https://charmhub.io/publisher/openstack-charmers "View all packages from OpenStack Charmers")

* [OpenStack Charmers](https://charmhub.io/publisher/openstack-charmers "View all packages from OpenStack Charmers")
* [Cloud](https://charmhub.io/?filter=cloud)
* [Storage](https://charmhub.io/?filter=storage)

Platform:

26.04

24.04

23.10

23.04

22.10

22.04

21.10

21.04

20.10

+5

quincy/stable 762

```
juju deploy ceph-osd --channel quincy/stable
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

* [add-disk](https://charmhub.io/ceph-osd/actions#add-disk)
* [blacklist-add-disk](https://charmhub.io/ceph-osd/actions#blacklist-add-disk)
* [blacklist-remove-disk](https://charmhub.io/ceph-osd/actions#blacklist-remove-disk)
* [get-availability-zone](https://charmhub.io/ceph-osd/actions#get-availability-zone)
* [list-disks](https://charmhub.io/ceph-osd/actions#list-disks)
* [osd-in](https://charmhub.io/ceph-osd/actions#osd-in)
* [osd-out](https://charmhub.io/ceph-osd/actions#osd-out)
* [remove-disk](https://charmhub.io/ceph-osd/actions#remove-disk)
* [security-checklist](https://charmhub.io/ceph-osd/actions#security-checklist)
* [start](https://charmhub.io/ceph-osd/actions#start)
* [stop](https://charmhub.io/ceph-osd/actions#stop)
* [update-apparmor-and-restart-osds](https://charmhub.io/ceph-osd/actions#update-apparmor-and-restart-osds)
* [zap-disk](https://charmhub.io/ceph-osd/actions#zap-disk)

[Learn about actions >](https://juju.is/docs/juju/action)

* add-disk

  Add disk(s) to Ceph.
  Documentation: https://jaas.ai/ceph-osd/

  Params

  + bluestore-skip
    string

    A comma-separated list of what Bluestore features to omit. This can
    be the WAL and DB devices (for example - "wal,db")
  + bucket
    string

    The name of the bucket in Ceph to add these devices into
  + cache-devices
    string

    A list of devices to act as caching devices for 'bcache', using the
    'osd-devices' as backing. If the number of elements in this list is
    less than the number of 'osd-devices', then the caching ones will be
    distributed in a round-robin fashion.
  + osd-devices
    string

    The devices to format and set up as osd volumes.
  + osd-ids
    string

    The OSD ids to recycle. If specified, the number of elements in this
    list must be the same as the number of 'osd-devices'.
  + partition-size
    integer

    The size of the partitions to create for the caching devices. If left
    unspecified, then the full size of the devices will be split evenly
    across partitions.

  Required

  osd-devices
* blacklist-add-disk

  Add disk(s) to blacklist.
  Documentation: https://jaas.ai/ceph-osd/

  Params

  + osd-devices
    string

    A space-separated list of devices to add to blacklist.
    .
    Each element should be a absolute path to a device node or filesystem
    directory (the latter is supported for ceph >= 0.56.6).
    .
    Example: '/dev/vdb /var/tmp/test-osd'

  Required

  osd-devices
* blacklist-remove-disk

  Remove disk(s) from blacklist.
  Documentation: https://jaas.ai/ceph-osd/

  Params

  + osd-devices
    string

    A space-separated list of devices to remove from blacklist.
    .
    Each element should be a existing entry in the units blacklist.
    Use list-disks action to list current blacklist entries.
    .
    Example: '/dev/vdb /var/tmp/test-osd'

  Required

  osd-devices
* get-availability-zone

  Obtain information about the availability zone, which will contain information about the CRUSH
  structure. Specifically 'rack' and 'row'.

  Params

  + format
    string

    Specify output format (text|json).
  + show-all
    boolean

    Option to view information for all units. Default is 'false'.
* list-disks

  List disks.
  Documentation: https://jaas.ai/ceph-osd/
* osd-in

  Set the local osd units in the charm to 'in'.
  Documentation: https://jaas.ai/ceph-osd/

  Params

  + osds

    A comma-separated list of OSD IDs to start (or keyword 'all')

  Required

  osds
* osd-out

  USE WITH CAUTION - Mark unit OSDs as 'out'.
  Documentation: https://jaas.ai/ceph-osd/

  Params

  + osds

    A comma-separated list of OSD IDs to stop (or keyword 'all')

  Required

  osds
* remove-disk

  Remove disks from Ceph, producing a report afterwards indicating the user
  as to how to replace them in the closest way possible.

  Params

  + force
    boolean

    Whether to forcefully remove the OSD even if it's determined to be
    unsafe to destroy it.
  + format
    string

    The output format returned for the command.
  + osd-devices
    string

    A space-separated list of devices to remove
  + osd-ids
    string

    A space separated list of OSD ids to remove. This parameter is mutually
    exclusive with the parameter 'osd-devices'.
  + purge
    boolean

    Whether to fully purge the OSD or let the id be available for reuse.
  + timeout
    integer

    The time in minutes to wait for the OSD to be safe to remove.
* security-checklist

  Validate the running configuration against the OpenStack security guides checklist
* start

  Start OSD by ID
  Documentation: https://jaas.ai/ceph-osd/

  Params

  + osds

    A comma-separated list of OSD IDs to start (or keyword 'all')

  Required

  osds
* stop

  Stop OSD by ID
  Documentation: https://jaas.ai/ceph-osd/

  Params

  + osds

    A comma-separated list of OSD IDs to stop (or keyword 'all')

  Required

  osds
* update-apparmor-and-restart-osds

  Invoke pending continuation of update of AppArmor profiles followed by restarting OSD
  services. Make sure to run this action separately in each unit at different times
  to avoid simultaneous restart of OSDs.
* zap-disk

  USE WITH CAUTION - Purge disk of all data and signatures for use by Ceph.
  Documentation: https://jaas.ai/ceph-osd/

  Params

  + devices
    string

    A space-separated list of devices to remove the partition table from.
  + i-really-mean-it
    boolean

    This must be toggled to enable actually performing this action

  Required

  devices,
  i-really-mean-it
