#!/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