Skip to content

Commit

Permalink
generic: get rid of outdated &hasi; entity (#356)
Browse files Browse the repository at this point in the history 
* generic: get rid of outdated &hasi; entity

- the following preparations where needed before we can fix the value
  of &productname; via doc-kit:
  * replace '[T,t]he &hasi;' with &productname; where appropriate
  * replace '[T,t]he &hasi;' with '&ha; (software)' where appropriate

* update product-entities.ent

* Apply suggestions from code review

* Further changes required for version 12

Co-authored-by: Tahlia Richardson <[email protected]>

---------

Co-authored-by: Tahlia Richardson <[email protected]>
  • Loading branch information
@taroth21 @tahliar
taroth21 and tahliar committed Nov 8, 2023
1 parent f7c6eec commit e2f4190
Show file tree
Hide file tree
Showing 28 changed files with 164 additions and 166 deletions.
10 changes: 5 additions & 5 deletions xml/art_sle_ha_install_quick.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,8 +280,8 @@
<sect1 xml:id="sec-ha-inst-quick-installation">
<title>Installing &sls; and &ha; Extension</title>
<para>
The packages for configuring and managing a cluster with the
&hasi; are included in the <literal>&ha;</literal> installation
The packages for configuring and managing a cluster with &productname;
are included in the <literal>&ha;</literal> installation
pattern. This pattern is only available after &productname; has been
installed as an extension to &slsreg;.
</para>
Expand Down Expand Up @@ -326,8 +326,8 @@
<note>
<title>Installing Software Packages on All Parties</title>
<para>
For an automated installation of &sls; &productnumber; and &productname;
&productnumber;, use &ay; to clone existing nodes. For more
For an automated installation of &sls; &productnumber; and &productname; &productnumber;,
use &ay; to clone existing nodes. For more
information, see <xref linkend="sec-ha-installation-autoyast"/>.
</para>
</note>
Expand Down Expand Up @@ -422,7 +422,7 @@
<para>
In &sls;, watchdog support in the kernel is enabled by default: It ships
with several kernel modules that provide hardware-specific
watchdog drivers. The &hasi; uses the SBD daemon as the software component
watchdog drivers. &productname; uses the SBD daemon as the software component
that <quote>feeds</quote> the watchdog.
</para>
<para>
Expand Down
2 changes: 1 addition & 1 deletion xml/geo_install_i.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
</info>

<para>
For using the &hasi; and &hageo;, you need the packages included in the
For using &productname; and &hageo;, you need the packages included in the
following installation patterns:
</para>

Expand Down
75 changes: 37 additions & 38 deletions xml/ha_concepts.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
management functionality (supporting failover, failback, and migration
(load balancing) of individually managed cluster resources).
</para>
<para>
This chapter introduces the main product features and benefits of the
&hasi;. Inside you will find several example clusters and learn about
<para>
This chapter introduces the main product features and benefits of &productname;.
Inside you will find several example clusters and learn about
the components making up a cluster. The last section provides an
overview of the architecture, describing the individual architecture
layers and processes within the cluster.
Expand All @@ -47,12 +47,12 @@
</dm:docmanager>
</info>
<sect1 xml:id="sec-ha-availability">
<title>Availability as Extension</title>
<title>Availability as a Module or Extension</title>

<para>
The &hasi; is available as an extension to &sls; &productnumber;.
Support for &geo.dispersed; clusters (&geo; clusters) is available
as a separate extension to the &hasi;, called &hageo;.
&ha; is available for several products. Support for &geo.dispersed; clusters
(&geo; clusters) is available as a separate extension called &hageo;. For details, see
<link xlink:href="https://documentation.suse.com/sles/12-SP5/html/SLES-all/cha-add-ons.html#sec-add-ons-extensions"/>.
</para>
</sect1>
<sect1 xml:id="sec-ha-features">
Expand All @@ -67,7 +67,7 @@
<sect2 xml:id="sec-ha-features-scenarios">
<title>Wide Range of Clustering Scenarios</title>
<para>
The &hasi; supports the following scenarios:
&productname; supports the following scenarios:
</para>
<itemizedlist>
<listitem>
Expand Down Expand Up @@ -126,11 +126,11 @@
<sect2 xml:id="sec-ha-features-flexibility">
<title>Flexibility</title>
<para>
The &hasi; ships with &corosync; messaging and membership layer
&productname; ships with &corosync; messaging and membership layer
and Pacemaker Cluster Resource Manager. Using Pacemaker, administrators
can continually monitor the health and status of their resources, manage
dependencies, and automatically stop and start services based on highly
configurable rules and policies. The &hasi; allows you to tailor a
configurable rules and policies. &productname; allows you to tailor a
cluster to the specific applications and hardware infrastructure that
fit your organization. Time-dependent configuration enables services to
automatically migrate back to repaired nodes at specified times.
Expand All @@ -140,16 +140,15 @@
<sect2 xml:id="sec-ha-features-storage">
<title>Storage and Data Replication</title>
<para>
With the &hasi; you can dynamically assign and reassign server
storage as needed. It supports Fibre Channel storage area networks (SAN)
and iSCSI storage on networks. Thus, shared disk systems are supported,
but they are not a requirement.
&productname; also comes with a cluster-aware file
system and volume manager (OCFS2) and the clustered Logical Volume
Manager (cLVM). For replication of your data, you can use DRBD* to
mirror the data of a &ha; service from the active node of a cluster
to its standby node. Furthermore, &productname; also supports CTDB
(Clustered Trivial Database), a technology for Samba clustering.
With &productname; you can dynamically assign and reassign server
storage as needed. It supports Fibre Channel or iSCSI storage area
networks (SANs). Shared disk systems are also supported, but they are
not a requirement. &productname; also comes with a cluster-aware file
system (OCFS2) and the cluster Logical Volume Manager (&clvm;).
For replication of your data, use DRBD* to mirror the data of
a &ha; service from the active node of a cluster to its standby node.
Furthermore, &productname; also supports CTDB (Cluster Trivial Database),
a technology for Samba clustering.
</para>
</sect2>

Expand Down Expand Up @@ -199,7 +198,7 @@
<para>
&productname; has been extended to support different geographical
scenarios. Support for &geo.dispersed; clusters (&geo; clusters)
is available as a separate extension to &hasi;, called &hageo;.
is available as a separate extension called &hageo;.
</para>
<variablelist>
<varlistentry>
Expand Down Expand Up @@ -272,8 +271,8 @@
<sect2 xml:id="sec-ha-features-tools">
<title>User-friendly Administration Tools</title>
<para>
The &hasi; ships with a set of powerful tools for basic installation
and setup of your cluster, effective configuration and
&productname; ships with a set of powerful tools. Use them for basic installation
and setup of your cluster and for effective configuration and
administration:
</para>
<variablelist>
Expand All @@ -282,7 +281,7 @@
<listitem>
<para>
A graphical user interface for general system installation and
administration. Use it to install the &hasi; on top of &sls; as
administration. Use it to install &productname; on top of &sls; as
described in the &haquick;. &yast;
also provides the following modules in the &ha; category to help
configure your cluster or individual components:
Expand Down Expand Up @@ -340,18 +339,18 @@
<title>Benefits</title>

<para>
The &hasi; allows you to configure up to 32 Linux servers into a
high-availability cluster (HA cluster), where resources can be
dynamically switched or moved to any server in the cluster. Resources can
be configured to automatically migrate if a server fails, or they can be
&productname; allows you to configure up to 32 Linux servers into a
high-availability cluster (HA cluster). Resources can be
dynamically switched or moved to any node in the cluster. Resources can
be configured to automatically migrate if a node fails, or they can be
moved manually to troubleshoot hardware or balance the workload.
</para>

<para>
The &hasi; provides high availability from commodity components. Lower
&productname; provides high availability from commodity components. Lower
costs are obtained through the consolidation of applications and
operations onto a cluster. The &hasi; also allows you to centrally
manage the complete cluster and to adjust resources to meet changing
operations onto a cluster. &productname; also allows you to centrally
manage the complete cluster. You can adjust resources to meet changing
workload requirements (thus, manually <quote>load balance</quote> the
cluster). Allowing clusters of more than two nodes also provides savings
by allowing several nodes to share a <quote>hot spare</quote>.
Expand Down Expand Up @@ -416,7 +415,7 @@
</para>

<para>
The following scenario illustrates some benefits the &hasi; can
The following scenario illustrates some benefits &productname; can
provide.
</para>

Expand Down Expand Up @@ -483,7 +482,7 @@
</para>

<para>
When Web Server 1 failed, the &hasi; software did the following:
When Web Server 1 failed, the &ha; software did the following:
</para>

<itemizedlist>
Expand Down Expand Up @@ -526,13 +525,13 @@
either automatically fail back (move back) to Web Server 1, or they can
stay where they are. This depends on how you configured the resources for
them. Migrating the services back to Web Server 1 will incur some
down-time, so the &hasi; also allows you to defer the migration until
down-time. Therefore &productname; also allows you to defer the migration until
a period when it will cause little or no service interruption. There are
advantages and disadvantages to both alternatives.
</para>

<para>
The &hasi; also provides resource migration capabilities. You can move
&productname; also provides resource migration capabilities. You can move
applications, Web sites, etc. to other servers in your cluster as
required for system management.
</para>
Expand All @@ -548,7 +547,7 @@
<title>Cluster Configurations: Storage</title>

<para>
Cluster configurations with the &hasi; might or might not include a
Cluster configurations with &productname; might or might not include a
shared disk subsystem. The shared disk subsystem can be connected via
high-speed Fibre Channel cards, cables, and switches, or it can be
configured to use iSCSI. If a server fails, another designated server in
Expand Down Expand Up @@ -618,15 +617,15 @@
<title>Architecture</title>

<para>
This section provides a brief overview of the &hasi; architecture. It
This section provides a brief overview of &productname; architecture. It
identifies and provides information on the architectural components, and
describes how those components interoperate.
</para>

<sect2 xml:id="sec-ha-architecture-layers">
<title>Architecture Layers</title>
<para>
The &hasi; has a layered architecture.
&productname; has a layered architecture.
<xref linkend="fig-ha-architecture" xrefstyle="FigureXRef"/> illustrates
the different layers and their associated components.
</para>
Expand Down
41 changes: 20 additions & 21 deletions xml/ha_config_basics.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
In this chapter, we will introduce some basic concepts you need to know
when configuring resources and administering your cluster. The following
chapters show you how to execute the main configuration and
administration tasks with each of the management tools the &hasi;
administration tasks with each of the management tools &productname;
provides.
</para>
</abstract>
Expand Down Expand Up @@ -505,14 +505,14 @@ C = number of cluster nodes</screen>
<para>
If a resource has specific environment requirements, make sure they are
present and identical on all cluster nodes. This kind of configuration
is not managed by the &hasi;. You must do this yourself.
is not managed by the &ha; software. You must do this yourself.
</para>
<note>
<title>Do Not Touch Services Managed by the Cluster</title>
<para>
When managing a resource with the &hasi;, the same resource must not
When managing a resource with the &productname;, the same resource must not
be started or stopped otherwise (outside of the cluster, for example
manually or on boot or reboot). The &hasi; software is responsible
manually or on boot or reboot). The &ha; software is responsible
for all service start or stop actions.
</para>
<para>
Expand Down Expand Up @@ -559,8 +559,8 @@ C = number of cluster nodes</screen>
start, stop or monitor command.
</para>
<para>
Typically, resource agents come in the form of shell scripts. The
&hasi; supports the following classes of resource agents:
Typically, resource agents come in the form of shell scripts. &productname;
supports the following classes of resource agents:
</para>
<variablelist>
<varlistentry xml:id="vle-ha-resources-ocf-ra">
Expand Down Expand Up @@ -680,7 +680,7 @@ C = number of cluster nodes</screen>
</varlistentry>
</variablelist>
<para>
The agents supplied with the &hasi; are written to OCF
The agents supplied with &productname; are written to OCF
specifications.
</para>
</sect2>
Expand Down Expand Up @@ -2239,7 +2239,7 @@ monitor_0 interval=5s timeout=20s</screen>
the resources diminish in performance (or even fail).
</para>
<para>
To take this into account, the &hasi; allows you to specify the
To take this into account, &productname; allows you to specify the
following parameters:
</para>
<orderedlist spacing="normal">
Expand Down Expand Up @@ -2278,7 +2278,7 @@ monitor_0 interval=5s timeout=20s</screen>
<para>
A node is considered eligible for a resource if it has sufficient free
capacity to satisfy the resource's requirements. The nature of the
capacities is completely irrelevant for the &hasi;; it only makes
capacities is completely irrelevant for the &ha; software; it only makes
sure that all capacity requirements of a resource are satisfied before
moving a resource to a node.
</para>
Expand All @@ -2291,7 +2291,7 @@ monitor_0 interval=5s timeout=20s</screen>
</para>
<para>
If multiple resources with utilization attributes are grouped or have
colocation constraints, the &hasi; takes that into account. If
colocation constraints, &productname; takes that into account. If
possible, the resources will be placed on a node that can fulfill
<emphasis>all</emphasis> capacity requirements.
</para>
Expand All @@ -2305,7 +2305,7 @@ monitor_0 interval=5s timeout=20s</screen>
</para>
</note>
<para>
The &hasi; also provides means to detect and configure both node
&productname; also provides means to detect and configure both node
capacity and resource requirements automatically:
</para>
<para>
Expand Down Expand Up @@ -2337,7 +2337,7 @@ monitor_0 interval=5s timeout=20s</screen>
</para>
</note>
<para>
Apart from detecting the minimal requirements, the &hasi; also allows
Apart from detecting the minimal requirements, &productname; also allows
to monitor the current utilization via the
<systemitem>VirtualDomain</systemitem> resource agent. It detects CPU
and RAM use of the virtual machine. To use this feature, configure a
Expand Down Expand Up @@ -2455,13 +2455,13 @@ property placement-strategy="minimal"</screen>
</para>
<para>
By providing support for monitoring plug-ins (formerly named Nagios
plug-ins), the &hasi; now also allows you to monitor services on
plug-ins), &productname; now also allows you to monitor services on
remote hosts. You can collect external statuses on the guests without
modifying the guest image. For example, VM guests might run Web services
or simple network resources that need to be accessible. With the Nagios
resource agents, you can now monitor the Web service or the network
resource on the guest. In case these services are not reachable anymore,
the &hasi; will trigger a restart or migration of the respective
resource on the guest. If these services are not reachable anymore,
&productname; will trigger a restart or migration of the respective
guest.
</para>
<para>
Expand Down Expand Up @@ -2575,7 +2575,7 @@ group g-vm1-and-services vm1 vm1-sshd \
not need to run the cluster stack to become members of the cluster.
</para>
<para>
The &hasi; can now launch virtual environments (KVM and LXC), plus
&productname; can now launch virtual environments (KVM and LXC), plus
the resources that live within those virtual environments without
requiring the virtual environments to run &pace; or &corosync;.
</para>
Expand All @@ -2587,8 +2587,7 @@ group g-vm1-and-services vm1 vm1-sshd \
<itemizedlist>
<listitem>
<para>
The <quote>normal</quote> (bare-metal) cluster nodes run the
&hasi;.
The <quote>normal</quote> (bare-metal) cluster nodes run &productname;.
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -2642,7 +2641,7 @@ group g-vm1-and-services vm1 vm1-sshd \

<para>
To prevent a node from running out of disk space and thus being unable to
manage any resources that have been assigned to it, the &hasi;
manage any resources that have been assigned to it, &productname;
provides a resource agent,
<systemitem>ocf:pacemaker:SysInfo</systemitem>. Use it to monitor a
node's health with regard to disk partitions.
Expand Down Expand Up @@ -2794,8 +2793,8 @@ group g-vm1-and-services vm1 vm1-sshd \
</term>
<listitem>
<para>
Home page of Pacemaker, the cluster resource manager shipped with the
&hasi;.
Home page of Pacemaker, the cluster resource manager shipped with
&productname;.
</para>
</listitem>
</varlistentry>
Expand Down
Loading

0 comments on commit e2f4190

Please sign in to comment.