File: kanif.conf.html

package info (click to toggle)
kanif 1.2.2-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 572 kB
  • sloc: perl: 1,610; sh: 659; makefile: 76
file content (129 lines) | stat: -rwxr-xr-x 5,030 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>kanif</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:_www@b70.apple.com" />
</head>

<body style="background-color: white">

<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#example">EXAMPLE</a></li>
	<li><a href="#see_also">SEE ALSO</a></li>
	<li><a href="#author">AUTHOR</a></li>
	<li><a href="#copyright">COPYRIGHT</a></li>
</ul>
<!-- INDEX END -->

<hr />
<center><h1>USER MANUAL</h1></center><p>
</p>
<hr />
<h1><a name="name">NAME</a></h1>
<p><strong>kanif.conf</strong> - configuration file for <strong>kanif</strong></p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p><strong>$HOME/.kanif.conf</strong>, <strong>/etc/kanif.conf</strong> or <strong>/etc/c3.conf</strong></p>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p><strong>kanif.conf</strong> is the configuration file for <strong>kanif</strong>. 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.</p>
<p>It is composed of a sequence of one or more cluster definitions. Each cluster
definition is made of the word <a href="#item_cluster"><code>cluster</code></a> followed by the cluster name and,
enclosed in a pair of curly braces :</p>
<ul>
<li><strong><a name="item_the_front_node_specification_2e_this_is_either_3a">the front node specification. This is either:</a></strong>

<ul>
<li><strong><a name="item_cluster">a simple hostname which can be reached from the inside of the cluster
(compute nodes).</a></strong>

<li><strong><a name="item_node">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 <strong>kanif</strong>). The second
is the name used from the cluster
compute nodes to reach the front node.</a></strong>

<li><strong><a name="item_an_hostname_with_a_colon_prepended_2e_this_is_used">an hostname with a colon prepended. This is used for indirect clusters.
These are not supported by <strong>kanif</strong> at this time.</a></strong>

</ul>
<li><strong><a name="item_zero_or_more_compute_nodes_specifications_3a">zero or more compute nodes specifications:</a></strong>

<ul>
<li><strong><a name="item_hostname">a simple hostname (anything that is not of the following form)</a></strong>

<li><strong><a name="item_an_host_set_made_of_a_prefix_2c_a_range_and_a_suff">an host set made of a prefix, a range and a suffix.</a></strong>

<li><strong><a name="item_an_exclude_directive_that_must_follow_an_host_set_">an exclude directive that must follow an host set or another exclude
directive. This is made of the word <code>exclude</code> 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 <code>exclude</code> and this exclusion is optional.</a></strong>

<li><strong><a name="item_a_dead_node_2e_the_word_dead_followed_by_the_name_">a dead node. The word <code>dead</code> followed by the name of the dead node on
the same line.</a></strong>

</ul>
</ul>
<p>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 <strong>kanif</strong> (they are kind of
placeholders). This is the interest of specifying nodes as dead or excluded
rather than dropping them from the definitions.</p>
<p>
</p>
<hr />
<h1><a name="example">EXAMPLE</a></h1>
<pre>
  cluster megacluster {         # The # character introduce comments
        megacluster-dev
        megacluster0[1-9]
        megacluster[10-64]
  }</pre>
<pre>
  cluster supercluster {
        super-ext:super-int
        exclude               # The host &quot;exclude&quot;
        super[01-99]
        exclude 02            # &quot;super02&quot; is excluded
        exclude[90-95]        # &quot;super90&quot; to &quot;super95&quot; are excluded
        dead                  # The host &quot;dead&quot;
        dead othernode        # &quot;othernode&quot; is dead
  }</pre>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p>kanif(1), <code>taktuk(1)</code></p>
<p>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>The author of <strong>kanif</strong> and current maintainer of the package is
Guillaume Huard. Acknowledgements to Lucas Nussbaum for the idea of the name
``kanif''.</p>
<p>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<p><strong>kanif</strong> is provided under the terms of the GNU General Public License
version 2 or later.</p>

</body>

</html>