actions.yaml

alarm-disarm:
  description: |
    Disarm all alarms.
alarm-list:
  description: |
    List all alarms.
compact:
  description: |
    Compact etcd event history.
  params:
    revision:
      type: string
      default: ''
      description: |
        Revision to compact to. Leave blank to compact to the latest revision.
    physical:
      type: boolean
      default: False
      description: |
        Setting to True will cause the compaction process to exit only after
        all revisions have been physically removed from the database.
defrag:
  description: |
    Defragment the storage of the local etcd member.
health:
  description: Report the health of the cluster.
package-client-credentials:
    description: |
     Generate a tarball of the client certificates to connect to the cluster
     remotely.
snap-upgrade:
  description: |
    Execute a migration from the apt package to a snap package format.
  params:
    use-resource:
      type: boolean
      default: False
      description: Default to using the resource (offline environments)
snapshot:
  description: Export and compress a backup of the data in the Etcd cluster.
  params:
    target:
      type: string
      default: '/home/ubuntu/etcd-snapshots'
      description: Location to save the etcd snapshot.
    keys-version:
      type: string
      default: 'v3'
      description: Version of keys to snapshoot. Allowed values 'v3' or 'v2'.
restore:
  description: Restore an etcd cluster's data from a snapshot tarball.
  params:
    target:
      type: string
      default: '/home/ubuntu'
      description: Path on disk to save any pre-existing data.
    skip-backup:
      type: boolean
      default: True
      description: |
        Dont backup any existing data, and skip directly to data restoration.