2022-05-11 Fred Gleason <fredg@paravelsystems.com>

* Updated the 'System Overview' chapter of the Operations Guide.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason 2022-05-11 14:12:53 -04:00
parent 358bd6f303
commit b237c421f9
2 changed files with 25 additions and 23 deletions

View File

@ -23060,3 +23060,5 @@
2022-05-11 Fred Gleason <fredg@paravelsystems.com> 2022-05-11 Fred Gleason <fredg@paravelsystems.com>
* Updated the global copyright date in the Operations Guide. * Updated the global copyright date in the Operations Guide.
* Updated the global copyright date in rdadmin(1). * Updated the global copyright date in rdadmin(1).
2022-05-11 Fred Gleason <fredg@paravelsystems.com>
* Updated the 'System Overview' chapter of the Operations Guide.

View File

@ -1,4 +1,4 @@
<chapter xmlns="http://docbook.org/ns/docbook" xml:id="chapter.overview"> <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chapter.overview">
<title>System Overview</title> <title>System Overview</title>
<!-- <!--
<mediaobject> <mediaobject>
@ -38,19 +38,15 @@
<para> <para>
Rivendell has been designed and developed from the ground up to run Rivendell has been designed and developed from the ground up to run
on the popular and highly stable <trademark>GNU/Linux</trademark> on the popular and highly stable <trademark>GNU/Linux</trademark>
operating system. operating system. Full source code is available online at
Selected tools (mostly having to do with log generation) have also <link xlink:href="https://github.com/ElvishArtisan/rivendell">https://github.com/ElvishArtisan/rivendell</link>.
been ported to run in the Microsoft <trademark>Windows</trademark>
environment as well.
Full source code as well as binary installation packages for Windows
and select Linux distributions are available on line.
</para> </para>
<para> <para>
Rivendell has been designed to be able to operate in a wide variety Rivendell has been designed to be able to operate in a wide variety
of roles, ranging from single, self-contained workstations to large, of roles, ranging from single, self-contained workstations to large,
multi-station clusters consisting of multiple workstations and multi-station clusters consisting of multiple workstations and
centralized servers. Also included are redundancy and hot-standby centralized servers. Also included are redundancy and hot-standby
capabilities to allow for reliable operation even in the presence of capabilities to allow for reliable operation even in the face of
hardware faults. hardware faults.
</para> </para>
<para> <para>
@ -69,7 +65,7 @@
<varlistentry> <varlistentry>
<term><link linkend="chapter.rdcatch">RDCatch</link></term> <term><link linkend="chapter.rdcatch">RDCatch</link></term>
<listitem> <listitem>
Automatic event scheduler Automatic time-driven event scheduler
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -162,7 +158,8 @@
from any other host (provided the system administrator has enabled from any other host (provided the system administrator has enabled
this capability). Hosts can be used for a wide variety of this capability). Hosts can be used for a wide variety of
applications, including content ingestion and management, applications, including content ingestion and management,
automatic recording (sometimes referred to as netcatching), automatic recording (sometimes referred to as
&quot;netcatching&quot;),
on-air play out or log (sometimes also referred to as playlist) on-air play out or log (sometimes also referred to as playlist)
generation. It is also possible for a single host to perform all generation. It is also possible for a single host to perform all
of these functions. of these functions.
@ -175,9 +172,11 @@
<emphasis>users</emphasis> available <emphasis>users</emphasis> available
to it. In this context, a 'user' is merely a set of access to it. In this context, a 'user' is merely a set of access
policies established by the system administrator that defines what policies established by the system administrator that defines what
tasks a given host is or is not allowed to perform. Every host tasks that user is or is not allowed to perform. The set of
has at least one user, called the <emphasis>default user</emphasis>. available users is global to every host in a given Rivendell system;
As the name with each host operating under exactly one user at a time. Each
host also has one user designated to be the
<emphasis>default user</emphasis>. As the name
suggests, this is the set of user policies that are loaded by suggests, this is the set of user policies that are loaded by
default when the system starts up. It is also possible to change default when the system starts up. It is also possible to change
the user currently in use on a given host by running the RDLogin the user currently in use on a given host by running the RDLogin
@ -208,7 +207,7 @@
<para> <para>
Every facility at which Rivendell is deployed is presumed to have Every facility at which Rivendell is deployed is presumed to have
one or more ultimate destinations for which audio is intended. one or more ultimate destinations for which audio is intended.
These could be radio stations (e.g. WAVA), satellite uplink These could be radio stations --e.g. WAVA--, satellite uplink
channels, live Internet audio streams, or any mix of the above. channels, live Internet audio streams, or any mix of the above.
Each of these sorts of destinations is referred to in Rivendell Each of these sorts of destinations is referred to in Rivendell
as a <emphasis>service</emphasis>, and certain parameters, as a <emphasis>service</emphasis>, and certain parameters,
@ -234,8 +233,8 @@
An <emphasis>audio adapter</emphasis> in Rivendell is simply a An <emphasis>audio adapter</emphasis> in Rivendell is simply a
device or facility for device or facility for
getting audio into and/or out of a host on a realtime basis. getting audio into and/or out of a host on a realtime basis.
Most commonly this will be a sound card, although other, more Often this will be a sound card, although other
exotic possibilities (using TCP/IP networking or direct routing possibilities (such as AoIP or direct routing
to other audio applications) also exist. The three main classes to other audio applications) also exist. The three main classes
of audio adapters supported by Rivendell are: of audio adapters supported by Rivendell are:
</para> </para>
@ -251,7 +250,7 @@
to high-end cards aimed at professional audio uses. to high-end cards aimed at professional audio uses.
More information, including a current list of supported More information, including a current list of supported
cards, is available at the ALSA web site, cards, is available at the ALSA web site,
http://www.alsa-project.org/. <link xlink:href="http://www.alsa-project.org/">http://www.alsa-project.org/</link>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -266,7 +265,8 @@
specially aimed for use in that setting. They are so-called specially aimed for use in that setting. They are so-called
because Rivendell uses AudioScience's special 'HPI' driver because Rivendell uses AudioScience's special 'HPI' driver
to access and control them. More information is available to access and control them. More information is available
at AudioScience's web site, http://www.audioscience.com/. at AudioScience's web site at
<link xlink:href="http://www.audioscience.com/">http://www.audioscience.com/</link>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -274,15 +274,15 @@
<term>JACK Audio Interconnect Kit</term> <term>JACK Audio Interconnect Kit</term>
<listitem> <listitem>
<para> <para>
JACK is not a particular set of hardware devices, but rather JACK is not a class of hardware devices, but rather
an audio 'framework' that allows compliant applications to an audio 'framework' that allows compliant applications to
share audio resources and route audio in realtime amongst share audio resources and route audio in realtime amongst
themselves. JACK is different from similar efforts within themselves. JACK is different from similar efforts within
the Linux realm in that it was designed from the ground up the Linux realm in that it was designed from the ground up
for professional audio work, with particular focus upon for professional audio work, with particular focus upon
low-latency operation and synchronous execution of all low-latency operation and synchronous execution of all
clients. More information can be found at the JACK web clients. More information can be found at the JACK web
site, http://jackit.sourceforge.net/. site, <link xlink:href="https://jackaudio.org/">https://jackaudio.org/</link>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -319,7 +319,7 @@
the scope of this document. Readers are encouraged to consult the scope of this document. Readers are encouraged to consult
a good handbook on radio engineering for more information. a good handbook on radio engineering for more information.
A current list of GPIO/Switcher devices supported by Rivendell A current list of GPIO/Switcher devices supported by Rivendell
can be found in 'docs/GPIO.txt' file in the Rivendell sources. can be found in <xref linkend="appendix.gpio_switcher_devices" />.
</para> </para>
</sect3> </sect3>
</sect2> </sect2>