diff --git a/ChangeLog b/ChangeLog index fa1bf378..afb6f7c5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -24430,3 +24430,6 @@ from being updated when the logged-in user changed. 2023-10-10 Fred Gleason * Incremented the package version to 4.1.0int1. +2023-10-26 Fred Gleason + * Added 'Realms' to 'The Rivendell Object Paradigm' section of the + Operations Guide. diff --git a/docs/opsguide/overview.xml b/docs/opsguide/overview.xml index 66144f04..68188bcc 100644 --- a/docs/opsguide/overview.xml +++ b/docs/opsguide/overview.xml @@ -126,11 +126,14 @@ The Rivendell Object Paradigm - All Rivendell modules make use of the following four classes of + All Rivendell modules make use of the following classes of system resources: + + Realms + Hosts @@ -148,22 +151,53 @@ We'll cover each of these concepts in turn. + + Realms + + A Rivendell realm 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. + + + 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 "Multicast Address for + Notifications" in the + . + + + Hosts - 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 host. Any host in a Rivendell network can be individually configured and controlled - from any other host (provided the system administrator has enabled - this capability). Hosts can be used for a wide variety of + from any other host within the same realm (provided the system + administrator has enabled this capability). + Hosts can be used for a wide variety of applications, including content ingestion and management, automatic recording (sometimes referred to as "netcatching"), - on-air play out or log (sometimes also referred to as playlist) + on-air play out or log (sometimes also referred to as a + playlist) generation. It is also possible for a single host to perform all of these functions. + + Each Rivendell host is a member of precisely one + Rivendell realm. + 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. + Users diff --git a/docs/opsguide/rdadmin.xml b/docs/opsguide/rdadmin.xml index d4546791..a99f99e7 100644 --- a/docs/opsguide/rdadmin.xml +++ b/docs/opsguide/rdadmin.xml @@ -2705,7 +2705,8 @@ Managing System Settings To manage system-wide settings --i.e. those settings that apply to - all Rivendell hosts -- in RDAdmin, touch the + all Rivendell hosts in a given realm -- in RDAdmin, + touch the System Settings button to open the System-Wide Settings dialog. @@ -2721,8 +2722,9 @@ The Realm Name: field takes a string - that identifies the complete set of Rivendell hosts that share a - common database. It should be globally unique. + that identifies the name of the + database realm. + It should be globally unique. The System Sample Rate: dropdown sets