Skip to content

Commit

Permalink
Add installation overview (WIP)
Browse files Browse the repository at this point in the history
  • Loading branch information
tahliar committed Dec 5, 2024
1 parent 0aa452a commit 3bbdb21
Show file tree
Hide file tree
Showing 2 changed files with 122 additions and 25 deletions.
145 changes: 121 additions & 24 deletions xml/ha_installation_overview.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,35 +16,132 @@
<info>
<abstract>
<para>
You can also use a combination of both setup methods, for example: set up one node with YaST cluster and then use one of the bootstrap scripts to integrate more nodes (or vice versa).
This chapter shows an overview of the steps required to set up a working and supported &ha; cluster. It includes all of the options for a full cluster. If you want to start with a basic two-node cluster with only the default options, see <xref linkend="article-installation"/>.
</para>
</abstract>
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker></dm:bugtracker>
<dm:translation>yes</dm:translation>
</dm:docmanager>
</info>
<para>
If you are setting up a &ha; cluster with &productnamereg; for the first time, the
easiest way is to start with a basic two-node cluster. You can also use the
two-node cluster to run some tests. Afterward, you can add more
nodes by cloning existing cluster nodes with &ay;. The cloned nodes will
have the same packages installed and the same system configuration as the
original ones.
</para>

<sect1 xml:id="sec-ha-installation-workflow-options">
<title>Workflow options</title>
<para>

</para>
</sect1>

<sect1 xml:id="sec-ha-installation-preconfig-options">
<title>Preconfiguration options</title>
<para>

</para>
</sect1>

<orderedlist>
<title>Overview of installing a &ha; cluster</title>
<listitem>
<para>
Review <xref linkend="cha-ha-requirements"/> to make sure your nodes and other infrastructure meet the requirements for a &ha; cluster.
</para>
</listitem>
<listitem>
<para>
You can set up the cluster with either the &rootuser; user or a user with <command>sudo</command> privileges. Review <xref linkend="cha-ha-log-in"/> to determine the appropriate user for your requirements.
</para>
</listitem>
<listitem>
<para>
Install the &ha; extension and packages on the nodes as described in <xref linkend="cha-ha-install"/>.
</para>
</listitem>
<listitem>
<para>
Set up the cluster on the nodes. You can use either of the following methods:
</para>
<itemizedlist>
<listitem>
<para>
<xref linkend="cha-ha-bootstrap-install"/>
</para>
</listitem>
<listitem>
<para>
<xref linkend="cha-ha-ycluster"/>
</para>
</listitem>
</itemizedlist>
<para>
You can also use a combination of both methods. For example, you could set up one node with the &yast; cluster module and then use the bootstrap scripts to integrate more nodes (or vice versa).
</para>
<para>
The following table shows the components that are configured by each method:
</para>
<informaltable>
<tgroup cols="3">
<colspec colname="c1" colwidth="33%"/>
<colspec colname="c2" colwidth="33%"/>
<colspec colname="c3" colwidth="34%"/>
<thead>
<row>
<entry>Component</entry>
<entry>Bootstrap script</entry>
<entry>&yast; cluster module</entry>
</row>
</thead>
<tbody>
<row>
<entry>Firewall ports</entry>
<entry>Yes</entry>
<entry>Yes</entry>
</row>
<row>
<entry>Passwordless SSH</entry>
<entry>Yes</entry>
<entry>No; configure before setup</entry>
</row>
<row>
<entry>&csync;</entry>
<entry>Yes</entry>
<entry>Yes</entry>
</row>
<row>
<entry>&corosync;</entry>
<entry>Yes</entry>
<entry>Yes</entry>
</row>
<row>
<entry>&stonith; (node fencing)</entry>
<entry>Optional (SBD only)</entry>
<entry>No; configure after setup</entry>
</row>
<row>
<entry>&qdevice;</entry>
<entry>Optional</entry>
<entry>Optional</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
<listitem>
<para>
Add more nodes. After setting up the initial cluster, you can clone nodes for mass deployment as described in <xref linkend="sec-ha-installation-autoyast"/>.
</para>
</listitem>
<listitem>
<para>
To be supported, a &sleha; cluster <emphasis>must</emphasis> have &stonith; (node fencing) enabled. A node fencing mechanism can be one of the following:
</para>
<itemizedlist>
<listitem>
<para>
A physical device (a power switch). To configure the cluster to use physical &stonith; devices, see <xref linkend="cha-ha-fencing"/>.
</para>
</listitem>
<listitem>
<para>
SBD (&stonith; Block Device) in combination with a watchdog. To configure SBD devices and the watchdog, see <xref linkend="cha-ha-storage-protect"/>.
</para>
<tip role="compact">
<para>
Optionally, you can configure SBD during the cluster setup with the bootstrap scripts (but not &yast;). In this case, you should set up shared storage and the watchdog <emphasis>before</emphasis> you initialize the cluster.
</para>
</tip>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Configure other things you declined to do before, e.g. QDevice
<xref linkend="cha-ha-qdevice"/>
</para>
</listitem>
</orderedlist>
</chapter>
2 changes: 1 addition & 1 deletion xml/ha_log_in.xml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
<term>A user with <command>sudo</command> privileges (with SSH agent forwarding)</term>
<listitem>
<para>
You can use SSH forwarding to pass your local SSH keys to the cluster nodes.
You can use SSH agent forwarding to pass your local SSH keys to the cluster nodes.
This can be useful if you need to avoid storing SSH keys on the nodes, but requires
additional configuration on your local machine and on the cluster nodes.
</para>
Expand Down

0 comments on commit 3bbdb21

Please sign in to comment.