198 lines
5.9 KiB
YAML
198 lines
5.9 KiB
YAML
# NOTE(fnordahl): Output of `juju list-action` is at time of this writing
|
|
# formatted in such a way that we should keep description
|
|
# as terse as possible and refer to documentation elsewhere.
|
|
#
|
|
# Verify with `juju list-action` before proposing/committing
|
|
# changes.
|
|
osd-out:
|
|
description: |
|
|
\
|
|
USE WITH CAUTION - Mark unit OSDs as 'out'.
|
|
Documentation: https://jaas.ai/ceph-osd/
|
|
params:
|
|
osds:
|
|
description: A comma-separated list of OSD IDs to stop (or keyword 'all')
|
|
required:
|
|
- osds
|
|
osd-in:
|
|
description: |
|
|
\
|
|
Set the local osd units in the charm to 'in'.
|
|
Documentation: https://jaas.ai/ceph-osd/
|
|
params:
|
|
osds:
|
|
description: A comma-separated list of OSD IDs to start (or keyword 'all')
|
|
required:
|
|
- osds
|
|
list-disks:
|
|
description: |
|
|
\
|
|
List disks.
|
|
Documentation: https://jaas.ai/ceph-osd/
|
|
add-disk:
|
|
description: |
|
|
\
|
|
Add disk(s) to Ceph.
|
|
Documentation: https://jaas.ai/ceph-osd/
|
|
params:
|
|
osd-devices:
|
|
type: string
|
|
description: The devices to format and set up as osd volumes.
|
|
bucket:
|
|
type: string
|
|
description: The name of the bucket in Ceph to add these devices into
|
|
osd-ids:
|
|
type: string
|
|
description: |
|
|
The OSD ids to recycle. If specified, the number of elements in this
|
|
list must be the same as the number of 'osd-devices'.
|
|
cache-devices:
|
|
type: string
|
|
description: |
|
|
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.
|
|
partition-size:
|
|
type: integer
|
|
description: |
|
|
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.
|
|
use-crimson:
|
|
type: boolean
|
|
description: |
|
|
Whether to use the Crimson implementation for the new OSD. Note that
|
|
this is an experimental feature, and the charm doesn't provide any
|
|
lifecycle support for OSD's that run on Crimson.
|
|
i-really-mean-it:
|
|
type: boolean
|
|
description: |
|
|
Must be set when 'use-crimson' is True.
|
|
required:
|
|
- osd-devices
|
|
blacklist-add-disk:
|
|
description: |
|
|
\
|
|
Add disk(s) to blacklist.
|
|
Documentation: https://jaas.ai/ceph-osd/
|
|
params:
|
|
osd-devices:
|
|
type: string
|
|
description: |
|
|
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:
|
|
description: |
|
|
\
|
|
Remove disk(s) from blacklist.
|
|
Documentation: https://jaas.ai/ceph-osd/
|
|
params:
|
|
osd-devices:
|
|
type: string
|
|
description: |
|
|
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
|
|
zap-disk:
|
|
description: |
|
|
\
|
|
USE WITH CAUTION - Purge disk of all data and signatures for use by Ceph.
|
|
Documentation: https://jaas.ai/ceph-osd/
|
|
params:
|
|
devices:
|
|
type: string
|
|
description: |
|
|
A space-separated list of devices to remove the partition table from.
|
|
i-really-mean-it:
|
|
type: boolean
|
|
description: |
|
|
This must be toggled to enable actually performing this action
|
|
required:
|
|
- devices
|
|
- i-really-mean-it
|
|
start:
|
|
description: |
|
|
\
|
|
Start OSD by ID
|
|
Documentation: https://jaas.ai/ceph-osd/
|
|
params:
|
|
osds:
|
|
description: A comma-separated list of OSD IDs to start (or keyword 'all')
|
|
required:
|
|
- osds
|
|
stop:
|
|
description: |
|
|
\
|
|
Stop OSD by ID
|
|
Documentation: https://jaas.ai/ceph-osd/
|
|
params:
|
|
osds:
|
|
description: A comma-separated list of OSD IDs to stop (or keyword 'all')
|
|
required:
|
|
- osds
|
|
security-checklist:
|
|
description: Validate the running configuration against the OpenStack security guides checklist
|
|
get-availability-zone:
|
|
description: |
|
|
Obtain information about the availability zone, which will contain information about the CRUSH
|
|
structure. Specifically 'rack' and 'row'.
|
|
params:
|
|
format:
|
|
type: string
|
|
default: text
|
|
enum:
|
|
- text
|
|
- json
|
|
description: Specify output format (text|json).
|
|
show-all:
|
|
type: boolean
|
|
description: Option to view information for all units. Default is 'false'.
|
|
remove-disk:
|
|
description: |
|
|
Remove disks from Ceph, producing a report afterwards indicating the user
|
|
as to how to replace them in the closest way possible.
|
|
params:
|
|
osd-devices:
|
|
type: string
|
|
description: A space-separated list of devices to remove
|
|
osd-ids:
|
|
type: string
|
|
description: |
|
|
A space separated list of OSD ids to remove. This parameter is mutually
|
|
exclusive with the parameter 'osd-devices'.
|
|
purge:
|
|
type: boolean
|
|
description: |
|
|
Whether to fully purge the OSD or let the id be available for reuse.
|
|
default: false
|
|
timeout:
|
|
type: integer
|
|
description: |
|
|
The time in minutes to wait for the OSD to be safe to remove.
|
|
default: 5
|
|
force:
|
|
type: boolean
|
|
description: |
|
|
Whether to forcefully remove the OSD even if it's determined to be
|
|
unsafe to destroy it.
|
|
default: false
|
|
format:
|
|
type: string
|
|
enum:
|
|
- text
|
|
- json
|
|
default: text
|
|
description: The output format returned for the command.
|