Rework glossary (#2950)

* Move glossary to reference file
* Remove unnecessary emphasis

Emphasis is not needed. See
"guides/common/modules/con_download-policies-overview.adoc" and the
rendered output on "Managing Content" > "Download policies overview".

$ sed -i "s/\*::/::/g" guides/common/modules/ref_glossary-of-terms.adoc
$ sed -i "s/^\*//g" guides/common/modules/ref_glossary-of-terms.adoc

* Remove duplicate empty lines

$ sed -i "/^$/N;/^\n$/D" guides/common/modules/ref_glossary-of-terms.adoc
$ git diff --ignore-blank-lines # returns no diff

* Add CLI help reference
* Add link to assembly
* Add title to link
* Always capitalize "Enterprise Linux"
* Do not use attribute in anchors
* Drop entry for Foreman services
* Drop entry for job template
* Drop entry for scenario
* Drop glossary entry for SOE 
* Fix anchor for Migrating Foreman
* Fix capitalization of glossary entries
* Fix emphasis for directory path
* Fix list of RHEL derivatives
* Follow capitalization rules from "./CONTRIBUTING.md"
* Hide Trends for orcharhino and Satellite
* Order entries in alphabetical order
* Removed note that
* Rename anchors
* Rename entry for sync plans
* Rename glossary file
* Reword deprecation warning
* Rework branding for SmartProxy
* Shorten anchors
* Unset numbered attribute
* Use attributes whenever possible

CONTRIBUTING.md

@@ -66,6 +66,7 @@ We capitalize the following terms:
 * Chef
 * Deb (content type)
 * Discovery (service)
+* Enterprise Linux (umbrella term for RHEL-derivatives)
 * Hammer
 * Insights (Red Hat product)
 * Kickstart

guides/common/modules/ref_cli-help.adoc

@@ -0,0 +1,26 @@
+[id="cli-help_{context}"]
+= CLI help
+
+{Project} offers multiple user interfaces: {ProjectWebUI}, Hammer CLI, API, and through Ansible collection {ansible-namespace}.
+If you want to administer {Project} on the command line, have a look at the following help output.
+
+[[Services]]
+{Project} services:: A set of services that {ProjectServer} and {SmartProxyServers} use for operation.
+You can use the `{foreman-maintain}` tool to manage these services.
+To see the full list of services, enter the `{foreman-maintain} service list` command on the machine where {Project} or {SmartProxyServer} is installed.
+For more information, run `{foreman-maintain} --help` on your {ProjectServer} or {SmartProxyServer}.
+
+[[Plugins]]
+{Project} plugins:: You can extend {Project} by installing plugins.
+For more information, run `{foreman-installer} --full-help` on your {ProjectServer} or {SmartProxyServer}.
+
+[[Hammer_CLI]]
+Hammer CLI:: You can manage {Project} on the command line using `hammer`.
+For more information on using Hammer CLI,
+ifdef::orcharhino[]
+see xref:sources/installation_and_maintenance/using_hammer_cli.adoc[Using Hammer CLI] or
+endif::[]
+ifdef::satellite[]
+see {HammerDocURL}[{HammerDocTitle}] or
+endif::[]
+run `hammer --help` on your {ProjectServer} or {SmartProxyServer}.

guides/common/modules/ref_glossary-of-terms-used-in-project.adoc

@@ -0,0 +1,350 @@
+[id="glossary-of-terms-used-in-{project-context}_{context}"]
+= Glossary of terms used in {Project}
+
+[[Activation_key]]
+Activation key:: A token for host registration and subscription attachment.
+Activation keys define subscriptions, products, content views, and other parameters to be associated with a newly created host.
+
+[[Answer_file]]
+Answer file:: A configuration file that defines settings for an installation scenario.
+Answer files are defined in the YAML format and stored in the `/etc/foreman-installer/scenarios.d/` directory.
+
+[[ARF_report]]
+ARF report:: The result of an OpenSCAP audit.
+Summarizes the security compliance of hosts managed by {ProjectName}.
+
+[[Audits]]
+Audits:: Provide a report on changes made by a specific user.
+Audits can be viewed in the {ProjectWebUI} under *Monitor* > *Audits*.
+
+[[Baseboard_management_controller_BMC]]
+Baseboard management controller (BMC):: Enables remote power management of bare-metal hosts.
+In {Project}, you can create a BMC interface to manage selected hosts.
+
+[[Boot_disk]]
+Boot disk:: An ISO image used for PXE-less provisioning.
+This ISO enables the host to connect to {ProjectServer}, boot the installation media, and install the operating system.
+There are several kinds of boot disks: *host image*, *full host image*, *generic image*, and *subnet image*.
+
+ifdef::satellite[]
+[[SmartProxy]]
+{SmartProxy}:: An additional server that can be used in a {ProjectName} deployment to facilitate content federation and distribution (act as a Pulp mirror), and to run other localized services (Puppet server, *DHCP*, *DNS*, *TFTP*, and more).
+{SmartProxies} are useful for {Project} deployment across various geographical locations.
+In upstream Foreman terminology, {SmartProxy} is referred to as Smart Proxy.
+endif::[]
+
+[[Catalog]]
+Catalog:: A document that describes the desired system state for one specific host managed by Puppet.
+It lists all of the resources that need to be managed, as well as any dependencies between those resources.
+Catalogs are compiled by a Puppet server from Puppet Manifests and data from Puppet Agents.
+
+[[Candlepin]]
+Candlepin:: A service within Katello responsible for subscription management.
+
+[[Compliance_policy]]
+Compliance policy:: Refers to a scheduled task executed on {ProjectServer} that checks the specified hosts for compliance against SCAP content.
+
+[[Compute_profile]]
+Compute profile:: Specifies default attributes for new virtual machines on a compute resource.
+
+[[Compute_resource]]
+Compute resource:: A virtual or cloud infrastructure, which {ProjectName} uses for deployment of hosts and systems.
+Examples include {oVirt}, {OpenStack}, EC2, and VMWare.
+
+[[Container]]
+Container (Docker container):: An isolated application sandbox that contains all runtime dependencies required by an application.
+{Project} supports container provisioning on a dedicated compute resource.
+
+[[Container_image]]
+Container image:: A static snapshot of the container’s configuration.
+{Project} supports various methods of importing container images as well as distributing images to hosts through content views.
+
+[[Content]]
+Content:: A general term for everything {Project} distributes to hosts.
+Includes software packages (RPM files), or Docker images.
+Content is synchronized into the Library and then promoted into lifecycle environments using content views so that they can be consumed by hosts.
+
+[[Content_delivery_network_CDN]]
+Content delivery network (CDN):: The mechanism used to deliver Red{nbsp}Hat content to {ProjectServer}.
+
+[[Content_host]]
+Content host:: The part of a host that manages tasks related to content and subscriptions.
+
+[[Content_view]]
+Content view:: A subset of Library content created by intelligent filtering.
+Once a content view is published, it can be promoted through the lifecycle environment path, or modified using incremental upgrades.
+
+[[Discovered_host]]
+Discovered host:: A bare-metal host detected on the provisioning network by the Discovery plugin.
+
+[[Discovery_image]]
+Discovery image:: Refers to the minimal operating system based on {EL} that is PXE-booted on hosts to acquire initial hardware information and to communicate with {ProjectServer} before starting the provisioning process.
+
+[[Discovery_plugin]]
+Discovery plugin:: Enables automatic bare-metal discovery of unknown hosts on the provisioning network.
+The plugin consists of three components: services running on {ProjectServer} and {SmartProxyServer}, and the Discovery image running on host.
+
+[[Discovery_rule]]
+Discovery rule:: A set of predefined provisioning rules which assigns a host group to discovered hosts and triggers provisioning automatically.
+
+[[Docker_tag]]
+Docker tag:: A mark used to differentiate container images, typically by the version of the application stored in the image.
+In the {ProjectWebUI}, you can filter images by tag under *Content* > *Docker Tags*.
+
+ifndef::satellite[]
+[[Enterprise_Linux]]
+Enterprise Linux:: An umbrella term for the following {RHEL}-like operating systems:
+
+* AlmaLinux
+* CentOS Linux
+* CentOS Stream
+* Oracle Linux
+* {RHEL}
+* Rocky Linux
+
+ifndef::orcharhino[]
+{Project} is tested on AlmaLinux and CentOS Stream.
+endif::[]
+endif::[]
+
+[[ERB]]
+ERB:: Embedded Ruby (ERB) is a template syntax used in provisioning and job templates.
+
+[[Errata]]
+Errata:: Updated RPM packages containing security fixes, bug fixes, and enhancements.
+In relationship to a host, erratum is *applicable* if it updates a package installed on the host and *installable* if it is present in the host's content view (which means it is accessible for installation on the host).
+
+[[External_node_classifier]]
+External node classifier:: A construct that provides additional data for a server to use when configuring hosts.
+{ProjectName} acts as an External Node Classifier to Puppet servers in a {Project} deployment.
++
+The External Node Classifier will be removed in a future {Project} version.
+
+[[Facter]]
+Facter:: A program that provides information (facts) about the system on which it is run; for example, Facter can report total memory, operating system version, architecture, and more.
+Puppet modules enable specific configurations based on host data gathered by Facter.
+
+[[Facts]]
+Facts:: Host parameters such as total memory, operating system version, or architecture.
+Facts are reported by Facter and used by Puppet.
+
+[[Foreman]]
+Foreman:: The component mainly responsible for provisioning and content lifecycle management.
+ifdef::satellite[]
+Foreman is the main upstream counterpart of {ProjectName}.
+endif::[]
+
+[[Foreman_Hook]]
+Foreman hook:: An executable that is automatically triggered when an orchestration event occurs, such as when a host is created or when provisioning of a host has completed.
+ifdef::satellite,orcharhino[]
++
+Foreman hook functionality is deprecated and will be removed in a future {Project} version.
+endif::[]
+
+[[Full_host_image]]
+Full host image:: A boot disk used for PXE-less provisioning of a specific host.
+The full host image contains an embedded Linux kernel and init RAM disk of the associated operating system installer.
+
+[[Generic_image]]
+Generic image:: A boot disk for PXE-less provisioning that is not tied to a specific host.
+The generic image sends the host’s MAC address to {ProjectServer}, which matches it against the host entry.
+
+[[Hammer]]
+Hammer:: A command line tool for managing {ProjectName}.
+You can execute Hammer commands from the command line or utilize them in scripts.
+Hammer also provides an interactive shell.
+
+[[Host]]
+Host:: Refers to any system, either physical or virtual, that {ProjectName} manages.
+
+[[Host_collection]]
+Host collection:: A user defined group of one or more Hosts used for bulk actions such as errata installation.
+
+[[Host_group]]
+Host group:: A template for building a host.
+Host groups hold shared parameters, such as subnet or lifecycle environment, that are inherited by host group members.
+Host groups can be nested to create a hierarchical structure.
+
+[[Host_image]]
+Host image:: A boot disk used for PXE-less provisioning of a specific host.
+The host image only contains the boot files necessary to access the installation media on {ProjectServer}.
+
+[[Incremental_upgrade]]
+Incremental upgrade (of a content view):: The act of creating a new (minor) content view version in a lifecycle environment.
+Incremental upgrades provide a way to make in-place modification of an already published content view.
+Useful for rapid updates, for example when applying security errata.
+
+[[Job]]
+Job:: A command executed remotely on a host from {ProjectServer}.
+Every job is defined in a job template.
+
+[[Katello]]
+Katello:: A Foreman plugin responsible for subscription and repository management.
+
+[[Lazy_sync]]
+Lazy sync:: The ability to change the default download policy of a repository from *Immediate* to *On Demand*.
+The *On Demand* setting saves storage space and synchronization time by only downloading the packages when requested by a host.
+
+[[Location]]
+Location:: A collection of default settings that represent a physical place.
+
+[[Library]]
+Library:: A container for content from all synchronized repositories on {ProjectServer}.
+Libraries exist by default for each organization as the root of every lifecycle environment path and the source of content for every content view.
+
+[[Lifecycle_environment]]
+Lifecycle environment:: A container for content view versions consumed by the content hosts.
+A Lifecycle Environment represents a step in the lifecycle environment path.
+Content moves through lifecycle environments by publishing and promoting content views.
+
+[[Lifecycle_environment_path]]
+Lifecycle environment path:: A sequence of lifecycle environments through which the content views are promoted.
+You can promote a content view through a typical promotion path; for example, from development to test to production.
+
+[[Manifest]]
+Manifest (Red{nbsp}Hat subscription manifest):: A mechanism for transferring subscriptions from the Red{nbsp}Hat Customer Portal to {ProjectName}.
+Do not confuse with xref:Puppet_manifest[Puppet manifest].
+
+[[Migrating]]
+Migrating {Project}:: The process of moving an existing {Project} installation to a new instance.
+
+[[OpenSCAP]]
+OpenSCAP:: A project implementing security compliance auditing according to the Security Content Automation Protocol (SCAP).
+OpenSCAP is integrated in {Project} to provide compliance auditing for hosts.
+
+ifdef::orcharhino[]
+[[SmartProxy]]
+{SmartProxy}:: An additional server that can be used in a {ProjectName} deployment to facilitate content federation and distribution (act as a Pulp mirror), and to run other localized services (Puppet server, *DHCP*, *DNS*, *TFTP*, and more).
+{SmartProxies} are useful for {Project} deployment across various geographical locations.
+In upstream Foreman terminology, {SmartProxy} is referred to as Smart Proxy.
+endif::[]
+
+[[Organization]]
+Organization:: An isolated collection of systems, content, and other functionality within a {Project} deployment.
+
+[[Parameter]]
+Parameter:: Defines the behavior of {ProjectName} components during provisioning.
+Depending on the parameter scope, we distinguish between global, domain, host group, and host parameters.
+Depending on the parameter complexity, we distinguish between simple parameters (key-value pair) and smart parameters (conditional arguments, validation, overrides).
+
+[[Parametrized_class]]
+Parametrized class (smart class parameter):: A parameter created by importing a class from Puppet server.
+
+[[Permission]]
+Permission:: Defines an action related to a selected part of {Project} infrastructure (resource type).
+Each resource type is associated with a set of permissions, for example the *Architecture* resource type has the following permissions: *view_architectures*, *create_architectures*, *edit_architectures*, and *destroy_architectures*.
+You can group permissions into roles and associate them with users or user groups.
+
+[[Product]]
+Product:: A collection of content repositories.
+Products are either provided by Red{nbsp}Hat CDN or created by the {Project} administrator to group custom repositories.
+
+[[Promote]]
+Promote (a content view):: The act of moving a content view from one lifecycle environment to another.
+For more information, see {ContentManagementDocURL}Promoting_a_Content_View_content-management[Promoting a content view] in _{ContentManagementDocTitle}_.
+
+[[Provisioning_template]]
+Provisioning template:: Defines host provisioning settings.
+Provisioning templates can be associated with host groups, lifecycle environments, or operating systems.
+
+[[Publish]]
+Publish (a content view):: The act of making a content view version available in a lifecycle environment and usable by hosts.
+
+[[Pulp]]
+Pulp:: A service within Katello responsible for repository and content management.
+
+[[Pulp_mirror]]
+Pulp mirror:: A {SmartProxyServer} component that mirrors content.
+
+[[Puppet]]
+Puppet:: The configuration management component of {Project}.
+
+[[Puppet_agent]]
+Puppet agent:: A service running on a host that applies configuration changes to that host.
+
+[[Puppet_environment]]
+Puppet environment:: An isolated set of Puppet Agent nodes that can be associated with a specific set of Puppet Modules.
+
+[[Puppet_manifest]]
+Puppet manifest:: Refers to Puppet scripts, which are files with the *.pp* extension.
+The files contain code to define a set of necessary resources, such as packages, services, files, users and groups, and so on, using a set of key-value pairs for their attributes.
++
+Do not confuse with xref:Manifest[Manifest (Red{nbsp}Hat subscription manifest)].
+
+[[Puppet_server]]
+Puppet server:: A {SmartProxyServer} component that provides Puppet Manifests to hosts for execution by the Puppet Agent.
+
+[[Puppet_module]]
+Puppet module:: A self-contained bundle of code (Puppet Manifests) and data (facts) that you can use to manage resources such as users, files, and services.
+
+[[Recurring_logic]]
+Recurring logic:: A job executed automatically according to a schedule.
+In the {ProjectWebUI}, you can view those jobs under *Monitor* > *Recurring logics*.
+
+[[Registry]]
+Registry:: An archive of container images.
+{Project} supports importing images from local and external registries.
+{Project} itself can act as an image registry for hosts.
+However, hosts cannot push changes back to the registry.
+
+[[Repository]]
+Repository:: Provides storage for a collection of content.
+
+[[Resource_type]]
+Resource type:: Refers to a part of {Project} infrastructure, for example host, {SmartProxy}, or architecture.
+Used in permission filtering.
+
+[[Role]]
+Role:: Specifies a collection of permissions that are applied to a set of resources, such as hosts.
+Roles can be assigned to users and user groups.
+{Project} provides a number of predefined roles.
+
+[[SCAP_content]]
+SCAP content:: A file containing the configuration and security baseline against which hosts are checked.
+Used in compliance policies.
+
+ifndef::orcharhino,satellite[]
+[[SmartProxy]]
+{SmartProxy}:: A {SmartProxy} component that can integrate with external services, such as *DNS* or *DHCP*.
+{SmartProxies} are useful for {Project} deployment across various geographical locations.
+endif::[]
+
+[[Subnet_image]]
+Subnet image:: A type of generic image for PXE-less provisioning that communicates through {SmartProxyServer}.
+
+[[Subscription]]
+Subscription:: An entitlement for receiving content and service from Red{nbsp}Hat.
+
+[[Synchronization]]
+Synchronization:: Refers to mirroring content from external resources into the {ProjectName} Library.
+
+[[Sync_plan]]
+Sync plan:: Provides scheduled execution of content synchronization.
+
+[[Task]]
+Task:: A background process executed on the {Project} or {SmartProxyServer}, such as repository synchronization or content view publishing.
+You can monitor the task status in the {ProjectWebUI} under *Monitor* > *{Project} Tasks* > *Tasks*.
+
+ifndef::orcharhino,satellite[]
+[[Trend]]
+Trend:: A means of tracking changes in specific parts of {Project} infrastructure.
+Configure trends in {ProjectWebUI} under *Monitor* > *Trends*.
+Requires foreman_statistics plugin on your {ProjectServer}.
+endif::[]
+
+[[Updating]]
+Updating {Project}:: The process of advancing your {ProjectServer} and {SmartProxyServer} installations from a z-stream release to the next, for example {Project} {ProjectVersion}.0 to {Project} {ProjectVersion}.1.
+
+[[Upgrading]]
+Upgrading {Project}:: The process of advancing your {ProjectServer} and {SmartProxyServer} installations from a y-stream release to the next, for example {Project} {ProjectVersionPrevious} to {Project} {ProjectVersion}.
+
+[[User_group]]
+User group:: A collection of roles which can be assigned to a collection of users.
+
+[[User]]
+User:: Anyone registered to use {ProjectName}.
+Authentication and authorization is possible through built-in logic, through external resources (LDAP, Identity Management, or Active Directory), or with Kerberos.
+
+[[virt-who]]
+virt-who:: An agent for retrieving IDs of virtual machines from the hypervisor.
+When used with {Project}, virt-who reports those IDs to {ProjectServer} so that it can provide subscriptions for hosts provisioned on virtual machines.

guides/common/modules/ref_supported-operating-systems.adoc

@@ -13,8 +13,8 @@ The following operating systems are supported by the installer, have packages, a
 |====
 | Operating System | Architecture | Notes
 ifdef::foreman-el,katello,orcharhino[]
-| {PlanningDocURL}varl-Glossary_of_Terms-Enterprise_Linux[{EL}] 9 | x86_64 only | EPEL is not supported.
-| {PlanningDocURL}varl-Glossary_of_Terms-Enterprise_Linux[{EL}] 8 | x86_64 only | EPEL is not supported.
+| {PlanningDocURL}Enterprise_Linux[{EL}] 9 | x86_64 only | EPEL is not supported.
+| {PlanningDocURL}Enterprise_Linux[{EL}] 8 | x86_64 only | EPEL is not supported.
 endif::[]
 ifdef::satellite[]
 | {RHEL} 9 | x86_64 only |