2023-10-26 Fred Gleason <fredg@paravelsystems.com>

* Added 'Realms' to 'The Rivendell Object Paradigm' section of the
	Operations Guide.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason 2023-10-26 17:04:08 -04:00
parent 0d38190eed
commit a634b46cfb
3 changed files with 47 additions and 8 deletions

View File

@ -24430,3 +24430,6 @@
from being updated when the logged-in user changed. from being updated when the logged-in user changed.
2023-10-10 Fred Gleason <fredg@paravelsystems.com> 2023-10-10 Fred Gleason <fredg@paravelsystems.com>
* Incremented the package version to 4.1.0int1. * Incremented the package version to 4.1.0int1.
2023-10-26 Fred Gleason <fredg@paravelsystems.com>
* Added 'Realms' to 'The Rivendell Object Paradigm' section of the
Operations Guide.

View File

@ -126,11 +126,14 @@
<sect2 xml:id="sect.overview.the_rivendell_object_paradigm"> <sect2 xml:id="sect.overview.the_rivendell_object_paradigm">
<title>The Rivendell Object Paradigm</title> <title>The Rivendell Object Paradigm</title>
<para> <para>
All Rivendell modules make use of the following four classes of All Rivendell modules make use of the following classes of
system resources: system resources:
</para> </para>
<para> <para>
<itemizedlist> <itemizedlist>
<listitem>
<link linkend="sect.overview.realms">Realms</link>
</listitem>
<listitem> <listitem>
<link linkend="sect.overview.hosts">Hosts</link> <link linkend="sect.overview.hosts">Hosts</link>
</listitem> </listitem>
@ -148,22 +151,53 @@
<para> <para>
We'll cover each of these concepts in turn. We'll cover each of these concepts in turn.
</para> </para>
<sect3 xml:id="sect.overview.realms">
<title>Realms</title>
<para>
A Rivendell <emphasis>realm</emphasis> is a set of one or more
hosts that utilize a common Rivendell database. Each such
realm has its own, independent set of objects, such as cart library,
RDCatch event list, set of hosts, etc. Different Rivendell realms
are effectively isolated from each other at the application level.
</para>
<caution>
If more than one Rivendell realm will be residing in a single
IP multicast domain, then each realm must be assigned a unique
multicast notification address. See &quot;Multicast Address for
Notifications&quot; in the
<xref linkend="sect.rdadmin.manage_system_settings" />.
</caution>
</sect3>
<sect3 xml:id="sect.overview.hosts"> <sect3 xml:id="sect.overview.hosts">
<title>Hosts</title> <title>Hosts</title>
<para> <para>
Every physical computer within a given network that is running Every physical or virtual computer that is running
Rivendell software is referred to as a <emphasis>host</emphasis>. Rivendell software is referred to as a <emphasis>host</emphasis>.
Any host in a Any host in a
Rivendell network can be individually configured and controlled Rivendell network can be individually configured and controlled
from any other host (provided the system administrator has enabled from any other host within the same realm (provided the system
this capability). Hosts can be used for a wide variety of administrator has enabled 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 automatic recording (sometimes referred to as
&quot;netcatching&quot;), &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 a
<emphasis>playlist</emphasis>)
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.
</para> </para>
<para>
Each Rivendell host is a member of precisely one
<link linkend="sect.overview.realms">Rivendell realm</link>.
Each host within a given realm must be reachable from all other hosts
in that realm and reside within the same IP multicast domain.
In most cases, this can be ensured by connecting all hosts to the
same network switch and configuring them to use the same IP subnet.
If this is not feasible, then special arrangements, such as
installation of a network bridge or multicast router between the
host subnets will be necessary.
</para>
</sect3> </sect3>
<sect3 xml:id="sect.overview.users"> <sect3 xml:id="sect.overview.users">
<title>Users</title> <title>Users</title>

View File

@ -2705,7 +2705,8 @@
<title>Managing System Settings</title> <title>Managing System Settings</title>
<para> <para>
To manage system-wide settings --i.e. those settings that apply to To manage system-wide settings --i.e. those settings that apply to
<emphasis>all</emphasis> Rivendell hosts -- in RDAdmin, touch the <emphasis>all</emphasis> Rivendell hosts in a given realm -- in RDAdmin,
touch the
<computeroutput>System Settings</computeroutput> button to open <computeroutput>System Settings</computeroutput> button to open
the System-Wide Settings dialog. the System-Wide Settings dialog.
</para> </para>
@ -2721,8 +2722,9 @@
</para> </para>
<para> <para>
The <computeroutput>Realm Name:</computeroutput> field takes a string The <computeroutput>Realm Name:</computeroutput> field takes a string
that identifies the complete set of Rivendell hosts that share a that identifies the name of the
common database. It should be globally unique. <link linkend="sect.overview.realms">database realm</link>.
It should be globally unique.
</para> </para>
<para> <para>
The <computeroutput>System Sample Rate:</computeroutput> dropdown sets The <computeroutput>System Sample Rate:</computeroutput> dropdown sets