diff options
author | mav <mav@FreeBSD.org> | 2015-10-05 09:01:19 +0000 |
---|---|---|
committer | mav <mav@FreeBSD.org> | 2015-10-05 09:01:19 +0000 |
commit | 2ae17b4970a1c781d41117245fe9d5c4719962e3 (patch) | |
tree | 6b509737001fdd9276a8951d3442bf79b030acbb /share/man | |
parent | 9712bb296c60f3f2ccbe34cc7dd8b64da3c7a103 (diff) | |
download | FreeBSD-src-2ae17b4970a1c781d41117245fe9d5c4719962e3.zip FreeBSD-src-2ae17b4970a1c781d41117245fe9d5c4719962e3.tar.gz |
MFC r287707: CTL documentation update, mostly for HA.
Diffstat (limited to 'share/man')
-rw-r--r-- | share/man/man4/ctl.4 | 61 |
1 files changed, 57 insertions, 4 deletions
diff --git a/share/man/man4/ctl.4 b/share/man/man4/ctl.4 index 31c3737..279764a 100644 --- a/share/man/man4/ctl.4 +++ b/share/man/man4/ctl.4 @@ -1,4 +1,5 @@ .\" Copyright (c) 2013 Edward Tomasz Napierala +.\" Copyright (c) 2015 Alexander Motin <mav@FreeBSD.org> .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without @@ -23,7 +24,7 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd August 9, 2015 +.Dd September 12, 2015 .Dt CTL 4 .Os .Sh NAME @@ -80,6 +81,8 @@ Mode sense/select support .It Error injection support .It +High Availability clustering support with ALUA +.It All I/O handled in-kernel, no userland context switch overhead .El .Pp @@ -99,9 +102,57 @@ log commands with errors; .It 2 log all commands; .It 4 -log received data for commands except READ/WRITE. +log data for commands other then READ/WRITE. .El Defaults to 0. +.It Va kern.cam.ctl.ha_id +Specifies unique position of this node within High Availability cluster. +Default is 0 -- no HA, 1 and 2 -- HA enabled at specified position. +.It Va kern.cam.ctl.ha_mode +Specifies High Availability cluster operation mode: +.Bl -tag -offset indent -compact +.It 0 +Active/Standby -- primary node has backend access and processes requests, +while secondary can only do basic LUN discovery and reservation; +.It 1 +Active/Active -- both nodes have backend access and process requests, +while secondary node synchronizes processing with primary one; +.It 2 +Active/Active -- primary node has backend access and processes requests, +while secondary node forwards all requests and data to primary one; +.El +All above modes require established connection between HA cluster nodes. +If connection is not configured, secondary node will report Unavailable +state; if configured but not established -- Transitioning state. +Defaults to 0. +.It Va kern.cam.ctl.ha_peer +String value, specifying method to establish connection to peer HA node. +Can be "listen IP:port", "connect IP:port" or empty. +.It Va kern.cam.ctl.ha_link +Reports present state of connection between HA cluster nodes: +.Bl -tag -offset indent -compact +.It 0 +not configured; +.It 1 +configured but not established; +.It 2 +established. +.El +.It Va kern.cam.ctl.ha_role +Specifies default role of this node: +.Bl -tag -offset indent -compact +.It 0 +primary; +.It 1 +secondary. +.El +This role can be overriden on per-LUN basis using "ha_role" LUN option, +so that for one LUN one node is primary, while for another -- another. +Role change from primary to secondary for HA modes 0 and 2 closes backends, +the opposite change -- opens. +If there is no primary node (both nodes are secondary, or secondary node has +no connection to primary one), secondary node(s) report Transitioning state. +State with two primary nodes is illegal (split brain condition). .It Va kern.cam.ctl.iscsi.debug Verbosity level for log messages from the kernel part of iSCSI target. Set to 0 to disable logging or 1 to warn about potential problems. @@ -131,5 +182,7 @@ subsystem first appeared in .Sh AUTHORS The .Nm -subsystem was written by -.An Kenneth Merry Aq ken@FreeBSD.org . +subsystem was originally written by +.An Kenneth Merry Aq Mt ken@FreeBSD.org . +Later work was done by +.An Alexander Motin Aq Mt mav@FreeBSD.org . |