Skip to content

Commit

Permalink
Further expand crm cluster init procedure
Browse files Browse the repository at this point in the history
  • Loading branch information
@tahliar
tahliar committed Sep 6, 2024
1 parent b126fe2 commit e33c110
Showing 1 changed file with 104 additions and 32 deletions.
136 changes: 104 additions & 32 deletions xml/ha_bootstrap_install.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,21 @@
For more options, run <command>crm cluster help init</command>.
</para>
<variablelist>
<varlistentry>
<term>Cluster name</term>
<listitem>
<para>
The default cluster name is <literal>hacluster</literal>. To choose a different name,
use the option <option>--name</option> (or <option>-n</option>). For example:
</para>
<screen>&prompt.root;<command>crm cluster init --name &cluster1;</command></screen>
<para>
Choose a meaningful name, like the geographical location of the cluster. This is
especially helpful if you create a &geo; cluster later, as it simplifies the
identification of a site.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Multicast</term>
<listitem>
Expand All @@ -214,11 +229,26 @@
<term>Network interfaces</term>
<listitem>
<para>
In a later step, the script prompts you for a network interface for &corosync; to use.
In a later step, the script prompts you for a network address for &corosync; to use.
To configure the cluster with two network interfaces, use the option
<option>--interface</option> (or <option>-i</option>) twice. For example:
</para>
<screen>&prompt.root;<command>crm cluster init --interface eth0 --interface eth1</command></screen>
<para>TODO: This and -M seem to do the same thing. What's the difference?</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Redundant communication channel</term>
<listitem>
<para>
Supported clusters must have two communication channels. The preferred method is to
use network device bonding. If you cannot use bonding, the alternative is to set up
a redundant communication channel in &corosync;. By default, the script prompts you
for a network address for a single communication channel. To configure the cluster
with two communication channels, use the option <option>--multi-heartbeats</option>
(or <option>-M</option>). For example:
</para>
<screen>&prompt.root;<command>crm cluster init --multi-heartbeats</command></screen>
</listitem>
</varlistentry>
</variablelist>
Expand All @@ -241,50 +271,92 @@
Accept the proposed port (<literal>5405</literal>) or enter a different one.
</para>
</step>
</substeps>
</step>
<step>
<para>
Set up SBD as the node fencing mechanism:</para>
<substeps>
<step>
<para>Confirm with <literal>y</literal> that you want to use SBD.</para>
</step>
<step>
<para>Enter a persistent path to the partition of your block device that
you want to use for SBD.
The path must be consistent across all nodes in the cluster.</para>
<para>The script creates a small partition on the device to be used for SBD.</para>
<para>
TODO: Better words. If you used -M or -i twice, enter a second network address and port.
</para>
</step>
</substeps>
</step>
<step>
<para>
Enter a name for the cluster. Choose a meaningful name, like the geographical location
of the cluster (for example, <literal>&cluster1;</literal>). This is especially helpful
if you create a &geo; cluster later, as it simplifies the identification of a site.
Choose whether to set up SBD as the node fencing mechanism. If you are using a different
fencing mechanism or want to set up SBD later, enter <literal>n</literal> to skip this step.
To continue with this step, enter <literal>y</literal>.
</para>
<para>
Select the type of SBD to use:
</para>
<itemizedlist>
<listitem>
<para>
To use diskless SBD, enter <literal>none</literal>.
</para>
</listitem>
<listitem>
<para>
To use disk-based SBD, enter a persistent path to the partition of the block device you
want to use. The path must be consistent across all nodes in the cluster, for example,
<filename>/dev/disk/by-id/<replaceable>ID</replaceable></filename>.
</para>
<para>
The script creates a small partition on the device to be used for SBD.
</para>
</listitem>
</itemizedlist>
</step>
<step>
<para>Configure a virtual IP address for cluster administration with &hawk2;:</para>
<substeps>
<step>
<para>Confirm with <literal>y</literal> that you want to configure a
virtual IP address.</para></step>
<step>
<para>Enter an unused IP address that you want to use as administration IP
for &hawk2;: <literal>&subnetI;.10</literal>
</para>
<para>Instead of logging in to an individual cluster node with &hawk2;,
you can connect to the virtual IP address.</para>
</step>
</substeps>
<para>
Choose whether to configure a virtual IP address for cluster administration with &hawk2;.
Instead of logging in to an individual cluster node with &hawk2;, you can connect
to the virtual IP address.
</para>
<para>
If you choose <literal>y</literal>, enter an unused IP address to use for &hawk2;.
</para>
</step>
<step>
<para>
Choose whether to configure &qdevice; and &qnet;. For the minimal setup
described in this document, decline with <literal>n</literal> for now.
Choose whether to configure &qdevice; and &qnet;. If you have not set up the &qnet; server
yet, enter <literal>n</literal> to skip this step and set up &qdevice; and &qnet; later.
If you choose <literal>y</literal>, provide the following information:
</para>
<substeps>
<step>
<para>
Enter the host name or IP address of the &qnet; server.
</para>
<para>
For the remaining fields, you can accept the default values or change them as required:
</para>
</step>
<step>
<para>
Accept the proposed port (<literal>5403</literal>) or enter a different one.
</para>
</step>
<step>
<para>
Choose the algorithm that determines how votes are assigned.
</para>
</step>
<step>
<para>
Choose the method to use when a tie-breaker is required.
</para>
</step>
<step>
<para>
Choose whether to enable TLS. TODO: More info on the options, see that other bug.
</para>
</step>
<step performance="optional">
<para>
Enter heuristics commands to affect how votes are determined. To skip this step, leave
the field blank.
</para>
</step>
</substeps>
</step>
</procedure>
<para>
Expand Down

0 comments on commit e33c110

Please sign in to comment.