Retail use productname #12185 keichwa (#487)

* make more use of productname macro and redef smr
* avoid misleading support statements (uyuni)
* disable UEFI statement on uyuni
* Update modules/retail/pages/retail-requirements.adoc
Co-authored-by: Lana Brindley <lbrindley@suse.de>

modules/ROOT/pages/_partials/entities.adoc

@@ -15,7 +15,7 @@
 :productname:
 :productproxy: {productname} Proxy
 :susemgr: SUSE Manager
-:smr: {productname} for Retail
+:smr: for Retail
 :uyuni: Uyuni
 :smrproductnumber: 4.1
 :slepos: SUSE Linux Enterprise Point of Service

modules/retail/nav-retail-guide.adoc

@@ -32,11 +32,18 @@ endif::[]
 *** xref:retail-mass-config.adoc[Mass Configuration]
 *** xref:retail-mass-config-yaml.adoc[Mass Configuration YAML Example]
 *** xref:retail-delta-images.adoc[Delta Images]
+
 // Retail Upgrade
 ** xref:retail-migration-intro.adoc[Retail Upgrade]
+
+ifeval::[{suma-content} == true]
 *** xref:retail-prepare-migration.adoc[Prepare for Migration]
 *** xref:retail-migration-slepostosuma.adoc[Migrate SLEPOS to SUMA]
+endif::[]
+
+// FIXME: Adjust for Uyuni
 *** xref:retail-upgrade-branchserver.adoc[Upgrade Branch Server]
+
 // End matter
 ** xref:retail-next.adoc[What Next?]
 

modules/retail/pages/retail-admin.adoc

@@ -1,5 +1,5 @@
 [[retail-admin]]
 = Administration
 
-This sections contains notes on administering your {smr} installation.
+This sections contains notes on administering your {productname} {smr} installation.
 For general administration tasks, see the {productname} documentation at https://documentation.suse.com/suma/4.0/.

modules/retail/pages/retail-components.adoc

@@ -1,14 +1,14 @@
 [[retail-components]]
 = Components
 
-{smr} is made up of various components.
+{productname} {smr} is made up of various components.
 For more on how these components work together, see xref:retail-network-arch.adoc[].
 
 
 
-== The {susemgr} Server
+== The {productname} Server
 
-The {susemgr} server contains information about infrastructure, network topology, and everything required to automate image deployment and perform day-to-day operations on branches and terminals.
+The {productname} server contains information about infrastructure, network topology, and everything required to automate image deployment and perform day-to-day operations on branches and terminals.
 This can include database entries of registered systems, Salt pillar data for images, image assignments, partitioning, network setup, network services, and more.
 
 
@@ -32,28 +32,28 @@ The branch server can also manage local networking, and provide DHCP and DNS ser
 
 Point-of-Service (POS) terminals can come in many different formats, such as point-of-sale terminals, kiosks, digital scales, self-service systems, and reverse-vending systems.
 Every terminal, however, is provided by a vendor, who set basic information about the device in the firmware.
-{smr} accesses this vendor information to determine how best to work with the terminal in use.
+{productname} {smr} accesses this vendor information to determine how best to work with the terminal in use.
 
 In most cases, different terminals will require a different operating system (OS) image to ensure they work correctly.
 For example, an information kiosk has a high-resolution touchscreen, where a cashier terminal might only have a very basic display.
 While both of these terminals require similar processing and network functionality, they will require different OS images.
 The OS images ensure that the different display mechanisms work correctly.
 
-{smr} supports POS terminals that boot using both BIOS and UEFI.
+{productname} {smr} supports POS terminals that boot using both BIOS and UEFI.
 For UEFI booting terminals, you will need to configure the EFI partition in the Saltboot formula.
 For more information on EFI in the Saltboot formula, see xref:salt:formula-saltboot.adoc[].
 
 
 
 == Fitting It All Together
 
-{smr} uses the same technology as {susemgr}, but is customized to address the needs of retail organizations.
+{productname} {smr} uses the same technology as {productname}, but is customized to address the needs of retail organizations.
 
 
 
 === Hardware Types
 
-Because every environment is different, and can contain many different configurations of many different terminals, {smr} uses hardware types to simplify device management.
+Because every environment is different, and can contain many different configurations of many different terminals, {productname} {smr} uses hardware types to simplify device management.
 
 Hardware types allow you to group devices according to manufacturer and device name.
 Then all devices of a particular type can be managed as one.
@@ -62,7 +62,7 @@ Then all devices of a particular type can be managed as one.
 
 === Branch System Groups
 
-{smr} uses system groups to organize the various devices in your environment.
+{productname} {smr} uses system groups to organize the various devices in your environment.
 
 Each branch requires a system group, containing a single branch server, and the POS terminals associated with that server.
 Each system group is identified with a Branch ID.
@@ -72,11 +72,11 @@ The Branch ID is used in formulas and scripts to automatically update the entire
 
 === Salt Formulas
 
-{smr} uses Salt formulas to help simplify configuration.
+{productname} {smr} uses Salt formulas to help simplify configuration.
 Formulas are pre-written Salt states, that are used to configure your installation.
 
 You can use formulas to apply configuration patterns to your hardware groups.
-{smr} uses the Saltboot formula, which defines partitioning and OS images for terminals.
+{productname} {smr} uses the Saltboot formula, which defines partitioning and OS images for terminals.
 
 You can use default settings for formulas, or edit them to make them more specific to your environment.
 
@@ -86,7 +86,7 @@ For more information about formulas, see xref:retail:retail-formulas-intro.adoc[
 
 === Saltboot
 
-Saltboot is a collection of tools and processes that are used to bootstrap, deploy and validate {smr} terminals.
+Saltboot is a collection of tools and processes that are used to bootstrap, deploy and validate {productname} {smr} terminals.
 
 Saltboot consists of:
 

modules/retail/pages/retail-deploy-section.adoc

@@ -1,4 +1,4 @@
 [[retail.deploy]]
 = Deploying Terminals
 
-This section covers how to prepare your {smr} installation for image deployment, and how to deploy terminals using network boot and other methods.
+This section covers how to prepare your {productname} {smr} installation for image deployment, and how to deploy terminals using network boot and other methods.

modules/retail/pages/retail-deploy-terminals-other.adoc

@@ -13,43 +13,43 @@ For more information, see xref:retail:retail-deploy-terminals.adoc[].
 
 [IMPORTANT]
 ====
-After you have registered new terminals, always check the {susemgr} {webui} to ensure your terminals have connected successfully to the branch server, and not directly to the {susemgr} Server by mistake.
+After you have registered new terminals, always check the {productname} {webui} to ensure your terminals have connected successfully to the branch server, and not directly to the {productname} Server by mistake.
 ====
 
 
 
 == Deploy Terminals with a Removable USB Device
 
 If you do not want to boot terminals from the network, you can create a live USB image and deploy terminals using a removable USB storage device.
-This is useful if you cannot boot your terminals from the network, or if you do not have a local {smr} branch server providing network services.
+This is useful if you cannot boot your terminals from the network, or if you do not have a local {productname} {smr} branch server providing network services.
 
-You can prepare a bootable USB device with the image and tools required to deploy a POS terminal using a remote {smr} branch server.
-You can create the bootable USB device on the branch server directly, or on the {smr} Server.
+You can prepare a bootable USB device with the image and tools required to deploy a POS terminal using a remote {productname} {smr} branch server.
+You can create the bootable USB device on the branch server directly, or on the {productname} {smr} Server.
 
 [NOTE]
 ====
-POS devices booted using the USB device are assigned to the {smr} branch server that created the USB device.
+POS devices booted using the USB device are assigned to the {productname} {smr} branch server that created the USB device.
 ====
 
 
 
 .Procedure: Creating a Bootable USB Device
-. On the {smr} branch server, at the command prompt, as root, create the POS image.
-    You need to specify the size of the image, in megabytes.
-    Ensure you allow at least 300{nbsp}MB:
+. On the {productname} {smr} branch server, at the command prompt, as root, create the POS image.
+You need to specify the size of the image, in megabytes.
+Ensure you allow at least 300{nbsp}MB:
 +
 ----
 salt-call image_sync_usb.create <usb image name> <size in MB>
 ----
-. Insert the USB device into the {smr} branch server machine, and copy the image to the new location:
+. Insert the USB device into the {productname} {smr} branch server machine, and copy the image to the new location:
 +
 ----
 dd bs=1M if=<usb image name> of=<path to usb device>
 ----
 
 
 When you have the image on the USB drive, check that the terminals you want to deploy allow local booting.
-You can check this by editing the Saltboot formula in the {smr} {webui}.
+You can check this by editing the Saltboot formula in the {productname} {smr} {webui}.
 For more information about the Saltboot formula, see xref:salt:formula-saltboot.adoc[].
 
 
@@ -73,7 +73,7 @@ For more information about using USB devices to boot, see xref:retail:retail-dep
 ====
 Bootstrapping across a wireless network could expose a security risk if you are using encrypted OS images.
 The boot ``initrd`` image and the partition that contains ``/etc/salt`` must be stored unencrypted on the terminal.
-This allows {smr} to set up the wireless network.
+This allows {productname} {smr} to set up the wireless network.
 If this breaches your security requirements, you will need to use a separate production network, with network credentials managed by Salt, so that credentials are not stored on the terminal unencrypted.
 ====
 
@@ -120,8 +120,9 @@ WIRELESS_WPA_PSK=<wireless network password>
 echo ./etc/sysconfig/network/ifcfg-wlan0 | cpio -H newc -o | gzip >> /srv/saltboot/boot/initrd.gz
 ----
 . Check that the terminals you want to deploy allow local booting.
-    You can check this by editing the Saltboot formula in the {smr} {webui}.
-    For more information about the Saltboot formula, see xref:salt:formula-saltboot.adoc[].
+You can check this by editing the Saltboot formula in the {productname} {smr} {webui}.
+For more information about the Saltboot formula, see xref:salt:formula-saltboot.adoc[].
+
 
 
 .Procedure: Providing Wireless Credentials During Terminal Boot

modules/retail/pages/retail-deploy-terminals.adoc

@@ -2,7 +2,7 @@
 = Deploy Terminals
 
 
-When you have the {susemgr} Server and Branch Server set up, you are ready to deploy point-of-service terminals by following these steps:
+When you have the {productname} Server and Branch Server set up, you are ready to deploy point-of-service terminals by following these steps:
 
 . Create hardware type groups
 . Assign and configure the Saltboot formula for each hardware type group
@@ -20,16 +20,16 @@ For how to build OS images, see xref:administration:image-management.adoc[].
 
 [IMPORTANT]
 ====
-After you have registered new terminals, always check the {susemgr} {webui} to ensure your terminals have connected successfully to the branch server, and not directly to the {susemgr} Server by mistake.
+After you have registered new terminals, always check the {productname} {webui} to ensure your terminals have connected successfully to the branch server, and not directly to the {productname} Server by mistake.
 ====
 
 
 
 == Create A Hardware Type Group
 
 Each terminal requires a specific hardware type, which contains information about the product name and terminal manufacturer.
-However, at the beginning, the {susemgr} database does not have this information.
-To tell {susemgr} what image to deploy on each terminal, you can set hardware type groups.
+However, at the beginning, the {productname} database does not have this information.
+To tell {productname} what image to deploy on each terminal, you can set hardware type groups.
 After you have created your new hardware type group, you can apply the Saltboot formula to the group and configure it for your environment.
 
 Hardware types allow you to group devices according to manufacturer and device name.
@@ -51,7 +51,7 @@ For this procedure, you will require the system manufacturer name and product na
 ----
 HWTYPE:POSVendor-Terminal1
 ----
-. In the {susemgr} {webui}, navigate to menu:Systems[System Groups], and click the btn:[Create Group] button.
+. In the {productname} {webui}, navigate to menu:Systems[System Groups], and click the btn:[Create Group] button.
 . In the [guimenu]``Create System Group`` dialog, create a new system group, using the hardware type group name you determined in step one of this procedure.
 
 [IMPORTANT]
@@ -79,7 +79,7 @@ Each hardware type group must have the Saltboot formula applied.
 
 .Procedure: Synchronizing Images to the Branch Server
 
-. On the {susemgr} server, run this command:
+. On the {productname} server, run this command:
 +
 ----
 salt <branch_server_salt_id> state.apply image-sync

modules/retail/pages/retail-formulas-intro.adoc

@@ -2,20 +2,20 @@
 = Introduction to Retail Formulas
 
 
-Formulas are pre-written Salt states, that are used to configure your {smr} installation.
+Formulas are pre-written Salt states, that are used to configure your {productname} {smr} installation.
 
 You can use the {productname} {webui} to apply common {productname} formulas.
 For the most commonly used formulas, see xref:salt:formulas-intro.adoc[].
 
-All formulas must be accurately configured for your {smr} installation to function correctly.
+All formulas must be accurately configured for your {productname} {smr} installation to function correctly.
 If you are unsure of the correct formula configuration details, run the [command]``retail_branch_init`` command before you begin to create the recommended formula configuration.
 You can then manually edit the formulas as required.
 
 == Branch Server Formulas
 
 Branch servers are configured using formulas. 
-Formulas can be configured using {susemgr} {webui}, or the {susemgr} XMLRPC API.
-To fully configure {smr}, these formulas need to be enabled and configured on the branch server:
+Formulas can be configured using {productname} {webui}, or the {productname} XMLRPC API.
+To fully configure {productname} {smr}, these formulas need to be enabled and configured on the branch server:
 
 * Branch network formula, see xref:salt:formula-branchnetwork.adoc[]
 * Bind formula, see xref:salt:formula-bind.adoc[]
@@ -31,7 +31,7 @@ For more information, see xref:salt:formula-imagesync.adoc[].
 ====
 Badly configured formulas can result in the branch server failing to work as expected.
 Due to the generic nature of formulas it is difficult to do overall validation.
-We recommend that you configure the branch server using the {smr} command line utilities, and use individual formula settings for further tuning if required.
+We recommend that you configure the branch server using the {productname} {smr} command line utilities, and use individual formula settings for further tuning if required.
 For more information, see xref:retail:retail-install-setup.adoc[].
 ====