Merging upstream version 2.4.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
50f6a45557
commit
c2a4b9519f
GPG key ID:
FBB4F0E80A80222F
35 changed files with 364 additions and 122 deletions
|
|
@ -48,7 +48,7 @@ jobs:
|
|||
# https://github.com/docker/metadata-action
|
||||
- name: Extract Docker metadata
|
||||
id: meta
|
||||
uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934
|
||||
uses: docker/metadata-action@dbef88086f6cef02e264edb7dbf63250c17cef6c
|
||||
with:
|
||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||
|
||||
36
.github/workflows/meson-test.yml
vendored
36
.github/workflows/meson-test.yml
vendored
|
|
@ -10,26 +10,33 @@ on:
|
|||
|
||||
jobs:
|
||||
meson-build:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-24.04
|
||||
steps:
|
||||
- name: "CHECKOUT: nvme-stas"
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: "INSTALL: Overall dependencies"
|
||||
- name: "INSTALL: build packages"
|
||||
run: |
|
||||
sudo apt update
|
||||
sudo apt-get install --yes --quiet python3-pip cmake iproute2
|
||||
sudo python3 -m pip install --upgrade pip
|
||||
sudo python3 -m pip install --upgrade wheel meson ninja
|
||||
sudo apt-get install --yes --quiet meson ninja-build cmake
|
||||
|
||||
- name: "INSTALL: nvme-stas dependencies"
|
||||
- name: "INSTALL: python packages"
|
||||
run: |
|
||||
sudo apt-get install --yes --quiet docbook-xml docbook-xsl xsltproc libglib2.0-dev libgirepository1.0-dev libsystemd-dev
|
||||
sudo apt-get install --yes --quiet python3-systemd python3-pyudev python3-lxml
|
||||
python3 -m pip install --upgrade dasbus pylint==2.17.7 pyflakes PyGObject
|
||||
python3 -m pip install --upgrade vermin pyfakefs importlib-resources
|
||||
sudo apt-get install --yes --quiet python3-pip python3-wheel pylint pyflakes3 python3-systemd python3-pyudev python3-lxml python3-dasbus python3-gi python3-importlib-resources python3-pyfakefs
|
||||
|
||||
- name: "INSTALL: libnvme dependencies"
|
||||
- name: "INSTALL: documentation packages"
|
||||
run: |
|
||||
sudo apt-get install --yes --quiet docbook-xml docbook-xsl xsltproc
|
||||
|
||||
- name: "INSTALL: remaining debian packages"
|
||||
run: |
|
||||
sudo apt-get install --yes --quiet iproute2 libglib2.0-dev libgirepository1.0-dev libsystemd-dev
|
||||
|
||||
- name: "INSTALL: pip packages"
|
||||
run: |
|
||||
pip install vermin
|
||||
|
||||
- name: "INSTALL: libnvme packages (needed to build libnvme)"
|
||||
run: |
|
||||
sudo apt-get install --yes --quiet swig libjson-c-dev
|
||||
|
||||
|
|
@ -46,7 +53,7 @@ jobs:
|
|||
options: --print-errorlogs --suite nvme-stas
|
||||
|
||||
# Preserve meson's log file on failure
|
||||
- uses: actions/upload-artifact@v3
|
||||
- uses: actions/upload-artifact@v4
|
||||
if: failure()
|
||||
with:
|
||||
name: "Linux_Meson_Testlog"
|
||||
|
|
@ -54,12 +61,11 @@ jobs:
|
|||
|
||||
- name: "Generate coverage report"
|
||||
run: |
|
||||
python3 -m pip install --upgrade pytest
|
||||
python3 -m pip install --upgrade pytest-cov
|
||||
sudo apt-get install python3-pytest python3-pytest-cov
|
||||
echo $( pwd )
|
||||
cp -r .build/staslib/* ./staslib/.
|
||||
pytest --cov=./staslib --cov-report=xml test/test-*.py
|
||||
|
||||
- uses: codecov/codecov-action@v3
|
||||
- uses: codecov/codecov-action@v5
|
||||
with:
|
||||
fail_ci_if_error: false
|
||||
|
|
|
|||
102
.github/workflows/pylint.yml
vendored
102
.github/workflows/pylint.yml
vendored
|
|
@ -20,29 +20,47 @@ jobs:
|
|||
recursive: true
|
||||
ignore: DL3041
|
||||
|
||||
python-lint:
|
||||
python-black:
|
||||
if: ${{ !github.event.act }} # skip during local actions testing
|
||||
name: python-black formatter
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: "CHECKOUT: nvme-stas"
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: "BLACK"
|
||||
uses: psf/black@25.1.0
|
||||
with:
|
||||
options: "--check --diff --color --line-length 120 --skip-string-normalization --extend-exclude (subprojects|debian|.build)"
|
||||
src: "."
|
||||
|
||||
python-lint-Jammy:
|
||||
runs-on: ubuntu-22.04
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
python-version: ["3.7", "3.8", "3.9", "3.10"]
|
||||
python-version: ["3.9", "3.10"]
|
||||
|
||||
steps:
|
||||
- name: "CHECKOUT: nvme-stas"
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v4
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: "INSTALL: additional packages"
|
||||
- name: "INSTALL: apt-get packages"
|
||||
run: |
|
||||
sudo apt update
|
||||
sudo apt-get install --yes --quiet python3-pip cmake libgirepository1.0-dev libsystemd-dev python3-systemd swig libjson-c-dev || true
|
||||
sudo python3 -m pip install --upgrade pip wheel meson ninja
|
||||
python3 -m pip install --upgrade dasbus pylint==2.17.7 pyflakes PyGObject lxml pyudev
|
||||
sudo apt-get install --yes --quiet meson ninja-build cmake libgirepository1.0-dev libsystemd-dev swig libjson-c-dev
|
||||
sudo apt-get install --yes --quiet python3-wheel python3-systemd python3-pyudev python3-dasbus python3-gi python3-lxml pyflakes3 python3-tomli
|
||||
|
||||
- name: "INSTALL: pip packages"
|
||||
run: |
|
||||
pip install pylint
|
||||
# pip install PyGObject
|
||||
|
||||
- name: "BUILD: [libnvme, nvme-stas]"
|
||||
uses: BSFishy/meson-build@v1.0.3
|
||||
|
|
@ -60,28 +78,70 @@ jobs:
|
|||
echo -e "Build Directory:\n$(ls -laF .build)"
|
||||
python3 -VV
|
||||
python3 -m site
|
||||
python3 -m pylint --version
|
||||
echo "pyflakes $(python3 -m pyflakes --version)"
|
||||
pylint --version
|
||||
echo "pyflakes3 $(pyflakes3 --version)"
|
||||
|
||||
- name: Pylint
|
||||
run: |
|
||||
python3 -m pylint -j 0 --rcfile=test/pylint.rc .build/stacctl .build/stacd .build/stafctl .build/stafd .build/stasadm .build/staslib
|
||||
#- name: Pylint
|
||||
# run: |
|
||||
# pylint --rcfile=test/pylint.rc .build/stacctl .build/stacd .build/stafctl .build/stafd .build/stasadm .build/staslib
|
||||
|
||||
- name: Pyflakes
|
||||
if: always()
|
||||
run: |
|
||||
python3 -m pyflakes .build/stacctl .build/stacd .build/stafctl .build/stafd .build/stasadm .build/staslib
|
||||
pyflakes3 .build/stacctl .build/stacd .build/stafctl .build/stafd .build/stasadm .build/staslib
|
||||
|
||||
python-lint-Noble:
|
||||
runs-on: ubuntu-24.04
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
python-version: ["3.11", "3.12", "3.13"]
|
||||
|
||||
python-black:
|
||||
if: ${{ !github.event.act }} # skip during local actions testing
|
||||
name: python-black formatter
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: "CHECKOUT: nvme-stas"
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: "BLACK"
|
||||
uses: psf/black@stable
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v5.3.0
|
||||
with:
|
||||
options: "--check --diff --color --line-length 120 --skip-string-normalization --extend-exclude (subprojects|debian|.build)"
|
||||
src: "."
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: "INSTALL: apt-get packages"
|
||||
run: |
|
||||
sudo apt update
|
||||
sudo apt-get install --yes --quiet meson ninja-build cmake libgirepository1.0-dev libsystemd-dev swig libjson-c-dev
|
||||
sudo apt-get install --yes --quiet python3-wheel python3-systemd python3-pyudev python3-dasbus python3-gi python3-lxml pylint pyflakes3 python3-tomli
|
||||
|
||||
#- name: "INSTALL: pip packages"
|
||||
# run: |
|
||||
# pip install pylint
|
||||
# pip install PyGObject
|
||||
|
||||
- name: "BUILD: [libnvme, nvme-stas]"
|
||||
uses: BSFishy/meson-build@v1.0.3
|
||||
with:
|
||||
action: build
|
||||
directory: .build
|
||||
setup-options: --buildtype=release --sysconfdir=/etc --prefix=/usr -Dlibnvme:buildtype=release -Dlibnvme:sysconfdir=/etc -Dlibnvme:prefix=/usr -Dlibnvme:python=enabled -Dlibnvme:libdbus=disabled -Dlibnvme:openssl=disabled -Dlibnvme:json-c=disabled -Dlibnvme:keyutils=disabled
|
||||
|
||||
- name: Set PYTHONPATH
|
||||
run: |
|
||||
echo "PYTHONPATH=.build:.build/subprojects/libnvme:/usr/lib/python3/dist-packages" >> $GITHUB_ENV
|
||||
|
||||
- name: Show test environment
|
||||
run: |
|
||||
echo -e "Build Directory:\n$(ls -laF .build)"
|
||||
python3 -VV
|
||||
python3 -m site
|
||||
pylint --version
|
||||
echo "pyflakes3 $(pyflakes3 --version)"
|
||||
|
||||
- name: Pylint
|
||||
run: |
|
||||
pylint --jobs=0 --rcfile=test/pylint.rc .build/stacctl .build/stacd .build/stafctl .build/stafd .build/stasadm .build/staslib
|
||||
|
||||
- name: Pyflakes
|
||||
if: always()
|
||||
run: |
|
||||
pyflakes3 .build/stacctl .build/stacd .build/stafctl .build/stafd .build/stasadm .build/staslib
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ build:
|
|||
- pandoc
|
||||
jobs:
|
||||
post_install:
|
||||
- pip3 install lxml
|
||||
- pip install lxml
|
||||
pre_build:
|
||||
- meson .build -Dreadthedocs=true || cat .build/meson-logs/meson-log.txt
|
||||
- ninja -C .build
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
FROM fedora:39
|
||||
FROM fedora:41
|
||||
|
||||
WORKDIR /root
|
||||
|
||||
|
|
|
|||
6
Makefile
6
Makefile
|
|
@ -38,6 +38,7 @@ endif
|
|||
purge:
|
||||
ifneq ("$(wildcard ${BUILD-DIR})","")
|
||||
rm -rf ${BUILD-DIR}
|
||||
meson subprojects purge --confirm
|
||||
endif
|
||||
|
||||
.PHONY: install
|
||||
|
|
@ -46,7 +47,8 @@ install: stas
|
|||
|
||||
.PHONY: uninstall
|
||||
uninstall: ${BUILD-DIR}
|
||||
sudo ninja $@ -C ${BUILD-DIR}
|
||||
cd ${BUILD-DIR} && sudo meson --internal uninstall
|
||||
|
||||
|
||||
.PHONY: dist
|
||||
dist: stas
|
||||
|
|
@ -70,7 +72,7 @@ black:
|
|||
black --diff --color --line-length 120 --skip-string-normalization --extend-exclude="(subprojects|debian|.build)" .
|
||||
|
||||
# Coverage requirements:
|
||||
# pip install coverage
|
||||
# apt-get install python3-coverage
|
||||
.PHONY: coverage
|
||||
coverage: stas
|
||||
cd ${BUILD-DIR} && ./coverage.sh
|
||||
|
|
|
|||
10
NEWS.md
10
NEWS.md
|
|
@ -1,5 +1,15 @@
|
|||
# STorage Appliance Services (STAS)
|
||||
|
||||
## Changes with release 2.4
|
||||
|
||||
New features:
|
||||
|
||||
Support for authentication
|
||||
|
||||
Bug fix:
|
||||
|
||||
* Various fixes related to unit testing and GitHub Actions
|
||||
|
||||
## Changes with release 2.3.1
|
||||
|
||||
Bug fix:
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ The following packages must be installed to use **`stafd`**/**`stacd`**
|
|||
sudo apt-get install -y python3-pyudev python3-systemd python3-gi
|
||||
sudo apt-get install -y python3-dasbus # Ubuntu 22.04
|
||||
OR:
|
||||
sudo pip3 install dasbus # Ubuntu 20.04
|
||||
sudo pip install dasbus # Ubuntu 20.04 (may require --break-system-packages)
|
||||
```
|
||||
|
||||
**RPM packages (tested on Fedora 34..35 and SLES15):**
|
||||
|
|
|
|||
|
|
@ -184,7 +184,7 @@ $ sudo ./nvmet.py clean
|
|||
This requires the [Python coverage package](https://coverage.readthedocs.io/en/6.4.1/), which can be installed as follows:
|
||||
|
||||
```bash
|
||||
$ sudo pip install coverage
|
||||
$ sudo apt-get install python3-coverage
|
||||
```
|
||||
|
||||
Note that this test cannot be run while `stafd` and `stacd` are running. Make sure to stop `stafd` and `stacd` if they are running (`systemctl stop [stafd|stacd]`). You may also need to mask those services (`systemctl mask [stafd|stacd]`) if coverage fails to start.
|
||||
|
|
|
|||
|
|
@ -377,7 +377,7 @@ persistent-connections = false
|
|||
zeroconf-connections-persistence = 1:01
|
||||
|
||||
[Controllers]
|
||||
controller = transport = tcp ; traddr = localhost ; ; ; kato=31; dhchap-ctrl-secret=not-so-secret
|
||||
controller = transport = tcp ; traddr = localhost ; ; ; kato=31; dhchap-ctrl-secret=DHHC-1:00:not-so-secret/not-so-secret/not-so-secret/not-so: ; dhchap-secret=DHHC-1:00:very-secret/very-secret/very-secret/very-secret/:
|
||||
controller=transport=tcp;traddr=1.1.1.1
|
||||
controller=transport=tcp;traddr=100.100.100.100
|
||||
controller=transport=tcp;traddr=2607:f8b0:4002:c2c::71
|
||||
|
|
|
|||
|
|
@ -376,6 +376,21 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry id='dhchap-secret'>
|
||||
<term><varname>dhchap-secret=</varname></term>
|
||||
<listitem>
|
||||
<para>
|
||||
NVMe In-band authentication host secret (i.e. key);
|
||||
needs to be in ASCII format as specified in NVMe 2.0
|
||||
section 8.13.5.8 Secret representation. If this
|
||||
option is not specified, the default is read
|
||||
from /etc/stas/sys.conf (see the 'key' parameter
|
||||
under the [Host] section). In-band authentication
|
||||
is attempted when this is present.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry id='dhchap-ctrl-secret'>
|
||||
<term><varname>dhchap-ctrl-secret=</varname></term>
|
||||
<listitem>
|
||||
|
|
|
|||
|
|
@ -235,6 +235,14 @@
|
|||
# This forces the connection to be made on a specific interface
|
||||
# instead of letting the system decide.
|
||||
#
|
||||
# dhchap-secret [OPTIONAL]
|
||||
# NVMe In-band authentication host secret (i.e. key); needs to be
|
||||
# in ASCII format as specified in NVMe 2.0 section 8.13.5.8 Secret
|
||||
# representation. If this option is not specified, the default is
|
||||
# read from /etc/stas/sys.conf (see the 'key' parameter under the
|
||||
# [Host] section). In-band authentication is attempted when this
|
||||
# is present.
|
||||
#
|
||||
# dhchap-ctrl-secret [OPTIONAL]
|
||||
# NVMe In-band authentication controller secret (i.e. key) for
|
||||
# bi-directional authentication; needs to be in ASCII format as
|
||||
|
|
|
|||
14
meson.build
14
meson.build
|
|
@ -9,7 +9,7 @@
|
|||
project(
|
||||
'nvme-stas',
|
||||
meson_version: '>= 0.53.0',
|
||||
version: '2.3.1',
|
||||
version: '2.4',
|
||||
license: 'Apache-2.0',
|
||||
default_options: [
|
||||
'buildtype=release',
|
||||
|
|
@ -39,7 +39,13 @@ if want_man or want_html or want_readthedocs
|
|||
buildtime_modules += ['lxml']
|
||||
endif
|
||||
|
||||
python3 = import('python').find_installation('python3', modules:buildtime_modules)
|
||||
# On older systems we had to invoke Python 3 as "python3". On newer systems,
|
||||
# Python 2 has been completely deprecated and Python 3 is simply named "python".
|
||||
pymod = import('python')
|
||||
python3 = pymod.find_installation('python3', modules:buildtime_modules, required:false)
|
||||
if not python3.found()
|
||||
python3 = pymod.find_installation('python', modules:buildtime_modules)
|
||||
endif
|
||||
python_version = python3.language_version()
|
||||
python_version_req = '>=3.6'
|
||||
if not python_version.version_compare(python_version_req)
|
||||
|
|
@ -51,7 +57,7 @@ endif
|
|||
missing_runtime_mods = false
|
||||
py_modules_reqd = [
|
||||
['libnvme', 'Install python3-libnvme (deb/rpm)'],
|
||||
['dasbus', 'Install python3-dasbus (deb/rpm) OR pip3 install dasbus'],
|
||||
['dasbus', 'Install python3-dasbus (deb/rpm) OR pip install dasbus'],
|
||||
['pyudev', 'Install python3-pyudev (deb/rpm)'],
|
||||
['systemd', 'Install python3-systemd (deb/rpm)'],
|
||||
['gi', 'Install python3-gi (deb) OR python3-gobject (rpm)'],
|
||||
|
|
@ -165,7 +171,7 @@ summary_dict = {
|
|||
'dbus_conf_dir ': dbus_conf_dir,
|
||||
'sd_unit_dir ': sd_unit_dir,
|
||||
'build location ': meson.current_build_dir(),
|
||||
'libnvme for tests ': libnvme_location,
|
||||
'libnvme location ': libnvme_location,
|
||||
}
|
||||
summary(summary_dict, section: 'Directories')
|
||||
|
||||
|
|
|
|||
|
|
@ -7,8 +7,7 @@
|
|||
#
|
||||
# Authors: Martin Belanger <Martin.Belanger@dell.com>
|
||||
#
|
||||
''' STorage Appliance Connector Control Utility
|
||||
'''
|
||||
'''STorage Appliance Connector Control Utility'''
|
||||
import sys
|
||||
import json
|
||||
import pprint
|
||||
|
|
|
|||
3
stacd.py
3
stacd.py
|
|
@ -7,8 +7,7 @@
|
|||
#
|
||||
# Authors: Martin Belanger <Martin.Belanger@dell.com>
|
||||
#
|
||||
''' STorage Appliance Connector Daemon
|
||||
'''
|
||||
'''STorage Appliance Connector Daemon'''
|
||||
import sys
|
||||
from argparse import ArgumentParser
|
||||
from staslib import defs
|
||||
|
|
|
|||
|
|
@ -7,8 +7,7 @@
|
|||
#
|
||||
# Authors: Martin Belanger <Martin.Belanger@dell.com>
|
||||
#
|
||||
''' STorage Appliance Finder Control Utility
|
||||
'''
|
||||
'''STorage Appliance Finder Control Utility'''
|
||||
import sys
|
||||
import json
|
||||
import pprint
|
||||
|
|
|
|||
3
stafd.py
3
stafd.py
|
|
@ -7,8 +7,7 @@
|
|||
#
|
||||
# Authors: Martin Belanger <Martin.Belanger@dell.com>
|
||||
#
|
||||
''' STorage Appliance Finder Daemon
|
||||
'''
|
||||
'''STorage Appliance Finder Daemon'''
|
||||
import sys
|
||||
from argparse import ArgumentParser
|
||||
from staslib import defs
|
||||
|
|
|
|||
|
|
@ -167,9 +167,11 @@ class Service: # pylint: disable=too-many-instance-attributes
|
|||
'trsvcid': trsvcid,
|
||||
# host-iface permitted for tcp alone and not rdma
|
||||
'host-iface': host_iface,
|
||||
'subsysnqn': txt.get('nqn', defs.WELL_KNOWN_DISC_NQN).strip()
|
||||
'subsysnqn': (
|
||||
txt.get('nqn', defs.WELL_KNOWN_DISC_NQN).strip()
|
||||
if conf.NvmeOptions().discovery_supp
|
||||
else defs.WELL_KNOWN_DISC_NQN,
|
||||
else defs.WELL_KNOWN_DISC_NQN
|
||||
),
|
||||
}
|
||||
|
||||
self._ip = iputil.get_ipaddress_obj(traddr, ipv4_mapped_convert=True)
|
||||
|
|
|
|||
|
|
@ -289,8 +289,6 @@ class SvcConf(metaclass=singleton.Singleton): # pylint: disable=too-many-public
|
|||
nr_write_queues = property(functools.partial(get_option, section='Global', option='nr-write-queues'))
|
||||
reconnect_delay = property(functools.partial(get_option, section='Global', option='reconnect-delay'))
|
||||
|
||||
zeroconf_enabled = property(functools.partial(get_option, section='Service Discovery', option='zeroconf'))
|
||||
|
||||
zeroconf_persistence_sec = property(
|
||||
functools.partial(
|
||||
get_option, section='Discovery controller connection management', option='zeroconf-connections-persistence'
|
||||
|
|
@ -307,6 +305,11 @@ class SvcConf(metaclass=singleton.Singleton): # pylint: disable=too-many-public
|
|||
functools.partial(get_option, section='I/O controller connection management', option='connect-attempts-on-ncc')
|
||||
)
|
||||
|
||||
@property # pylint chokes on this when defined as zeroconf_enabled=property(...). Works fine using a decorator...
|
||||
def zeroconf_enabled(self):
|
||||
'''Return whether zeroconf is enabled'''
|
||||
return self.get_option(section='Service Discovery', option='zeroconf')
|
||||
|
||||
@property
|
||||
def stypes(self):
|
||||
'''@brief Get the DNS-SD/mDNS service types.'''
|
||||
|
|
@ -338,6 +341,7 @@ class SvcConf(metaclass=singleton.Singleton): # pylint: disable=too-many-public
|
|||
'host-traddr': [TRADDR],
|
||||
'host-iface': [IFACE],
|
||||
'host-nqn': [NQN],
|
||||
'dhchap-secret': [KEY],
|
||||
'dhchap-ctrl-secret': [KEY],
|
||||
'hdr-digest': [BOOL]
|
||||
'data-digest': [BOOL]
|
||||
|
|
@ -707,7 +711,7 @@ class NvmeOptions(metaclass=singleton.Singleton):
|
|||
|
||||
|
||||
# ******************************************************************************
|
||||
class NbftConf(metaclass=singleton.Singleton):
|
||||
class NbftConf(metaclass=singleton.Singleton): # pylint: disable=too-few-public-methods
|
||||
'''Read and cache configuration file.'''
|
||||
|
||||
def __init__(self, root_dir=defs.NBFT_SYSFS_PATH):
|
||||
|
|
|
|||
|
|
@ -221,23 +221,39 @@ class Controller(stas.ControllerABC): # pylint: disable=too-many-instance-attri
|
|||
host_traddr=self.tid.host_traddr if self.tid.host_traddr else None,
|
||||
host_iface=host_iface,
|
||||
)
|
||||
self._ctrl.discovery_ctrl_set(self._discovery_ctrl)
|
||||
self._ctrl.discovery_ctrl = self._discovery_ctrl
|
||||
|
||||
# Set the DHCHAP key on the controller
|
||||
# NOTE that this will eventually have to
|
||||
# Set the DHCHAP host key on the controller
|
||||
# NOTE that this may eventually have to
|
||||
# change once we have support for AVE (TP8019)
|
||||
ctrl_dhchap_key = self.tid.cfg.get('dhchap-ctrl-secret')
|
||||
if ctrl_dhchap_key and self._nvme_options.dhchap_ctrlkey_supp:
|
||||
has_dhchap_key = hasattr(self._ctrl, 'dhchap_key')
|
||||
if not has_dhchap_key:
|
||||
# This is used for in-band authentication
|
||||
dhchap_host_key = self.tid.cfg.get('dhchap-secret')
|
||||
if dhchap_host_key and self._nvme_options.dhchap_hostkey_supp:
|
||||
try:
|
||||
self._ctrl.dhchap_host_key = dhchap_host_key
|
||||
except AttributeError:
|
||||
logging.warning(
|
||||
'%s | %s - libnvme-%s does not allow setting the controller DHCHAP key. Please upgrade libnvme.',
|
||||
'%s | %s - libnvme-%s does not allow setting the host DHCHAP key on the controller. Please upgrade libnvme.',
|
||||
self.id,
|
||||
self.device,
|
||||
defs.LIBNVME_VERSION,
|
||||
)
|
||||
|
||||
# Set the DHCHAP controller key on the controller
|
||||
# NOTE that this may eventually have to
|
||||
# change once we have support for AVE (TP8019)
|
||||
# This is used for bidirectional authentication
|
||||
dhchap_ctrl_key = self.tid.cfg.get('dhchap-ctrl-secret')
|
||||
if dhchap_ctrl_key and self._nvme_options.dhchap_ctrlkey_supp:
|
||||
try:
|
||||
self._ctrl.dhchap_key = dhchap_ctrl_key
|
||||
except AttributeError:
|
||||
logging.warning(
|
||||
'%s | %s - libnvme-%s does not allow setting the controller DHCHAP key on the controller. Please upgrade libnvme.',
|
||||
self.id,
|
||||
self.device,
|
||||
defs.LIBNVME_VERSION,
|
||||
)
|
||||
else:
|
||||
self._ctrl.dhchap_key = ctrl_dhchap_key
|
||||
|
||||
# Audit existing nvme devices. If we find a match, then
|
||||
# we'll just borrow that device instead of creating a new one.
|
||||
|
|
|
|||
|
|
@ -6,8 +6,7 @@
|
|||
#
|
||||
# Authors: Martin Belanger <Martin.Belanger@dell.com>
|
||||
|
||||
''' @brief This file gets automagically configured by meson at build time.
|
||||
'''
|
||||
'''@brief This file gets automagically configured by meson at build time.'''
|
||||
import os
|
||||
import sys
|
||||
import shutil
|
||||
|
|
|
|||
|
|
@ -123,7 +123,7 @@ class NameResolver: # pylint: disable=too-few-public-methods
|
|||
The callback @callback will be called once all hostnames have
|
||||
been resolved.
|
||||
|
||||
@param controllers: List of trid.TID
|
||||
@param controllers_in: List of trid.TID
|
||||
'''
|
||||
pending_resolution_count = 0
|
||||
controllers_out = []
|
||||
|
|
|
|||
|
|
@ -510,7 +510,7 @@ class Stac(Service):
|
|||
UDEV_RULE_OVERRIDE = r'''
|
||||
ACTION=="change", SUBSYSTEM=="fc", ENV{FC_EVENT}=="nvmediscovery", \
|
||||
ENV{NVMEFC_HOST_TRADDR}=="*", ENV{NVMEFC_TRADDR}=="*", \
|
||||
RUN+="%s --no-block start nvmf-connect@--transport=fc\t--traddr=$env{NVMEFC_TRADDR}\t--trsvcid=none\t--host-traddr=$env{NVMEFC_HOST_TRADDR}.service"
|
||||
RUN+="%s --no-block restart nvmf-connect@--device\x3dnone\x09--transport\x3dfc\x09--traddr\x3d$env{NVMEFC_TRADDR}\x09--trsvcid\x3dnone\x09--host-traddr\x3d$env{NVMEFC_HOST_TRADDR}.service"
|
||||
'''
|
||||
|
||||
|
||||
|
|
@ -809,11 +809,7 @@ class Staf(Service):
|
|||
origin = (
|
||||
'configured'
|
||||
if tid in configured_ctrl_list
|
||||
else 'referral'
|
||||
if tid in referral_ctrl_list
|
||||
else 'discovered'
|
||||
if tid in discovered_ctrl_list
|
||||
else None
|
||||
else 'referral' if tid in referral_ctrl_list else 'discovered' if tid in discovered_ctrl_list else None
|
||||
)
|
||||
if origin is not None:
|
||||
controller.origin = origin
|
||||
|
|
@ -868,10 +864,12 @@ class Staf(Service):
|
|||
return
|
||||
|
||||
# We need to invoke "nvme connect-all" using nvme-cli's nvmf-connect@.service
|
||||
# NOTE: Eventually, we'll be able to drop --host-traddr and --host-iface from
|
||||
# NOTE 1: Eventually, we'll be able to drop --host-traddr and --host-iface from
|
||||
# the parameters passed to nvmf-connect@.service. A fix was added to connect-all
|
||||
# to infer these two values from the device used to connect to the DC.
|
||||
# Ref: https://github.com/linux-nvme/nvme-cli/pull/1812
|
||||
#
|
||||
# NOTE 2:--transport, --traddr, and --trsvcid, not needed when using --device
|
||||
cnf = [
|
||||
('--device', udev_obj.sys_name),
|
||||
('--host-traddr', udev_obj.properties.get('NVME_HOST_TRADDR', None)),
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ class TID: # pylint: disable=too-many-instance-attributes
|
|||
'host-nqn': str, # [optional]
|
||||
|
||||
# Connection parameters
|
||||
'dhchap-secret': str, # [optional]
|
||||
'dhchap-ctrl-secret': str, # [optional]
|
||||
'hdr-digest': str, # [optional]
|
||||
'data-digest': str, # [optional]
|
||||
|
|
|
|||
|
|
@ -9,6 +9,8 @@
|
|||
|
||||
srce_dir = meson.current_source_dir()
|
||||
test_env = environment({'MALLOC_PERTURB_': '0'})
|
||||
test_env.append('PYTHONMALLOC', 'malloc')
|
||||
test_list = modules_to_lint + packages_to_lint
|
||||
|
||||
libnvme_location = '?'
|
||||
|
||||
|
|
@ -23,9 +25,9 @@ if get_option('libnvme-sel') == 'pre-installed'
|
|||
rr = run_command(python3, '-c', 'import libnvme; print(f"{libnvme.__path__[0]}")', check: false, env: test_env)
|
||||
if rr.returncode() == 0
|
||||
libnvme_location = rr.stdout().strip()
|
||||
pythonpath = fs.parent(libnvme_location)
|
||||
test_env.prepend('PYTHONPATH', pythonpath) # Look in standard location first
|
||||
test_env.append('PYTHONPATH', PYTHONPATH) # Look in the build directory second
|
||||
libnvme_path = fs.parent(libnvme_location)
|
||||
PYTHONPATH = ':'.join([libnvme_path, PYTHONPATH])
|
||||
test_env.prepend('PYTHONPATH', PYTHONPATH)
|
||||
endif
|
||||
endif
|
||||
|
||||
|
|
@ -46,13 +48,7 @@ if libnvme_location == '?'
|
|||
else
|
||||
#---------------------------------------------------------------------------
|
||||
# pylint and pyflakes
|
||||
|
||||
# There's a bug with pylint 3.X. Tests should be run with pylint
|
||||
# 2.17.7 (or less), which can be installed with:
|
||||
# python3 -m pip install --upgrade pylint==2.17.7
|
||||
|
||||
|
||||
if modules_to_lint.length() != 0
|
||||
if test_list.length() != 0
|
||||
pylint = find_program('pylint', required: false)
|
||||
pyflakes = find_program('pyflakes3', required: false)
|
||||
if not pyflakes.found()
|
||||
|
|
@ -65,12 +61,12 @@ else
|
|||
rcfile = srce_dir / 'pylint.rc'
|
||||
|
||||
if pylint.found()
|
||||
test('pylint', pylint, args: ['--rcfile=' + rcfile] + modules_to_lint + packages_to_lint, env: test_env)
|
||||
test('pylint', pylint, args: ['--rcfile=' + rcfile] + test_list, env: test_env)
|
||||
else
|
||||
warning('Skiping some of the tests because "pylint" is missing.')
|
||||
endif
|
||||
if pyflakes.found()
|
||||
test('pyflakes', pyflakes, args: modules_to_lint, env: test_env)
|
||||
test('pyflakes', pyflakes, args: test_list, env: test_env)
|
||||
else
|
||||
warning('Skiping some of the tests because "pyflakes" is missing.')
|
||||
endif
|
||||
|
|
@ -156,8 +152,8 @@ tools = [
|
|||
]
|
||||
vermin = find_program('vermin', required: false)
|
||||
if vermin.found()
|
||||
if modules_to_lint.length() != 0
|
||||
test('vermin code', vermin, args: ['--config-file', srce_dir / 'vermin.conf'] + modules_to_lint, env: test_env)
|
||||
if test_list.length() != 0
|
||||
test('vermin code', vermin, args: ['--config-file', srce_dir / 'vermin.conf'] + test_list, env: test_env)
|
||||
endif
|
||||
test('vermin tools', vermin, args: ['--config-file', srce_dir / 'vermin-tools.conf'] + tools, env: test_env)
|
||||
else
|
||||
|
|
|
|||
|
|
@ -43,11 +43,40 @@ class Test(unittest.TestCase):
|
|||
self.assertEqual('', iputil.get_interface(ifaces, ''))
|
||||
self.assertEqual('', iputil.get_interface(ifaces, None))
|
||||
|
||||
@staticmethod
|
||||
def _is_ok_for_mac2iface(iface) -> bool:
|
||||
'''mac2iface can only work with interfaces that have a proper MAC
|
||||
address. One can use this function to filter out other interfaces
|
||||
configured on the system.'''
|
||||
if iface['link_type'] != 'ether':
|
||||
# Some esoteric interface types (e.g., gre) use the address
|
||||
# field to store something that is not a MAC address. Skip
|
||||
# them.
|
||||
return False
|
||||
if 'address' not in iface:
|
||||
return False
|
||||
if iface['address'] == '00:00:00:00:00:00':
|
||||
# All 0's is an invalid MAC address so do not bother.
|
||||
# In practice, it often appears as the address of the loopback
|
||||
# interface but it can also appear for other things like a gretap
|
||||
# or erspan interface.
|
||||
return False
|
||||
return True
|
||||
|
||||
def test_mac2iface(self):
|
||||
for iface in self.ifaces:
|
||||
address = iface.get('address', None)
|
||||
if address:
|
||||
self.assertEqual(iface['ifname'], iputil.mac2iface(address))
|
||||
# We only test the interfaces that have a MAC address, and a valid one.
|
||||
candidate_ifaces = [iface for iface in self.ifaces if self._is_ok_for_mac2iface(iface)]
|
||||
|
||||
for iface in candidate_ifaces:
|
||||
if len([x for x in candidate_ifaces if x['address'] == iface['address']]) >= 2:
|
||||
# We need to be careful, sometimes we can have the same MAC address
|
||||
# on multiple interfaces. This happens with VLAN interfaces for
|
||||
# instance. mac2iface will obviously be confused when dealing with
|
||||
# those so let's skip the interfaces that have duplicate MAC.
|
||||
logging.warning('[%s] is not the only interface with address [%s]', iface['ifname'], iface['address'])
|
||||
continue
|
||||
|
||||
self.assertEqual(iface['ifname'], iputil.mac2iface(iface['address']))
|
||||
|
||||
def test_remove_invalid_addresses(self):
|
||||
good_tcp = trid.TID({'transport': 'tcp', 'traddr': '1.1.1.1', 'subsysnqn': '', 'trsvcid': '8009'})
|
||||
|
|
|
|||
|
|
@ -200,8 +200,7 @@ def get_tids_to_test(family, src_ip, ifname):
|
|||
]
|
||||
|
||||
|
||||
class DummyDevice:
|
||||
...
|
||||
class DummyDevice: ...
|
||||
|
||||
|
||||
class Test(unittest.TestCase):
|
||||
|
|
@ -295,6 +294,11 @@ class Test(unittest.TestCase):
|
|||
def test__cid_matches_tid(self):
|
||||
ifaces = iputil.net_if_addrs()
|
||||
for ifname, addrs in self.ifaces.items():
|
||||
# <ifaces> contains a subset of the interfaces found in <self.ifaces>.
|
||||
# So, let's make sure that we only test with the interfaces found in both.
|
||||
if ifname not in ifaces:
|
||||
continue
|
||||
|
||||
##############################################
|
||||
# IPV4
|
||||
|
||||
|
|
|
|||
|
|
@ -28,5 +28,14 @@ RuntimeDirectory=stacd
|
|||
CacheDirectory=stacd
|
||||
RuntimeDirectoryPreserve=yes
|
||||
|
||||
ProtectHome=true
|
||||
ProtectKernelModules=true
|
||||
ProtectKernelLogs=true
|
||||
ProtectControlGroups=true
|
||||
ProtectProc=invisible
|
||||
RestrictRealtime=true
|
||||
LockPersonality=yes
|
||||
MemoryDenyWriteExecute=yes
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
|
|
|
|||
|
|
@ -31,5 +31,14 @@ RuntimeDirectory=stafd
|
|||
CacheDirectory=stafd
|
||||
RuntimeDirectoryPreserve=yes
|
||||
|
||||
ProtectHome=true
|
||||
ProtectKernelModules=true
|
||||
ProtectKernelLogs=true
|
||||
ProtectControlGroups=true
|
||||
ProtectProc=invisible
|
||||
RestrictRealtime=true
|
||||
LockPersonality=yes
|
||||
MemoryDenyWriteExecute=yes
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
|
|
|
|||
34
utils/nvmet/auth.conf
Normal file
34
utils/nvmet/auth.conf
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
# Config file format: Python, i.e. dict(), list(), int, str, etc...
|
||||
# port ids (id) are integers 0...N
|
||||
# namespaces are integers 0..N
|
||||
# subsysnqn can be integers or strings
|
||||
{
|
||||
'ports': [
|
||||
{
|
||||
'id': 1,
|
||||
#'adrfam': 'ipv6',
|
||||
#'traddr': '::',
|
||||
'adrfam': 'ipv4',
|
||||
'traddr': '0.0.0.0',
|
||||
'trsvcid': 4420,
|
||||
'trtype': 'tcp',
|
||||
}
|
||||
],
|
||||
|
||||
'subsystems': [
|
||||
{
|
||||
'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34ae8e28',
|
||||
'port': 1,
|
||||
'namespaces': [1],
|
||||
'allowed_hosts': [
|
||||
{
|
||||
# Must match with the NQN and key configured on the host
|
||||
# Key was generated with:
|
||||
# nvme gen-dhchap-key ...
|
||||
'nqn': 'nqn.2014-08.org.nvmexpress:uuid:46ba5037-7ce5-41fa-9452-48477bf00080',
|
||||
'key': 'DHHC-1:00:2kx1hDTUPdvwtxHYUXFRl8pzn5hYZH7K3Z77IYM4hNN6/fQT:',
|
||||
},
|
||||
],
|
||||
},
|
||||
]
|
||||
}
|
||||
|
|
@ -6,10 +6,10 @@
|
|||
'ports': [
|
||||
{
|
||||
'id': 1,
|
||||
'adrfam': 'ipv6',
|
||||
'traddr': '::',
|
||||
#'adrfam': 'ipv4',
|
||||
#'traddr': '0.0.0.0',
|
||||
#'adrfam': 'ipv6',
|
||||
#'traddr': '::',
|
||||
'adrfam': 'ipv4',
|
||||
'traddr': '0.0.0.0',
|
||||
'trsvcid': 8009,
|
||||
'trtype': 'tcp',
|
||||
}
|
||||
|
|
|
|||
|
|
@ -52,19 +52,26 @@ def _get_loaded_nvmet_modules():
|
|||
return output
|
||||
|
||||
|
||||
def _runcmd(cmd: list, quiet=False):
|
||||
def _runcmd(cmd: list, quiet=False, capture_output=False):
|
||||
if not quiet:
|
||||
print(' '.join(cmd))
|
||||
if args.dry_run:
|
||||
return
|
||||
subprocess.run(cmd)
|
||||
|
||||
try:
|
||||
cp = subprocess.run(cmd, capture_output=capture_output, text=True)
|
||||
except TypeError:
|
||||
# For older Python versions that don't support "capture_output" or "text"
|
||||
cp = subprocess.run(cmd, stdout=subprocess.PIPE, universal_newlines=True)
|
||||
|
||||
return cp.stdout if capture_output else None
|
||||
|
||||
|
||||
def _modprobe(module: str, args: list = None, quiet=False):
|
||||
cmd = ['/usr/sbin/modprobe', module]
|
||||
if args:
|
||||
cmd.extend(args)
|
||||
_runcmd(cmd, quiet)
|
||||
_runcmd(cmd, quiet=quiet)
|
||||
|
||||
|
||||
def _mkdir(dname: str):
|
||||
|
|
@ -93,12 +100,32 @@ def _symlink(port: str, subsysnqn: str):
|
|||
link.symlink_to(target)
|
||||
|
||||
|
||||
def _create_subsystem(subsysnqn: str) -> str:
|
||||
def _symlink_allowed_hosts(hostnqn: str, subsysnqn: str):
|
||||
print(
|
||||
f'$( cd "/sys/kernel/config/nvmet/subsystems/{subsysnqn}/allowed_hosts" && ln -s "../../../hosts/{hostnqn}" "{hostnqn}" )'
|
||||
)
|
||||
if args.dry_run:
|
||||
return
|
||||
target = os.path.join('/sys/kernel/config/nvmet/hosts', hostnqn)
|
||||
link = pathlib.Path(os.path.join('/sys/kernel/config/nvmet/subsystems', subsysnqn, 'allowed_hosts', hostnqn))
|
||||
link.symlink_to(target)
|
||||
|
||||
|
||||
def _create_subsystem(subsysnqn: str, allowed_hosts: list) -> str:
|
||||
print(f'###{Fore.GREEN} Create subsystem: {subsysnqn}{Style.RESET_ALL}')
|
||||
dname = os.path.join('/sys/kernel/config/nvmet/subsystems/', subsysnqn)
|
||||
_mkdir(dname)
|
||||
_echo(1, os.path.join(dname, 'attr_allow_any_host'))
|
||||
return dname
|
||||
_echo(0 if allowed_hosts else 1, os.path.join(dname, 'attr_allow_any_host'))
|
||||
|
||||
# Configure all the hosts that are allowed to access this subsystem
|
||||
for host in allowed_hosts:
|
||||
hostnqn = host.get('nqn')
|
||||
hostkey = host.get('key')
|
||||
if all([hostnqn, hostkey]):
|
||||
dname = os.path.join('/sys/kernel/config/nvmet/hosts/', hostnqn)
|
||||
_mkdir(dname)
|
||||
_echo(hostkey, os.path.join(dname, 'dhchap_key'))
|
||||
_symlink_allowed_hosts(hostnqn, subsysnqn)
|
||||
|
||||
|
||||
def _create_namespace(subsysnqn: str, id: str, node: str) -> str:
|
||||
|
|
@ -107,7 +134,6 @@ def _create_namespace(subsysnqn: str, id: str, node: str) -> str:
|
|||
_mkdir(dname)
|
||||
_echo(node, os.path.join(dname, 'device_path'))
|
||||
_echo(1, os.path.join(dname, 'enable'))
|
||||
return dname
|
||||
|
||||
|
||||
def _args_valid(id, traddr, trsvcid, trtype, adrfam):
|
||||
|
|
@ -215,8 +241,9 @@ def create(args):
|
|||
str(subsystem.get('port')),
|
||||
subsystem.get('namespaces'),
|
||||
)
|
||||
|
||||
if None not in (subsysnqn, port, namespaces):
|
||||
_create_subsystem(subsysnqn)
|
||||
_create_subsystem(subsysnqn, subsystem.get('allowed_hosts', []))
|
||||
for id in namespaces:
|
||||
_create_namespace(subsysnqn, str(id), dev_node)
|
||||
else:
|
||||
|
|
@ -235,10 +262,16 @@ def clean(args):
|
|||
if not args.dry_run and os.geteuid() != 0:
|
||||
sys.exit(f'Permission denied. You need root privileges to run {os.path.basename(__file__)}.')
|
||||
|
||||
print(f'###{Fore.GREEN} 1st) Remove the symlinks{Style.RESET_ALL}')
|
||||
print('rm -f /sys/kernel/config/nvmet/ports/*/subsystems/*')
|
||||
for dname in pathlib.Path('/sys/kernel/config/nvmet/ports').glob('*/subsystems/*'):
|
||||
_runcmd(['rm', '-f', str(dname)], quiet=True)
|
||||
|
||||
print('rm -f /sys/kernel/config/nvmet/subsystems/*/allowed_hosts/*')
|
||||
for dname in pathlib.Path('/sys/kernel/config/nvmet/subsystems').glob('*/allowed_hosts/*'):
|
||||
_runcmd(['rm', '-f', str(dname)], quiet=True)
|
||||
|
||||
print(f'###{Fore.GREEN} 2nd) Remove directories{Style.RESET_ALL}')
|
||||
print('rmdir /sys/kernel/config/nvmet/ports/*')
|
||||
for dname in pathlib.Path('/sys/kernel/config/nvmet/ports').glob('*'):
|
||||
_runcmd(['rmdir', str(dname)], quiet=True)
|
||||
|
|
@ -251,6 +284,11 @@ def clean(args):
|
|||
for dname in pathlib.Path('/sys/kernel/config/nvmet/subsystems').glob('*'):
|
||||
_runcmd(['rmdir', str(dname)], quiet=True)
|
||||
|
||||
print('rmdir /sys/kernel/config/nvmet/hosts/*')
|
||||
for dname in pathlib.Path('/sys/kernel/config/nvmet/hosts').glob('*'):
|
||||
_runcmd(['rmdir', str(dname)], quiet=True)
|
||||
|
||||
print(f'###{Fore.GREEN} 3rd) Unload kernel modules{Style.RESET_ALL}')
|
||||
for module in _get_loaded_nvmet_modules():
|
||||
_modprobe(module, ['--remove'])
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue