'\" t
.\"     Title: ocf_heartbeat_openstack-cinder-volume
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/13/2023
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.12.0-2
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_OPENST" "7" "04/13/2023" "resource-agents 4.12.0-2" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_openstack-cinder-volume \- Attach a cinder volume
.SH "SYNOPSIS"
.HP \w'\fBopenstack\-cinder\-volume\fR\ 'u
\fBopenstack\-cinder\-volume\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource Agent to attach a cinder volume to an instance\&. It relies on attributes given by openstack\-info resource agent (openstack_id attribute)\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBcloud\fR
.RS 4
Openstack cloud (from ~/\&.config/openstack/clouds\&.yaml or /etc/openstack/clouds\&.yaml)\&.
.sp
(optional, string, no default)
.RE
.PP
\fBopenrc\fR
.RS 4
Openstack credentials as openrc file from api_access/openrc\&.
.sp
(optional, string, no default)
.RE
.PP
\fBauth_url\fR
.RS 4
Keystone Auth URL
.sp
(optional, string, no default)
.RE
.PP
\fBusername\fR
.RS 4
Username\&.
.sp
(optional, string, no default)
.RE
.PP
\fBpassword\fR
.RS 4
Password\&.
.sp
(optional, string, no default)
.RE
.PP
\fBproject_name\fR
.RS 4
Keystone Project\&.
.sp
(optional, string, no default)
.RE
.PP
\fBuser_domain_name\fR
.RS 4
Keystone User Domain Name\&.
.sp
(optional, string, default "Default")
.RE
.PP
\fBproject_domain_name\fR
.RS 4
Keystone Project Domain Name\&.
.sp
(optional, string, default "Default")
.RE
.PP
\fBopenstackcli\fR
.RS 4
Path to command line tools for openstack\&.
.sp
(optional, string, default "/usr/bin/openstack")
.RE
.PP
\fBinsecure\fR
.RS 4
Allow insecure connections
.sp
(optional, boolean, default
false)
.RE
.PP
\fBvolume_local_check\fR
.RS 4
This option allows the cluster to monitor the cinder volume presence without calling the API\&.
.sp
(optional, boolean, default
true)
.RE
.PP
\fBvolume_id\fR
.RS 4
Cinder volume identifier to use to attach the block storage\&.
.sp
(required, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 180s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 180s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 180s\&. Suggested interval: 60s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a openstack\-cinder\-volume resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_openstack\-cinder\-volume ocf:heartbeat:openstack\-cinder\-volume \e
  params \e
    volume_id=\fIstring\fR \e
  op monitor depth="0" timeout="180s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a openstack\-cinder\-volume resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_openstack\-cinder\-volume ocf:heartbeat:openstack\-cinder\-volume \e
  volume_id=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="180s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR