Introduction to Retail Formulas
Formulas are pre-written Salt states, that are used to configure your Uyuni for Retail installation.
You can use the Uyuni Web UI to apply common Uyuni formulas. For the most commonly used formulas, see specialized-guides:salt/salt-formulas-intro.adoc.
All formulas must be accurately configured for your Uyuni 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.
Branch servers are configured using formulas. Formulas can be configured using Uyuni Web UI, or the Uyuni XMLRPC API. To fully configure Uyuni for Retail, these formulas need to be enabled and configured on the branch server:
Branch network formula, see specialized-guides:salt/salt-formula-branchnetwork.adoc
Bind formula, see specialized-guides:salt/salt-formula-bind.adoc
DHCPD formula, see specialized-guides:salt/salt-formula-dhcpd.adoc
PXE formula, see specialized-guides:salt/salt-formula-pxe.adoc
TFTP formula, see specialized-guides:salt/salt-formula-tftpd.adoc
VSFTP formula, see specialized-guides:salt/salt-formula-vsftpd.adoc
Optionally, you can also enable the image synchronization formula. For more information, see specialized-guides:salt/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 Uyuni for Retail command line utilities, and use individual formula settings for further tuning if required. For more information, see retail:retail-install-setup.adoc.
If a formula uses the same name as an existing Salt state, the two names will collide. This could result in the formula being used instead of the state. Always check the names of states and formulas to avoid name collisions.
When you have made changes to your formula, ensure you apply the highstate. The highstate propagates your changes to the appropriate services.
Use the Saltboot formula to specify disk partitioning, and to select which image should be deployed. For more information about the Saltboot formula, see specialized-guides:salt/salt-formula-saltboot.adoc.