.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "KANIF.CONF 5"
.TH KANIF.CONF 5 "2022-07-28" "perl v5.34.0" "kanif.conf configuration file for kanif"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
kanif.conf \- configuration file for kanif
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fB\f(CB$HOME\fB/.kanif.conf\fR, \fB/etc/kanif.conf\fR or \fB/etc/c3.conf\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBkanif.conf\fR is the configuration file for \fBkanif\fR. It is optional and
only helps the management of static clusters (configurations that do not change
much over time). It mimics the syntax of C3 configuration file.
.PP
It is composed of a sequence of one or more cluster definitions. Each cluster
definition is made of the word \f(CW\*(C`cluster\*(C'\fR followed by the cluster name and,
enclosed in a pair of curly braces :
.IP "\(bu" 4
the front node specification. This is either:
.RS 4
.IP "\(bu" 4
a simple hostname which can be reached from the inside of the cluster
(compute nodes).
.IP "\(bu" 4
two names separated by a colon. The first name is the name used from
the outside to log on the front node (not used by \fBkanif\fR). The second
is the name used from the cluster
compute nodes to reach the front node.
.IP "\(bu" 4
an hostname with a colon prepended. This is used for indirect clusters.
These are not supported by \fBkanif\fR at this time.
.RE
.RS 4
.RE
.IP "\(bu" 4
zero or more compute nodes specifications:
.RS 4
.IP "\(bu" 4
a simple hostname (anything that is not of the following form)
.IP "\(bu" 4
an host set made of a prefix, a range and a suffix.
.IP "\(bu" 4
an exclude directive that must follow an host set or another exclude
directive. This is made of the word \f(CW\*(C`exclude\*(C'\fR followed on the same line by
either a single
number or an interval between brackets. This applies to the range of the
preceding host set. If the exclusion is an interval, the separator between the
word \f(CW\*(C`exclude\*(C'\fR and this exclusion is optional.
.IP "\(bu" 4
a dead node. The word \f(CW\*(C`dead\*(C'\fR followed by the name of the dead node on
the same line.
.RE
.RS 4
.RE
.PP
Notice that all nodes excluded (using exclude directives or dead nodes) will
not take part of the deployment, but are still taken into account in cluster
ranges when giving machines specifications to \fBkanif\fR (they are kind of
placeholders). This is the interest of specifying nodes as dead or excluded
rather than dropping them from the definitions.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 5
\&  cluster megacluster {         # The # character introduce comments
\&        megacluster\-dev
\&        megacluster0[1\-9]
\&        megacluster[10\-64]
\&  }
\&
\&  cluster supercluster {
\&        super\-ext:super\-int
\&        exclude               # The host "exclude"
\&        super[01\-99]
\&        exclude 02            # "super02" is excluded
\&        exclude[90\-95]        # "super90" to "super95" are excluded
\&        dead                  # The host "dead"
\&        dead othernode        # "othernode" is dead
\&  }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBkanif\fR\|(1), \fBtaktuk\fR\|(1)
.SH "AUTHOR"
.IX Header "AUTHOR"
The author of \fBkanif\fR and current maintainer of the package is
Guillaume Huard. Acknowledgements to Lucas Nussbaum for the idea of the name
\&\*(L"kanif\*(R".
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
\&\fBkanif\fR is provided under the terms of the \s-1GNU\s0 General Public License
version 2 or later.