diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 7ec1af647..a1dfe7163 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -1,228 +1,231 @@ # # doc: Linux-HA resource agents # # Copyright (C) 2009 Florian Haas # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # MAINTAINERCLEANFILES = Makefile.in EXTRA_DIST = $(doc_DATA) $(REFENTRY_STYLESHEET) \ mkappendix.sh ralist.sh CLEANFILES = $(man_MANS) $(xmlfiles) metadata-*.xml STYLESHEET_PREFIX ?= http://docbook.sourceforge.net/release/xsl/current MANPAGES_STYLESHEET ?= $(STYLESHEET_PREFIX)/manpages/docbook.xsl HTML_STYLESHEET ?= $(STYLESHEET_PREFIX)/xhtml/docbook.xsl FO_STYLESHEET ?= $(STYLESHEET_PREFIX)/fo/docbook.xsl REFENTRY_STYLESHEET ?= ra2refentry.xsl XSLTPROC_OPTIONS ?= --xinclude XSLTPROC_MANPAGES_OPTIONS ?= $(XSLTPROC_OPTIONS) XSLTPROC_HTML_OPTIONS ?= $(XSLTPROC_OPTIONS) XSLTPROC_FO_OPTIONS ?= $(XSLTPROC_OPTIONS) radir = $(top_srcdir)/heartbeat # OCF_ROOT=. is necessary due to a sanity check in ocf-shellfuncs # (which tests whether $OCF_ROOT points to a directory metadata-%.xml: $(radir)/% OCF_ROOT=. OCF_FUNCTIONS_DIR=$(radir) $< meta-data > $@ metadata-IPv6addr.xml: ../../heartbeat/IPv6addr OCF_ROOT=. OCF_FUNCTIONS_DIR=$(radir) $< meta-data > $@ # Please note: we can't name the man pages # ocf:heartbeat:. Believe me, I've tried. It looks like it # works, but then it doesn't. While make can deal correctly with # colons in target names (when properly escaped), it royally messes up # when it is deals with _dependencies_ that contain colons. See Bug # 12126 on savannah.gnu.org. But, maybe it gets fixed soon, it was # first reported in 1995 and added to Savannah in in 2005... if BUILD_DOC man_MANS = ocf_heartbeat_AoEtarget.7 \ ocf_heartbeat_AudibleAlarm.7 \ ocf_heartbeat_ClusterMon.7 \ ocf_heartbeat_CTDB.7 \ ocf_heartbeat_Delay.7 \ ocf_heartbeat_Dummy.7 \ ocf_heartbeat_EvmsSCC.7 \ ocf_heartbeat_Evmsd.7 \ ocf_heartbeat_Filesystem.7 \ ocf_heartbeat_ICP.7 \ ocf_heartbeat_IPaddr.7 \ ocf_heartbeat_IPaddr2.7 \ ocf_heartbeat_IPsrcaddr.7 \ ocf_heartbeat_LVM.7 \ ocf_heartbeat_LVM-activate.7 \ ocf_heartbeat_LinuxSCSI.7 \ ocf_heartbeat_MailTo.7 \ ocf_heartbeat_ManageRAID.7 \ ocf_heartbeat_ManageVE.7 \ ocf_heartbeat_NodeUtilization.7 \ ocf_heartbeat_Pure-FTPd.7 \ ocf_heartbeat_Raid1.7 \ ocf_heartbeat_Route.7 \ ocf_heartbeat_SAPDatabase.7 \ ocf_heartbeat_SAPInstance.7 \ ocf_heartbeat_SendArp.7 \ ocf_heartbeat_ServeRAID.7 \ ocf_heartbeat_SphinxSearchDaemon.7 \ ocf_heartbeat_Squid.7 \ ocf_heartbeat_Stateful.7 \ ocf_heartbeat_SysInfo.7 \ ocf_heartbeat_VIPArip.7 \ ocf_heartbeat_VirtualDomain.7 \ ocf_heartbeat_WAS.7 \ ocf_heartbeat_WAS6.7 \ ocf_heartbeat_WinPopup.7 \ ocf_heartbeat_Xen.7 \ ocf_heartbeat_Xinetd.7 \ ocf_heartbeat_ZFS.7 \ ocf_heartbeat_aliyun-vpc-move-ip.7 \ ocf_heartbeat_anything.7 \ ocf_heartbeat_apache.7 \ ocf_heartbeat_asterisk.7 \ ocf_heartbeat_aws-vpc-move-ip.7 \ ocf_heartbeat_aws-vpc-route53.7 \ ocf_heartbeat_awseip.7 \ ocf_heartbeat_awsvip.7 \ ocf_heartbeat_azure-lb.7 \ ocf_heartbeat_clvm.7 \ ocf_heartbeat_conntrackd.7 \ ocf_heartbeat_crypt.7 \ ocf_heartbeat_db2.7 \ ocf_heartbeat_dhcpd.7 \ ocf_heartbeat_docker.7 \ ocf_heartbeat_docker-compose.7 \ ocf_heartbeat_dovecot.7 \ ocf_heartbeat_dnsupdate.7 \ ocf_heartbeat_dummypy.7 \ ocf_heartbeat_eDir88.7 \ ocf_heartbeat_ethmonitor.7 \ ocf_heartbeat_exportfs.7 \ ocf_heartbeat_fio.7 \ ocf_heartbeat_galera.7 \ ocf_heartbeat_garbd.7 \ ocf_heartbeat_gcp-vpc-move-ip.7 \ ocf_heartbeat_iSCSILogicalUnit.7 \ ocf_heartbeat_iSCSITarget.7 \ ocf_heartbeat_iface-bridge.7 \ ocf_heartbeat_iface-vlan.7 \ ocf_heartbeat_ipsec.7 \ ocf_heartbeat_ids.7 \ ocf_heartbeat_iscsi.7 \ ocf_heartbeat_jboss.7 \ ocf_heartbeat_jira.7 \ ocf_heartbeat_kamailio.7 \ ocf_heartbeat_lvmlockd.7 \ ocf_heartbeat_lxc.7 \ ocf_heartbeat_lxd-info.7 \ ocf_heartbeat_machine-info.7 \ ocf_heartbeat_mariadb.7 \ ocf_heartbeat_mdraid.7 \ ocf_heartbeat_minio.7 \ ocf_heartbeat_mysql.7 \ ocf_heartbeat_mysql-proxy.7 \ ocf_heartbeat_nagios.7 \ ocf_heartbeat_named.7 \ ocf_heartbeat_nfsnotify.7 \ ocf_heartbeat_nfsserver.7 \ ocf_heartbeat_nginx.7 \ + ocf_heartbeat_nvmet-subsystem.7 \ + ocf_heartbeat_nvmet-namespace.7 \ + ocf_heartbeat_nvmet-port.7 \ ocf_heartbeat_openstack-info.7 \ ocf_heartbeat_openstack-cinder-volume.7 \ ocf_heartbeat_openstack-floating-ip.7 \ ocf_heartbeat_openstack-virtual-ip.7 \ ocf_heartbeat_oraasm.7 \ ocf_heartbeat_oracle.7 \ ocf_heartbeat_oralsnr.7 \ ocf_heartbeat_ovsmonitor.7 \ ocf_heartbeat_pgagent.7 \ ocf_heartbeat_pgsql.7 \ ocf_heartbeat_pingd.7 \ ocf_heartbeat_podman.7 \ ocf_heartbeat_portblock.7 \ ocf_heartbeat_postfix.7 \ ocf_heartbeat_pound.7 \ ocf_heartbeat_proftpd.7 \ ocf_heartbeat_rabbitmq-cluster.7 \ ocf_heartbeat_redis.7 \ ocf_heartbeat_rkt.7 \ ocf_heartbeat_rsyncd.7 \ ocf_heartbeat_rsyslog.7 \ ocf_heartbeat_scsi2reservation.7 \ ocf_heartbeat_sfex.7 \ ocf_heartbeat_slapd.7 \ ocf_heartbeat_smb-share.7 \ ocf_heartbeat_sybaseASE.7 \ ocf_heartbeat_sg_persist.7 \ ocf_heartbeat_mpathpersist.7 \ ocf_heartbeat_symlink.7 \ ocf_heartbeat_syslog-ng.7 \ ocf_heartbeat_tomcat.7 \ ocf_heartbeat_varnish.7 \ ocf_heartbeat_vdo-vol.7 \ ocf_heartbeat_vmware.7 \ ocf_heartbeat_vsftpd.7 \ ocf_heartbeat_zabbixserver.7 if USE_IPV6ADDR_AGENT man_MANS += ocf_heartbeat_IPv6addr.7 endif if BUILD_AZURE_EVENTS man_MANS += ocf_heartbeat_azure-events.7 endif if BUILD_GCP_PD_MOVE man_MANS += ocf_heartbeat_gcp-pd-move.7 endif if BUILD_GCP_VPC_MOVE_ROUTE man_MANS += ocf_heartbeat_gcp-vpc-move-route.7 endif if BUILD_GCP_VPC_MOVE_VIP man_MANS += ocf_heartbeat_gcp-vpc-move-vip.7 endif xmlfiles = $(man_MANS:.7=.xml) %.1 %.5 %.7 %.8: %.xml $(XSLTPROC) \ $(XSLTPROC_MANPAGES_OPTIONS) \ $(MANPAGES_STYLESHEET) $< ocf_heartbeat_%.xml: metadata-%.xml $(srcdir)/$(REFENTRY_STYLESHEET) $(XSLTPROC) --novalid \ --stringparam package $(PACKAGE_NAME) \ --stringparam version $(VERSION) \ --output $@ \ $(srcdir)/$(REFENTRY_STYLESHEET) $< ocf_resource_agents.xml: $(xmlfiles) mkappendix.sh ./mkappendix.sh $(xmlfiles) > $@ %.html: %.xml $(XSLTPROC) \ $(XSLTPROC_HTML_OPTIONS) \ --output $@ \ $(HTML_STYLESHEET) $< xml: ocf_resource_agents.xml endif diff --git a/heartbeat/Makefile.am b/heartbeat/Makefile.am index d74387584..ac8dd6f2b 100644 --- a/heartbeat/Makefile.am +++ b/heartbeat/Makefile.am @@ -1,232 +1,235 @@ # Makefile.am for OCF RAs # # Author: Sun Jing Dong # Copyright (C) 2004 IBM # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # MAINTAINERCLEANFILES = Makefile.in EXTRA_DIST = $(ocf_SCRIPTS) $(ocfcommon_DATA) \ $(common_DATA) $(hb_DATA) $(dtd_DATA) \ README README.galera AM_CPPFLAGS = -I$(top_srcdir)/include -I$(top_srcdir)/linux-ha halibdir = $(libexecdir)/heartbeat ocfdir = $(OCF_RA_DIR_PREFIX)/heartbeat dtddir = $(datadir)/$(PACKAGE_NAME) dtd_DATA = ra-api-1.dtd metadata.rng if USE_IPV6ADDR_AGENT ocf_PROGRAMS = IPv6addr else ocf_PROGRAMS = endif if IPV6ADDR_COMPATIBLE halib_PROGRAMS = send_ua else halib_PROGRAMS = endif IPv6addr_SOURCES = IPv6addr.c IPv6addr_utils.c send_ua_SOURCES = send_ua.c IPv6addr_utils.c IPv6addr_LDADD = -lplumb $(LIBNETLIBS) send_ua_LDADD = $(LIBNETLIBS) ocf_SCRIPTS = AoEtarget \ AudibleAlarm \ ClusterMon \ CTDB \ Delay \ Dummy \ EvmsSCC \ Evmsd \ Filesystem \ ICP \ IPaddr \ IPaddr2 \ IPsrcaddr \ LVM \ LinuxSCSI \ lvmlockd \ LVM-activate \ MailTo \ ManageRAID \ ManageVE \ NodeUtilization \ Pure-FTPd \ Raid1 \ Route \ SAPDatabase \ SAPInstance \ SendArp \ ServeRAID \ SphinxSearchDaemon \ Squid \ Stateful \ SysInfo \ VIPArip \ VirtualDomain \ WAS \ WAS6 \ WinPopup \ Xen \ Xinetd \ ZFS \ aliyun-vpc-move-ip \ anything \ apache \ asterisk \ aws-vpc-move-ip \ aws-vpc-route53 \ awseip \ awsvip \ azure-lb \ clvm \ conntrackd \ crypt \ db2 \ dhcpd \ dnsupdate \ dummypy \ docker \ docker-compose \ dovecot \ eDir88 \ ethmonitor \ exportfs \ fio \ galera \ garbd \ gcp-vpc-move-ip \ iSCSILogicalUnit \ iSCSITarget \ ids \ iface-bridge \ iface-vlan \ ipsec \ iscsi \ jboss \ jira \ kamailio \ lxc \ lxd-info \ machine-info \ mariadb \ mdraid \ minio \ mysql \ mysql-proxy \ nagios \ named \ nfsnotify \ nfsserver \ nginx \ + nvmet-subsystem \ + nvmet-namespace \ + nvmet-port \ openstack-cinder-volume \ openstack-floating-ip \ openstack-info \ openstack-virtual-ip \ oraasm \ oracle \ oralsnr \ ovsmonitor \ pgagent \ pgsql \ pingd \ podman \ portblock \ postfix \ pound \ proftpd \ rabbitmq-cluster \ redis \ rkt \ rsyncd \ rsyslog \ scsi2reservation \ sfex \ sg_persist \ mpathpersist \ slapd \ smb-share \ sybaseASE \ symlink \ syslog-ng \ tomcat \ varnish \ vdo-vol \ vmware \ vsftpd \ zabbixserver if BUILD_AZURE_EVENTS ocf_SCRIPTS += azure-events endif if BUILD_GCP_PD_MOVE ocf_SCRIPTS += gcp-pd-move endif if BUILD_GCP_VPC_MOVE_ROUTE ocf_SCRIPTS += gcp-vpc-move-route endif if BUILD_GCP_VPC_MOVE_VIP ocf_SCRIPTS += gcp-vpc-move-vip endif ocfcommondir = $(OCF_LIB_DIR_PREFIX)/heartbeat ocfcommon_DATA = ocf-shellfuncs \ ocf-binaries \ ocf-directories \ ocf-returncodes \ ocf-rarun \ ocf-distro \ apache-conf.sh \ http-mon.sh \ sapdb-nosha.sh \ sapdb.sh \ lvm-clvm.sh \ lvm-plain.sh \ lvm-tag.sh \ ora-common.sh \ mysql-common.sh \ nfsserver-redhat.sh \ findif.sh \ ocf.py # Legacy locations hbdir = $(sysconfdir)/ha.d hb_DATA = shellfuncs check: $(ocf_SCRIPTS:=.check) %.check: % OCF_ROOT=$(abs_srcdir) OCF_FUNCTIONS_DIR=$(abs_srcdir) ./$< meta-data | xmllint --path $(abs_srcdir) --noout --relaxng $(abs_srcdir)/metadata.rng - do_spellcheck = printf '[%s]\n' "$(agent)"; \ OCF_ROOT=$(abs_srcdir) OCF_FUNCTIONS_DIR=$(abs_srcdir) \ ./$(agent) meta-data 2>/dev/null \ | xsltproc $(top_srcdir)/make/extract_text.xsl - \ | aspell pipe list -d en_US --ignore-case \ --home-dir=$(top_srcdir)/make -p spellcheck-ignore \ | sed -n 's|^&\([^:]*\):.*|\1|p'; spellcheck: @$(foreach agent,$(ocf_SCRIPTS), $(do_spellcheck)) diff --git a/heartbeat/nvmet-namespace b/heartbeat/nvmet-namespace new file mode 100755 index 000000000..c6616a673 --- /dev/null +++ b/heartbeat/nvmet-namespace @@ -0,0 +1,205 @@ +#!/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_namespace_id_default="1" +: ${OCF_RESKEY_namespace_id=${OCF_RESKEY_namespace_id_default}} + +OCF_RESKEY_nguid_default="" +: ${OCF_RESKEY_nguid=${OCF_RESKEY_nguid_default}} +####################################################################### + +meta_data() { + cat < + + +0.9 + + +Manages NVMe-oF namespaces. An NVMe-oF namespace is part of an NVMe-oF target. +A namespace must be created after the subsystem. It is similar in concept to +the LUN of an iSCSI target. + +NVMe-oF target export agent + + + + +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 from string follow the conversion: +nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-12345 +You need to refer here to the NQN of an NVMe Subsystem your created +with the NVMeSubsystem resource agent. + +NVMe Qualified Name + + + + + +The NVMe namespace id (number). + +namespace id + + + + + +The full path to the block device or file that should be exposed through this +namesapce. + +block device full path + + + + + +The UUID that should be exposed by NVMe. Create it using uuidgen. This is +necessary that the initiators accept the Namespace from the new server +after failover. + +UUID + + + + + +NGUID stands for Namespace Globally Unique Identifier. Seems to be optional, +looks like e.g. VMWare ESXi7 uses it to identify namespaces. +Use 'uuidgen' to create it. + +NGUID + + + + + + + + + + + + + + +END +} + +####################################################################### + +nvmet_namespace_usage() { + cat < ${namespace}/device_path + echo "${OCF_RESKEY_uuid}" > ${namespace}/device_uuid + [ "${OCF_RESKEY_nguid}" ] && echo "${OCF_RESKEY_nguid}" > ${namespace}/device_nguid + echo 1 > ${namespace}/enable + + nvmet_namespace_monitor +} + +nvmet_namespace_stop() { + nvmet_namespace_monitor + if [ $? -eq $OCF_NOT_RUNNING ]; then + return $OCF_SUCCESS + fi + + rmdir ${namespace} + + return $OCF_SUCCESS +} + +nvmet_namespace_monitor() { + [ -d ${namespace} ] || return $OCF_NOT_RUNNING + return $OCF_SUCCESS +} + +nvmet_namespace_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 + subsys=/sys/kernel/config/nvmet/subsystems/${OCF_RESKEY_nqn} + namespace=${subsys}/namespaces/${OCF_RESKEY_namespace_id} + + return $OCF_SUCCESS +} + + +case $1 in + meta-data) + meta_data + exit $OCF_SUCCESS + ;; + usage|help) + nvmet_namespace_usage + exit $OCF_SUCCESS + ;; +esac + +# Everything except usage and meta-data must pass the validate test +nvmet_namespace_validate + +case $__OCF_ACTION in +start) nvmet_namespace_start;; +stop) nvmet_namespace_stop;; +monitor|status) nvmet_namespace_monitor;; +reload) ocf_log info "Reloading..." + nvmet_namespace_start + ;; +validate-all) ;; +*) nvmet_namespace_usage + exit $OCF_ERR_UNIMPLEMENTED + ;; +esac +rc=$? +ocf_log debug "${OCF_RESOURCE_INSTANCE} $__OCF_ACTION : $rc" +exit $rc diff --git a/heartbeat/nvmet-port b/heartbeat/nvmet-port new file mode 100755 index 000000000..50ee2562a --- /dev/null +++ b/heartbeat/nvmet-port @@ -0,0 +1,238 @@ +#!/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_port_id_default="0" +: ${OCF_RESKEY_port_id=${OCF_RESKEY_port_id_default}} + +OCF_RESKEY_type_default="tcp" +: ${OCF_RESKEY_type=${OCF_RESKEY_type_default}} + +OCF_RESKEY_addr_fam_default="ipv4" +: ${OCF_RESKEY_addr_fam=${OCF_RESKEY_addr_fam_default}} + +OCF_RESKEY_svcid_default="4420" +: ${OCF_RESKEY_svcid=${OCF_RESKEY_svcid_default}} +####################################################################### +meta_data() { + cat < + + +0.9 + + +Manages NVMe-oF ports. An NVMe-oF port is part of an NVMe-oF target. +A port must be created after the subsystem. It exposes one or multiple +subsystem(s) including the enclosed namespace(s) to the network. + +NVMe-oF target export agent + + + + + +The NVMe port number is a 16 bit number. + +NVMe port + + + + + +The NVMe transport type. Might be one of 'tcp', 'rdma', 'fc' or 'loop'. + +tcp or rdma + + + + + +The address family of the address. Mibht be 'ipv4', 'ipv6' or 'fc'. + +ipv4 or ipv6 + + + + + +The transport service identifier, is the TCP/IP port number of the +equivalent in the RDMA world. + +IP/RDMA port number + + + + + +The transport address, is the TCP/IP address this targets binds to +or the equivalent in the RDMA world. + +IP/RDMA/FC address + + + + + +A space-separated list of NQNs that should be exported through +this NVMe-oF-Target port. This list needs to have at least one entry. + +list of NQNs + + + + + + + + + + + + + + +END +} + +####################################################################### + +nvmet_port_usage() { + cat < ${portdir}/addr_traddr + echo ${OCF_RESKEY_type} > ${portdir}/addr_trtype + echo ${OCF_RESKEY_svcid} > ${portdir}/addr_trsvcid + echo ${OCF_RESKEY_addr_fam} > ${portdir}/addr_adrfam + + for subsystem in ${OCF_RESKEY_nqns}; do + ln -s /sys/kernel/config/nvmet/subsystems/${subsystem} \ + ${portdir}/subsystems/${subsystem} + done + + nvmet_port_monitor +} + +nvmet_port_stop() { + nvmet_port_monitor + if [ $? -eq $OCF_NOT_RUNNING ]; then + return $OCF_SUCCESS + fi + + for subsystem in ${OCF_RESKEY_nqns}; do + rm ${portdir}/subsystems/${subsystem} + done + + rmdir ${portdir} + + return $OCF_SUCCESS +} + +nvmet_port_monitor() { + [ -d ${portdir} ] || return $OCF_NOT_RUNNING + return $OCF_SUCCESS +} + +nvmet_port_validate() { + case "${OCF_RESKEY_type}" in + tcp|rdma|fc) + ;; + *) + ocf_log err "type must be tcp, rdma, or fc. OCF_RESKEY_type was set to $OCF_RESKEY_type" + exit $OCF_ERR_ARGS + ;; + esac + + case "${OCF_RESKEY_addr_fam}" in + ipv4|ipv6|fc) + ;; + *) + ocf_log err "addr_fam must be ipv4, ipv6, or fc. OCF_RESKEY_addr_fam was set to $OCF_RESKEY_addr_fam" + exit $OCF_ERR_ARGS + ;; + esac + + if [ -z "${OCF_RESKEY_nqns}" ]; then + ocf_log err "subsystems may not be empty. OCF_RESKEY_nqns was set to $OCF_RESKEY_nqns" + exit $OCF_ERR_ARGS + fi + + 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 + portdir=/sys/kernel/config/nvmet/ports/${OCF_RESKEY_port_id} + + return $OCF_SUCCESS +} + + +case $1 in + meta-data) + meta_data + exit $OCF_SUCCESS + ;; + usage|help) + nvmet_port_usage + exit $OCF_SUCCESS + ;; +esac + +# Everything except usage and meta-data must pass the validate test +nvmet_port_validate + +case $__OCF_ACTION in +start) nvmet_port_start;; +stop) nvmet_port_stop;; +monitor|status) nvmet_port_monitor;; +reload) ocf_log info "Reloading..." + nvmet_port_start + ;; +validate-all) ;; +*) nvmet_port_usage + exit $OCF_ERR_UNIMPLEMENTED + ;; +esac +rc=$? +ocf_log debug "${OCF_RESOURCE_INSTANCE} $__OCF_ACTION : $rc" +exit $rc diff --git a/heartbeat/nvmet-subsystem b/heartbeat/nvmet-subsystem new file mode 100755 index 000000000..217858687 --- /dev/null +++ b/heartbeat/nvmet-subsystem @@ -0,0 +1,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 < + + +0.9 + + +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). + +NVMe-oF target export agent + + + + + +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 from string follow the conversion: +nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-12345 + +NVMe Qualified Name + + + + + +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. + +List of NVMe initiators allowed to connect +to this target + + + + + +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 + +List of NVMe initiators allowed to connect +to this target + + + + + + + + + + + + + + +END +} + +####################################################################### + +nvmet_subsystem_usage() { + cat < ${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