ocf_heartbeat_openstack-cinder-volume - Man Page

Attach a cinder volume

Synopsis

openstack-cinder-volume [start | stop | monitor | meta-data | validate-all]

Description

Resource Agent to attach a cinder volume to an instance. It relies on attributes given by openstack-info resource agent (openstack_id attribute).

Supported Parameters

cloud

Openstack cloud (from ~/.config/openstack/clouds.yaml or /etc/openstack/clouds.yaml).

(optional, string, no default)

openrc

Openstack credentials as openrc file from api_access/openrc.

(optional, string, no default)

auth_url

Keystone Auth URL

(optional, string, no default)

username

Username.

(optional, string, no default)

password

Password.

(optional, string, no default)

project_name

Keystone Project.

(optional, string, no default)

user_domain_name

Keystone User Domain Name.

(optional, string, default "Default")

project_domain_name

Keystone Project Domain Name.

(optional, string, default "Default")

openstackcli

Path to command line tools for openstack.

(optional, string, default "/usr/bin/openstack")

insecure

Allow insecure connections

(optional, boolean, default false)

volume_local_check

This option allows the cluster to monitor the cinder volume presence without calling the API.

(optional, boolean, default true)

volume_id

Cinder volume identifier to use to attach the block storage.

(required, string, no default)

Supported Actions

This resource agent supports the following actions (operations):

start

Starts the resource. Suggested minimum timeout: 180s.

stop

Stops the resource. Suggested minimum timeout: 180s.

monitor

Performs a detailed status check. Suggested minimum timeout: 180s. Suggested interval: 60s.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 5s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

Example CRM Shell

The following is an example configuration for a openstack-cinder-volume resource using the crm(8) shell:

primitive p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \
  params \
    volume_id=string \
  op monitor depth="0" timeout="180s" interval="60s"

Example PCS

The following is an example configuration for a openstack-cinder-volume resource using pcs(8)

pcs resource create p_openstack-cinder-volume ocf:heartbeat:openstack-cinder-volume \
  volume_id=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="60s"

See Also

http://clusterlabs.org/

Author

ClusterLabs contributors (see the resource agent source for information about individual authors)

Info

07/26/2024 resource-agents UNKNOWN OCF resource agents