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

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

---------

Co-authored-by: Tahlia Richardson <[email protected]>
  • Loading branch information
taroth21 and tahliar authored Nov 8, 2023
1 parent b0f372e commit 3aa5447
Show file tree
Hide file tree
Showing 25 changed files with 82 additions and 82 deletions.
4 changes: 2 additions & 2 deletions xml/article_geo_clustering.xml
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@
patterns. These patterns are only available after the &productname; is installed.
</para>
<para>
You can register to the &scc; and install the &hasi; while installing &sles;,
You can register to the &scc; and install &productname; while installing &sles;,
or after installation. For more information, see
<link xlink:href="https://documentation.suse.com/sles/html/SLES-all/cha-register-sle.html">
&deploy;</link> for &sles;.
Expand All @@ -259,7 +259,7 @@
<note>
<title>Installing software packages on all nodes</title>
<para>
For an automated installation of &sls; &productnumber; and the &hasi;,
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>
Expand Down
10 changes: 5 additions & 5 deletions xml/article_installation.xml
Original file line number Diff line number Diff line change
Expand Up @@ -302,8 +302,8 @@
This pattern is only available after the &productname; is installed.
</para>
<para>
You can register with the &scc; and install the &hasi; while installing &sles;,
or after installation. For more information, see the
You can register to the &scc; and install &productname; while installing &sles;,
or after installation. For more information, see the
<link xlink:href="https://documentation.suse.com/sles/html/SLES-all/cha-register-sle.html">
&deploy;</link> for &sles;.
</para>
Expand All @@ -322,8 +322,8 @@
<note>
<title>Installing software packages on all nodes</title>
<para>
For an automated installation of &sls; &productnumber; and the &hasi;,
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 All @@ -336,7 +336,7 @@
<para>
Before you can configure SBD with the bootstrap script, you must enable a watchdog
on each node. &sls; 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
45 changes: 23 additions & 22 deletions xml/ha_concepts.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
(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
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,10 +47,11 @@
</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;.
&ha; is available as a module or extension for several products. For details, see
<link xlink:href="https://documentation.suse.com/sles/html/SLES-all/article-modules.html#art-modules-high-availability"></link>.
</para>
</sect1>
<sect1 xml:id="sec-ha-features">
Expand All @@ -64,7 +65,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 @@ -122,11 +123,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, and manage
dependencies. They can 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 @@ -136,7 +137,7 @@
<sect2 xml:id="sec-ha-features-storage">
<title>Storage and data replication</title>
<para>
With the &hasi; you can dynamically assign and reassign server
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
Expand All @@ -155,8 +156,8 @@
virtual Linux servers. &sls; &productnumber; ships with &xen;,
an open source virtualization hypervisor, and with &kvm; (Kernel-based
Virtual Machine). &kvm; is a virtualization software for Linux which is based on
hardware virtualization extensions. The cluster resource manager in the
&hasi; can recognize, monitor, and manage services running within
hardware virtualization extensions. The cluster resource manager in &productname;
can recognize, monitor, and manage services running within
virtual servers and services running in physical servers. Guest
systems can be managed as services by the cluster.
</para>
Expand Down Expand Up @@ -270,7 +271,7 @@
<sect2 xml:id="sec-ha-features-tools">
<title>User-friendly administration tools</title>
<para>
The &hasi; ships with a set of powerful tools. Use them for basic installation
&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>
Expand All @@ -280,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 @@ -337,17 +338,17 @@
<title>Benefits</title>

<para>
The &hasi; allows you to configure up to 32 Linux servers into a
&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
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
Expand Down Expand Up @@ -413,7 +414,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 @@ -480,7 +481,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 @@ -523,13 +524,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. Therefore 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 @@ -545,7 +546,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 node fails, another designated node in
Expand Down Expand Up @@ -627,15 +628,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
6 changes: 3 additions & 3 deletions xml/ha_config_basics.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
This chapter introduces some basic concepts you need to know
when 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 @@ -407,8 +407,8 @@ C = number of cluster nodes</screen>
</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
12 changes: 6 additions & 6 deletions xml/ha_configuring_resources.xml
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@
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 @@ -198,7 +198,7 @@
</varlistentry>
</variablelist>
<para>
The agents supplied with the &hasi; are written to OCF
The agents supplied with &productname; are written to OCF
specifications.
</para>
</sect1>
Expand Down Expand Up @@ -310,17 +310,17 @@
<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 &productname;. You must do this yourself.
</para>
<para>
You can create primitive resources using either &hawk2; or &crmsh;.
</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 &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
8 changes: 4 additions & 4 deletions xml/ha_drbd.xml
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,9 @@ NAME SIZELIMIT OFFSET AUTOCLEAR RO BACK-FILE
<sect1 xml:id="sec-ha-drbd-install">
<title>Installing DRBD services</title>
<para>
Install the &hasi; on both &sls; machines in your networked
Install the &ha; pattern on both &sls; machines in your networked
cluster as described in <xref linkend="part-install"/>. Installing
&hasi; also installs the DRBD program files.
the pattern also installs the DRBD program files.
</para>

<para>
Expand Down Expand Up @@ -677,8 +677,8 @@ r0 role:Primary
<sect1 xml:id="sec-ha-drbd-migrate">
<title>Migrating from DRBD&nbsp;8 to DRBD&nbsp;9</title>
<para>
Between DRBD&nbsp;8 (shipped with &sle; &hasi;&nbsp;12 SP1) and
DRBD&nbsp;9 (shipped with &sle; &hasi;&nbsp;12 SP2), the metadata format
Between DRBD&nbsp;8 (shipped with &productname; 12 SP1) and
DRBD&nbsp;9 (shipped with &productname;12 SP2), the metadata format
has changed. DRBD&nbsp;9 does not automatically convert previous metadata
files to the new format.
</para>
Expand Down
2 changes: 1 addition & 1 deletion xml/ha_example_gui_i.xml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
<para>
The name and value are dependent on your hardware configuration and
what you chose for the media configuration during the installation of
the &hasi; software.
the &ha; software.
</para>
</step>
</substeps>
Expand Down
4 changes: 2 additions & 2 deletions xml/ha_fencing.xml
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@

<para>
In a Pacemaker cluster, the implementation of node level fencing is &stonith;
(Shoot The Other Node in the Head). The &hasi;
(Shoot The Other Node in the Head). &productname;
includes the <command>stonith</command> command line tool, an extensible
interface for remotely powering down a node in the cluster. For an
overview of the available options, run <command>stonith --help</command>
Expand All @@ -150,7 +150,7 @@
<title>&stonith; devices</title>
<para>
To use node level fencing, you first need to have a fencing device. To
get a list of &stonith; devices which are supported by the &hasi;, run
get a list of &stonith; devices which are supported by &productname;, run
one of the following commands on any of the nodes:
</para>
<screen>&prompt.root;<command>stonith -L</command></screen>
Expand Down
4 changes: 2 additions & 2 deletions xml/ha_glossary.xml
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@
<glossdef>
<para>
The management entity responsible for coordinating all non-local
interactions in a &ha; cluster. The &hasi; uses Pacemaker as CRM.
interactions in a &ha; cluster. &productname; uses Pacemaker as CRM.
The CRM is implemented as <systemitem
class="daemon">pacemaker-controld</systemitem>. It interacts with several
components: local resource managers, both on its own node and on the other nodes,
Expand Down Expand Up @@ -450,7 +450,7 @@ performance will be met during a contractual measurement period.</para>
<glossdef>
<para>
A script acting as a proxy to manage a resource (for example, to start,
stop, or monitor a resource). The &hasi; supports different
stop, or monitor a resource). &productname; supports different
kinds of resource agents. For details, see
<xref linkend="sec-ha-config-basics-raclasses"/>.
</para>
Expand Down
4 changes: 2 additions & 2 deletions xml/ha_install.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="cha-ha-install">
<?dbfo-need height="20em"?>
<title>Installing the &hasi;</title>
<title>Installing &productname;</title>
<info>
<abstract>
<para>If you are setting up a &ha; cluster with &productnamereg; for the first time, the
Expand Down Expand Up @@ -40,7 +40,7 @@
<sect1 xml:id="sec-ha-install-manual">
<title>Manual installation</title>
<para>
For the manual installation of the packages for &hasi; refer to
For the manual installation of the packages for &ha; refer to
<xref linkend="article-installation"/>. It leads you through the setup of a
basic two-node cluster.
</para>
Expand Down
2 changes: 1 addition & 1 deletion xml/ha_lb_lvs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</info>
<para>
The following sections give an overview of the main LVS components and
concepts. Then we explain how to set up &lvs; on &hasi;.
concepts. Then we explain how to set up &lvs; on &productname;.
</para>

<sect2 xml:id="sec-ha-lvs-overview-director">
Expand Down
4 changes: 2 additions & 2 deletions xml/ha_loadbalancing.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ toms 2014-05-27:
one large, fast server to outside clients. This apparent single server is
called a <emphasis>virtual server</emphasis>. It consists of one or more
load balancers dispatching incoming requests and several real servers
running the actual services. With a load balancing setup of &hasi;, you
running the actual services. With a load balancing setup of &productname;, you
can build highly scalable and highly available network services, such as
Web, cache, mail, FTP, media and VoIP services.
</para>
Expand All @@ -41,7 +41,7 @@ toms 2014-05-27:
<sect1 xml:id="sec-ha-lb-overview">
<title>Conceptual overview</title>
<para>
&hasi; supports two technologies for load balancing: &lvs; (LVS) and
&productname; supports two technologies for load balancing: &lvs; (LVS) and
&haproxy;. The key difference is &lvs; operates at OSI layer 4
(Transport), configuring the network layer of kernel, while &haproxy;
operates at layer 7 (Application), running in user space. Thus &lvs;
Expand Down
Loading

0 comments on commit 3aa5447

Please sign in to comment.