summaryrefslogtreecommitdiffstats
path: root/heartbeat/nvmet-subsystem
blob: a1d0cd293a13a30b5e4795bc221cbd8607b431c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
#!/bin/sh
#
#
#     NVMe-oF (rdma, tcp, fc) OCF RA. Exports and manages NVMe targets.
#
#   (c) 2021 LINBIT HA-Solutions GmbH, written by Philipp Reisner
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of version 2 of the GNU General Public License as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it would be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#
# Further, this software is distributed without any warranty that it is
# free of the rightful claim of any third person regarding infringement
# or the like.  Any license provided herein, whether implied or
# otherwise, applies only to this software file.  Patent licenses, if
# any, provided herein do not apply to combinations of this program with
# other software, or any other product whatsoever.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write the Free Software Foundation,
# Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
#

#######################################################################
# Initialization:
: ${OCF_FUNCTIONS_DIR=${OCF_ROOT}/lib/heartbeat}
. ${OCF_FUNCTIONS_DIR}/ocf-shellfuncs

OCF_RESKEY_allowed_initiators_default=""
: ${OCF_RESKEY_allowed_initiators=${OCF_RESKEY_allowed_initiators_default}}

OCF_RESKEY_serial_default=""
: ${OCF_RESKEY_serial=${OCF_RESKEY_serial_default}}
#######################################################################

meta_data() {
	cat <<END
<?xml version="1.0"?>
<!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
<resource-agent name="nvmet-subsystem" version="0.9">
<version>1.0</version>

<longdesc lang="en">
Manages NVMe-oF subsystems. An NVMe-oF subsystem is part of an NVMe-oF target.
A subsystem must be created first, before namespace(s) and port(s).
</longdesc>
<shortdesc lang="en">NVMe-oF target export agent</shortdesc>

<parameters>

<parameter name="nqn" required="1" unique="1">
<longdesc lang="en">
The NVMe Qualified Name (NQN) is used to identify the remote NVMe
storage target. It is similar to an iSCSI Qualified Name
(IQN). While it is a free-form string, you should follow the convention:
nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-12345
</longdesc>
<shortdesc lang="en">NVMe Qualified Name</shortdesc>
<content type="string" />
</parameter>

<parameter name="allowed_initiators" required="0" unique="0">
<longdesc lang="en">
Allowed initiators. A space-separated list of initiators allowed to
connect to this target. Initiators are identified by their NQN.
If the list is empty, any initiator will be allowed to connect.
</longdesc>
<shortdesc lang="en">List of NVMe initiators allowed to connect
to this target</shortdesc>
<content type="string" default="${OCF_RESKEY_allowed_initiators_default}"/>
</parameter>

<parameter name="serial" required="0" unique="0">
<longdesc lang="en">
The serial of the subsystem. Set it to a random 16 character hex
value. Use hexdump -n 8 -e '4/4 "%08x" 1 "\n"' /dev/urandom
</longdesc>
<shortdesc lang="en">List of NVMe initiators allowed to connect
to this target</shortdesc>
<content type="string" default="${OCF_RESKEY_serial_default}"/>
</parameter>

</parameters>

<actions>
<action name="start"		timeout="10s" />
<action name="stop"		 timeout="10s" />
<action name="status"	   timeout="10s" interval="10s" depth="0" />
<action name="monitor"	  timeout="10s" interval="10s" depth="0" />
<action name="meta-data"	timeout="5s" />
<action name="validate-all"   timeout="10s" />
</actions>
</resource-agent>
END
}

#######################################################################

nvmet_subsystem_usage() {
	cat <<END
usage: $0 {start|stop|status|monitor|validate-all|meta-data}

Expects to have a fully populated OCF RA-compliant environment set.
END
}

nvmet_subsystem_start() {
	nvmet_subsystem_monitor
	if [ $? =  $OCF_SUCCESS ]; then
		return $OCF_SUCCESS
	fi

	local subsys=/sys/kernel/config/nvmet/subsystems/${OCF_RESKEY_nqn}
	mkdir ${subsys}
	[ "${OCF_RESKEY_serial}" ] && echo ${OCF_RESKEY_serial} > ${subsys}/attr_serial

	if [ -z "${OCF_RESKEY_allowed_initiators}" ]; then
		echo 1 > ${subsys}/attr_allow_any_host
	else
		local hosts_dir=/sys/kernel/config/nvmet/hosts
		echo 0 > ${subsys}/attr_allow_any_host
		for hostnqn in ${OCF_RESKEY_allowed_initiators}; do
			mkdir -p ${hosts_dir}/${hostnqn}
			ln -s ${hosts_dir}/${hostnqn} ${subsys}/allowed_hosts
		done
	fi

	nvmet_subsystem_monitor
}

nvmet_subsystem_stop() {
	nvmet_subsystem_monitor
	if [ $? -eq $OCF_NOT_RUNNING ]; then
		return $OCF_SUCCESS
	fi

	rmdir /sys/kernel/config/nvmet/subsystems/${OCF_RESKEY_nqn}

	return $OCF_SUCCESS
}

nvmet_subsystem_monitor() {
	[ -d /sys/kernel/config/nvmet/subsystems/${OCF_RESKEY_nqn} ] || return $OCF_NOT_RUNNING
	return $OCF_SUCCESS
}

nvmet_subsystem_validate() {
	if [ ! -d /sys/kernel/config/nvmet ]; then
		ocf_log err "/sys/kernel/config/nvmet does not exist -- Load the nvmet.ko linux kernel module."
		exit $OCF_ERR_INSTALLED
	fi
	return $OCF_SUCCESS
}


case $1 in
  meta-data)
	meta_data
	exit $OCF_SUCCESS
	;;
  usage|help)
	nvmet_subsystem_usage
	exit $OCF_SUCCESS
	;;
esac

# Everything except usage and meta-data must pass the validate test
nvmet_subsystem_validate

case $__OCF_ACTION in
start)		nvmet_subsystem_start;;
stop)		nvmet_subsystem_stop;;
monitor|status)	nvmet_subsystem_monitor;;
reload)		ocf_log info "Reloading..."
			nvmet_subsystem_start
		;;
validate-all)	;;
*)		nvmet_subsystem_usage
		exit $OCF_ERR_UNIMPLEMENTED
		;;
esac
rc=$?
ocf_log debug "${OCF_RESOURCE_INSTANCE} $__OCF_ACTION : $rc"
exit $rc