Ceph Osd

Learn about actions >

• add-disk

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

  Params

  • 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