Formulas are pre-written Salt states, that are used to configure your SUSE Manager for Retail installation.

This section lists the primary formulas shipped with SUSE Manager for Retail and their configuration options.

All the formulas in this section must be accurately configured for your SUSE Manager for Retail installation to function correctly. If you are unsure of the correct formula configuration details, run the retail_branch_init command before you begin to create the recommended formula configuration. You can then manually edit the formulas as required.

Important: State and formula name collisions

If a formula uses the same name as an existing Salt state, the two names will collide, and could result in the formula being used instead of the state. Always check the names of states and formulas to avoid name collisions.

Most formulas can be updated using the SUSE Manager Web UI. Once you have made changes to your formula, ensure you apply the highstate to propagate your changes to the appropriate services.

4.1 Bind Formula #

The Bind formula is used to configure the Domain Name System (DNS) on the branch server. POS terminals will use the DNS on the branch server for name resolution of saltboot specific hostnames.

When you are configuring the bind formula for a branch server with a dedicated internal network, check that you are using the same fully qualified domain name (FQDN) on both the external and internal branch networks. If the FQDN does not match on both networks, the branch server will not be recognized as a proxy server.

Note

The following procedure outlines a standard configuration with two zones. Adjust it to suit your own environment.

Zone 1 is a regular domain zone. Its main purpose is to resolve saltboot hostnames such as TFTP, FTP, or Salt. It can also resolve the terminal names if configured.

Zone 2 is the reverse zone of Zone 1. Its main purpose is to resolve IP addresses back to hostnames. Zone 2 is primarily needed for the correct determination of the FQDNs of the branch.

Procedure: Configuring Bind with Two Zones #

1. Check the Bind formula, and click Save.

2. Navigate to the Formulas → Bind tab, and set these parameters for Zone 1:

   • In the Config section, select Include Forwarders.

   • In the Name field, enter the domain name of your branch network (for example: branch1.example.org).

   • In the Type field, select master.

3. Click Add item to save your changes.

4. Set these parameters for Zone 2:

   • In the Name field, use the reverse zone for the configured IP range (for example: 1.168.192.in-addr.arpa).

   • In the Type field, select master

5. In the Available Zones section, use these parameters for Zone 1:

   • In the Name field, enter the domain name of your branch network (for example: branch1.example.org).

   • In the File field, type the name of your configuration file.

6. In the Start of Authority (SOA) section, use these parameters for Zone 1:

   • In the Nameserver (Ns) field, use the FQDN of the branch server (for example: branchserver.branch1.example.org).

   • In the Contact field, use the email address for the domain administrator.

   • Keep all other fields as their default values.

7. In the Records section, in subsection A, click Add Item and use these parameters to set up an A record for Zone 1:

   • In the Hostname field, use the hostname of the branch server (for example: branchserver).

   • In the IP field, use the IP address of the branch server (for example, 192.168.1.1).

8. In the Records section, subsection NS, click Add Item and use these parameters to set up an NS record for Zone 1:

   • In the input box, use the hostname of the branch server (for example: branchserver).

9. In the Records section, subsection CNAME, click on Add Item and add the hostname of the branch server in each of these fields:

   • tftp

   • ftp

   • dns

   • dhcp

   • salt. The salt CNAME should be the FQDN of the branch server’s external interface for proxy functionality to work correctly.

10. Set up Zone 2 using the same parameters as for Zone 1, but ensure you use the reverse details:

    • The same SOA section as Zone 1.

    • Empty A and CNAME records.

    • Additionally, configure in Zone 2:

      • Generate Reverse field by the network IP address set in branch server network formula (for example, 192.168.1.1/24).

      • For Zones should specify the domain name of your branch network (for example, branch1.example.org).

11. Click Save Formula to save your configuration.

12. Apply the highstate.

Important

Reverse name resolution on terminals might not work for networks that are inside one of these IPv4 private address ranges:

• 10.0.0.0/8

• 172.16.0.0/12

• 192.168.0.0/16

If you encounter this problem, go to the Options section of the Bind formula, and click Add item: * In the Options field, enter empty-zones-enable. * In the Value field, select No.

4.2 Branch Network Formula #

The branch network formula is used to configure the networking services required by the branch server, including DHCP, DNS, TFTP, PXE, and FTP.

The branch server can be configured to use networking in many different ways. The most common ways provide either a dedicated or shared LAN for terminals.

4.2.1 Set up a branch server with a dedicated LAN #

In this configuration, the branch server requires at least two network interfaces: one acts as a WAN to communicate with the SUSE Manager server, and the other one acts as an isolated LAN to communicate with terminals.

This configuration allows for the branch server to provide DHCP, DNS, TFTP, PXE and FTP services to terminals, which are configured through SUSE Manager for Retail formulas in the SUSE Manager Web UI.

Procedure: Setting up a branch server with a dedicated LAN #

1. In the SUSE Manager Web UI, open the details page for the branch server, and navigate to the Formulas tab.

2. In the Branch Network section, set these parameters:

   • Keep Dedicated NIC checked

   • In the NIC field, enter the name of the network device that is connected to the internal LAN.

   • In the IP field, enter the static IP address to be assigned to the branch server on the internal LAN.

   • In the Netmask field, enter the network mask of the internal LAN.

3. Check Enable Route if you want the branch server to route traffic from internal LAN to WAN.

   • Check Enable NAT if you want the branch server to convert addresses from internal LAN to WAN.

   • Select the bind DNS forwarder mode.

   • Check DNS forwarder fallback if you want to rely on an external DNS if the branch DNS fails.

   • Specify the working directory, and the directory owner and group.

4. Click Save to save your changes.

5. Apply the highstate.

4.2.2 Set up a branch server with a shared network #

In this configuration, the branch server has only one network interface card, which is used to connect to the SUSE Manager server as well as the terminals.

This configuration allows for the branch server to provide DNS, TFTP, PXE and FTP services to terminals, which are configured through SUSE Manager for Retail formulas in the SUSE Manager Web UI. Optionally, the branch server can also provide DHCP services in this configuration.

Note

If DHCP services are not provided by the branch server, ensure that your external DHCP configuration is set correctly:

• The next-server option must point to the branch server for PXE boot to work

• The filename option must correctly identify the network boot program (by default, this is /boot/pxelinux)

• The domain-name-servers option must point to the branch server for correct host name resolution

Procedure: Setting up a branch server with a shared network #

1. In the SUSE Manager Web UI, open the details page for the branch server, and navigate to the Formulas tab.

2. In the Branch Network section, set these parameters:

   • Keep Dedicated NIC unchecked

   • Select which services to enable on the branch server’s firewall. Ensure you include DNS, TFTP and FTP services.

   • Select the bind DNS forwarder mode.

   • Check DNS forwarder fallback if you want to rely on an external DNS if the branch DNS fails.

   • Specify the working directory, and the directory owner and group.

3. Click Save to save your changes.

4. Apply the highstate.

4.5 Saltboot Formula #

The Saltboot formula is used to configure disk images and partitioning for the selected hardware type.

Important

Saltboot formula is meant to be used as a group formula. Enable and configure saltboot formula for hardware type groups.

Procedure: Configuring the hardware type group with saltboot #

1. Open the details page for your new hardware type group, and navigate to the Formulas tab.

2. Select the saltboot-formula and click Save.

3. Navigate to the new Formulas → Saltboot tab.

4. In the Disk 1 section, set these parameters:

   • In the Disk symbolic ID field, enter a custom name for the disk (for example, disk1).

   • In the Device type field, select DISK.

   • In the Disk device field, select the device that corresponds to the device name on the target machine (for example, /dev/sda).

   • In the RAID level field, leave it empty.

   • In the Disk Label field, select gpt.

5. In the Partition section, set these parameters for Partition 1:

   • In the Partition symbolic ID field, enter a custom name for the partition (for example, p1).

   • In the Partition size field, specify a size for the partition in Mebibytes (MiB).

   • In the Device mount point field, select a location to mount the partition (for example, /data).

   • In the Filesystem format field, select your preferred format (for example, xfs).

   • In the OS Image to deploy field, leave it empty.

   • In the Partition encryption password field, enter a password if you want to encrypt the partition.

   • In the Partition flags field, leave it empty.

6. In the Partition section, set these parameters for Partition 2:

   • In the Partition symbolic ID field, enter a custom name for the partition (for example, p2).

   • In the Partition size field, specify a size for the partition in Mebibytes (MiB).

   • In the Device mount point field, leave it empty.

   • In the Filesystem format field, select swap.

   • In the OS Image to deploy field, leave it empty.

   • In the Partition encryption password field, enter a password if you want to encrypt the partition.

   • In the Partition flags field, select swap.

7. In the Partition section, set these parameters for Partition 3:

   • In the Partition symbolic ID field, enter a custom name for the partition (for example, p3).

   • In the Partition size field, leave it empty. This will ensure the partition uses up all remaining space.

   • In the Device mount point field, select /.

   • In the Filesystem format field, leave it empty.

   • In the OS Image to deploy field, enter the name of the image to deploy.

   • In the Image version field, leave it empty. This will ensure you use the latest available version.

   • In the Partition encryption password field, enter a password if you want to encrypt the partition.

   • In the Partition flags field, leave it empty.

8. Click Save Formula to save your formula.

Copyright © 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties—​for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

Copyright (c) YEAR YOUR NAME.
   Permission is granted to copy, distribute and/or modify this document
   under the terms of the GNU Free Documentation License, Version 1.2
   or any later version published by the Free Software Foundation;
   with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
   A copy of the license is included in the section entitled{ldquo}GNU
   Free Documentation License{rdquo}.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “ with…​Texts.” line with this:

with the Invariant Sections being LIST THEIR TITLES, with the
   Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.