'\" t
.\"     Title: ocf_heartbeat_gcp-pd-move
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_GCP\-P" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "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_gcp-pd-move \- Attach/Detach a persistent disk on current GCP instance
.SH "SYNOPSIS"
.HP \w'\fBgcp\-pd\-move\fR\ 'u
\fBgcp\-pd\-move\fR [start | stop | monitor | meta\-data]
.SH "DESCRIPTION"
.PP
Resource Agent that can attach or detach a regional/zonal disk on current GCP instance\&. Requirements :
.PP
\- Disk has to be properly created as regional/zonal in order to be used correctly\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBdisk_name\fR
.RS 4
The name of the GCP disk\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBdisk_scope\fR
.RS 4
Disk scope
.sp
(optional, string, default "detect")
.RE
.PP
\fBdisk_csek_file\fR
.RS 4
Path to a Customer\-Supplied Encryption Key (CSEK) key file
.sp
(optional, string, no default)
.RE
.PP
\fBmode\fR
.RS 4
Attachment mode (READ_WRITE, READ_ONLY)
.sp
(optional, string, default "READ_WRITE")
.RE
.PP
\fBdevice_name\fR
.RS 4
An optional name that indicates the disk name the guest operating system will see\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBstackdriver_logging\fR
.RS 4
Use stackdriver_logging output to global resource (yes, true, enabled)
.sp
(optional, string, default "no")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 300s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 15s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 15s\&. Suggested interval: 10s\&.
.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 gcp\-pd\-move resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_gcp\-pd\-move ocf:heartbeat:gcp\-pd\-move \e
  params \e
    disk_name=\fIstring\fR \e
  op monitor timeout="15s" interval="10s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a gcp\-pd\-move resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_gcp\-pd\-move ocf:heartbeat:gcp\-pd\-move \e
  disk_name=\fIstring\fR \e
  op monitor timeout="15s" interval="10s" OCF_CHECK_LEVEL="0" 
.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