1 .\" Copyright (c) 2010 The FreeBSD Foundation
2 .\" All rights reserved.
4 .\" This software was developed by Pawel Jakub Dawidek under sponsorship from
5 .\" the FreeBSD Foundation.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nd "Highly Available Storage control utility"
41 .Op Fl e Ar extentsize
49 .Aq init | primary | secondary
64 utility is used to control the behaviour of the
68 This utility should be used by HA software like
72 to setup HAST resources role when changing from primary mode to
73 secondary or vice versa.
74 Be aware that if a file system like UFS exists on HAST provider and
75 primary node dies, file system has to be checked for inconsistencies
78 utility after switching secondary node to primary role.
82 indicates an action to be performed:
83 .Bl -tag -width ".Cm create"
85 Initialize local provider configured for the given resource.
86 Additional options include:
87 .Bl -tag -width ".Fl e Ar extentsize"
88 .It Fl e Ar extentsize
90 Extent is a block which is used for synchronization.
92 maintains a map of dirty extents and extent is the smallest region that
93 can be marked as dirty.
94 If any part of an extent is modified, entire extent will be synchronized
96 If extent size is too small, there will be too much disk activity
97 related to dirty map updates, which will degrade performance of the
99 If extent size is too large, synchronization, even in case of short
100 outage, can take a long time increasing the risk of loosing up-to-date
101 node before synchronization process is completed.
102 The default extent size is
104 .It Fl k Ar keepdirty
105 Maximum number of dirty extents to keep dirty all the time.
106 Most recently used extents are kept dirty to reduce number of metadata
108 The default numer of most recently used extents which will be kept
111 .It Fl m Ar mediasize
112 Size of the smaller provider used as backend storage on both nodes.
113 This option can be omitted if node providers have the same size on both
117 Change role of the given resource.
118 The role can be one of:
119 .Bl -tag -width ".Cm secondary"
121 Resource is turned off.
125 daemon will act as primary node for the given resource.
126 System on which resource role is set to primary can use
132 daemon will act as secondary node for the given resource - it will wait
133 for connection from the primary node and will handle I/O requests
137 will not be created on secondary node.
140 Present status of the configured resources.
142 Dump metadata stored on local component for the configured resources.
145 In addition, every subcommand can be followed by the following options:
146 .Bl -tag -width ".Fl c Ar config"
148 Specify alternative location of the configuration file.
149 The default location is
152 Print debugging information.
153 This option can be specified multiple times to raise the verbosity
157 Exit status is 0 on success, or one of the values described in
161 Initialize HAST provider, create file system on it and mount it.
162 .Bd -literal -offset indent
163 nodeB# hastctl create shared
165 nodeB# hastctl role secondary shared
167 nodeB# hastctl create shared
169 nodeA# hastctl role primary shared
170 nodeA# newfs -U /dev/hast/shared
171 nodeA# mount -o noatime /dev/hast/shared /shared
172 nodeA# application_start
178 .Bd -literal -offset indent
179 nodeA# application_stop
180 nodeA# umount -f /shared
181 nodeA# hastctl role secondary shared
183 nodeB# hastctl role primary shared
184 nodeB# fsck -t ufs /dev/hast/shared
185 nodeB# mount -o noatime /dev/hast/shared /shared
186 nodeB# application_start
189 .Bl -tag -width ".Pa /var/run/hastctl" -compact
190 .It Pa /etc/hast.conf
191 Configuration file for
195 .It Pa /var/run/hastctl
196 Control socket used by
198 to communicate with the
216 .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org
217 under sponsorship of the FreeBSD Foundation.