'\" t
.\"     Title: ocf_heartbeat_openstack-info
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 12/17/2020
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_OPENST" "7" "12/17/2020" "resource-agents UNKNOWN" "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-info \- Records various node attributes in the CIB
.SH "SYNOPSIS"
.HP \w'\fBopenstack\-info\fR\ 'u
\fBopenstack\-info\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
OCF resource agent to set attributes from Openstack instance details\&. It records (in the CIB) various attributes of a node\&. Sample output: openstack_az : nova openstack_flavor : c1\&.small openstack_id : 60ac4343\-5828\-49b1\-8aac\-7c69b1417f31 openstack_ports : 7960d889\-9750\-4160\-bf41\-c69a41ad72d9:96530d18\-57a3\-4718\-af32\-30f2a74c22a2,b0e55a06\-bd75\-468d\-8baa\-22cfeb65799f:a55ae917\-8016\-4b1e\-8ffa\-04311b9dc7d6
.PP
The layout of openstack_ports is a comma\-separated list of tuples "subnet_id:port_id"\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBpidfile\fR
.RS 4
PID file
.sp
(optional, string, default "/run/resource\-agents/OSInfo\-")
.RE
.PP
\fBdelay\fR
.RS 4
Interval to allow values to stabilize
.sp
(optional, string, default "0")
.RE
.PP
\fBopenrc\fR
.RS 4
Valid Openstack credentials as openrc file from api_access/openrc\&.
.sp
(required, string, no default)
.RE
.PP
\fBopenstackcli\fR
.RS 4
Path to command line tools for openstack\&.
.sp
(optional, string, default "/usr/bin/openstack")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 60s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a openstack\-info resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_openstack\-info ocf:heartbeat:openstack\-info \e
  params \e
    openrc=\fIstring\fR \e
  op monitor timeout="20s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a openstack\-info resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_openstack\-info ocf:heartbeat:openstack\-info \e
  openrc=\fIstring\fR \e
  op monitor timeout="20s" 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