summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEric Mackay <eric.mackay@oracle.com>2022-05-06 18:00:08 -0700
committerEric Mackay <eric.mackay@oracle.com>2022-05-18 17:41:42 -0700
commit10e3bf175bd8b1ad7f9c9900644a674b317e6428 (patch)
tree62a6f2a22008f29f1a9c07874c1be7b046abd1f5 /doc
parent433fad9ddadd62e5edf9597493f32a3b9443cc59 (diff)
downloadopen-iscsi-10e3bf175bd8b1ad7f9c9900644a674b317e6428.tar.gz
Use config for iscsistart and iscsiadm fw login
Specifying name-value pairs as arguments to iscsistart or iscsiadm can become unwieldy very quickly, and is less flexible than using a config file. If a user desires to update settings, modifying a config file and rebuilding initramfs can be simpler than modifying arguments directly in initramfs code or scripts. Node records created from boot context are populated with defaults, then any settings specified in a config file are applied (if config is present). FW and user-specified params are still applicable. User-specified name-value arguments are applied after config settings, so they can serve as a safeguard against config file changes if desired. Added -c|--config options for iscsistart to specify the config Updated iscsistart man page Signed-off-by: Eric Mackay <eric.mackay@oracle.com> Reviewed-by: Mike Christie <michael.christie@oracle.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile6
-rw-r--r--doc/iscsistart.8.template (renamed from doc/iscsistart.8)4
2 files changed, 7 insertions, 3 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 7267dfc..47e14a9 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -22,11 +22,11 @@ MAN8DIR = $(DESTDIR)$(mandir)/man8
MANPAGES_SOURCES = iscsi_discovery.8 \
iscsi_fw_login.8 \
- iscsi-iname.8 \
- iscsistart.8
+ iscsi-iname.8
MANPAGES_TEMPLATES = iscsid.8.template \
iscsiadm.8.template \
- iscsi-gen-initiatorname.8
+ iscsi-gen-initiatorname.8 \
+ iscsistart.8.template
MANPAGES_GENERATED = $(MANPAGES_TEMPLATES:.template=)
MANPAGES_DEST = $(addprefix $(MAN8DIR)/,$(MANPAGES_GENERATED)) \
$(addprefix $(MAN8DIR)/,$(MANPAGES_SOURCES))
diff --git a/doc/iscsistart.8 b/doc/iscsistart.8.template
index 5aa7dd4..62fae4d 100644
--- a/doc/iscsistart.8
+++ b/doc/iscsistart.8.template
@@ -12,6 +12,10 @@ not be run to manage sessions. Its primary use is to start
sessions used for iSCSI root boot.
.SH OPTIONS
.TP
+.BI [-c|--config=]\fIconfig\-file\fP
+Read configuration from \fIconfig\-file\fR rather than the default
+\fI@HOMEDIR@/iscsid.conf\fR file.
+.TP
.BI [-i|--initiatorname=]\fIname\fP
Set InitiatorName to name (Required if not using iBFT or OF)
.TP