21.46. universal - Universal Workflow Content

The following documentation is for Universal Workflow Content (universal) content package at version v4.8.0-alpha00.18+g1bb334a145011bcb806d362158e0a0095be432f8.

21.46.1. Universal

Universal Workflow architectural, Universal Workflow Architecture, and Universal Workflow operations, Universal Workflow Operations, contain more details about the universal workflow system.

The rest of this document contains the specific documentation for the individual content elements.

21.46.2. Object Specific Documentation

21.46.2.1. tasks

The content package provides the following tasks.

21.46.2.1.1. universal-bootstrap-prefs

A task to set the default preferences for default install. The values will be pulled from the universal/bootstrap-prefs Param, which is an object of key/value pairs. See the Param documentation for correct formatting and values that can be set.

NOTE: Will NOT change prefs if defaultWorkflow is set.

Also sets the Icon and icon Color for the machine if specified.

21.46.2.2. params

The content package provides the following params.

21.46.2.2.1. universal/esxi-config-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.2. universal/discover-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.3. universal/workflow-chain-index-override

This parameter replaces the universal/application as the index into the universal/workflow-chain-map. This allows for common maps to be used for similar universal applications.

21.46.2.2.4. universal/hardware

This is the comoposite string of information about the hardware. This is built by the classifier parts of universal. Tasks that build this can be injected to the workflows.

The format is dependent upon the classifier choosen.

21.46.2.2.5. universal/esxi-install-classification-base-data

This classifer is the default classifier for the universal-esxi-install-classification-base workflow.

21.46.2.2.6. universal/baseline/application

Parameter is used to name the baseline profiles. See universal/application for more information about application values.

21.46.2.2.7. universal/burnin-classification-base-functions

This is the list of functions to add for the universal-burnin-classification-base base classifier.

21.46.2.2.8. universal/esxi-config-classification-base-functions

This is the list of functions to add for the universal-esxi-config-classification-base base classifier.

21.46.2.2.9. universal/solidfire-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.10. universal/workflow-chain-map-skip-list

The list is a set of workflows that should be skipped when walking a workflow chain.

The default list is: universal-burnin

21.46.2.2.11. universal/esxi-kickstart-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.12. universal/local-classification-base-data

This classifer is the default classifier for the universal-local-classification-base workflow.

21.46.2.2.13. universal/esxi-install-classification-base-functions

This is the list of functions to add for the universal-esxi-install-classification-base base classifier.

21.46.2.2.14. universal/rack-build-bom-data

This classifer converts the rack/bom into a profile for hardware.

It does NOT use hardware. It assumes the BOM is hardware specific.

This classifer converts the rack/build into universal/application.

21.46.2.2.15. universal/rebuild-classification-base-functions

This is the list of functions to add for the universal-rebuild-classification-base base classifier.

21.46.2.2.16. universal/application

Indicate the application to install. discover, the default, is just a discovery pattern. Other options can be specified. These are associated with the profiles that drive configuration.

Known good values are:
discover baseline esxi67u1 esxi67u2 vCF-v3.5.1 vCF-v3.8.0 vCF-v3.8.1 EOS-v10.5.0.15 EOS-v11.3.1.5

21.46.2.2.17. universal/rebuild-classification-base-data

This classifer is the default classifier for the universal-rebuild-classification-base workflow.

21.46.2.2.18. universal/decommission-classification-base-functions

This is the list of functions to add for the universal-decommission-classification-base base classifier.

21.46.2.2.19. universal/esxi-install-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.20. universal/hardware-classification-base-functions

This is the list of functions to add for the universal-hardware-classification-base base classifier.

21.46.2.2.21. universal/baseline-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.22. universal/discover-classification-base-data

This classifer is the default classifier for the universal-discover-classification-base workflow.

21.46.2.2.23. universal/rebuild-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.24. universal/bootstrap-classification-base-functions

This is the list of functions to add for the universal-bootstrap-classification-base base classifier.

21.46.2.2.25. universal/solidfire-classification-base-functions

This is the list of functions to add for the universal-solidfire-classification-base base classifier.

21.46.2.2.26. universal/maintenance-classification-base-functions

This is the list of functions to add for the universal-maintenance-classification-base base classifier.

21.46.2.2.27. universal/decommission-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.28. universal/linux-install-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.29. universal/workflow-chain-map

The map is a key/value dictionary of workflow maps.

The key is the value of universal/application. The value map is a map of workflow to next workflow sequences.

Adding to your application:

universal-maintenance: universal-discover
universal-discover: universal-hardware
universal-hardware: universal-burnin

will enable the running of universal-discover and universal-hardware, but returning to universal-local when done. This allows for reinventoring and corrective hardware updates, but maintaining the installed system.

Adding to your application:

universal-rebuild: universal-discover

will enable the running of a clean rebuild of your system at the current systems. universal-discover is used as the basic entry point for the standard usage of this workflow.

21.46.2.2.30. universal/baseline/bom

This is the name of the Bill of Materials (BOM) for this hardware type. This is used when validate/record-parameters is set to define the name of the BOM.

Special value of “use_hw_base” will use the generated hardware type name and generate a profile without a BOM field component. This is the same as leaving this field unset.

21.46.2.2.31. universal/local-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.32. universal/local-classification-base-functions

This is the list of functions to add for the universal-local-classification-base base classifier.

21.46.2.2.33. universal/rack-build-bom-function

This is the list of functions to add for the rack-build-bom classifier.

21.46.2.2.34. universal/workflow-chain-override

This map overrides the map lookup for determining the next workflow.

The map is the current workflow to the next workflow.

21.46.2.2.35. universal/baseline-classification-base-functions

This is the list of functions to add for the universal-baseline-classification-base base classifier.

21.46.2.2.36. universal/burnin-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.37. universal/maintenance-classification-base-data

This classifer is the default classifier for the universal-maintenance-classification-base workflow.

21.46.2.2.38. universal/bootstrap-prefs

The map is a object of preference settings for a DRP Endpoint during self-bootstrap configuration.

Example, and default values if not otherwise specified:

YAML Format:

icon: chess queen
color: black
defaultWorkflow: universal-discover
defaultStage: discover
defaultBootEnv: sledgehammer
unknownBootEnv: discovery
skipChecks: false
force: false

JSON Format:

{
  "icon": "chess queen",
  "color": "black",
  "defaultWorkflow": "universal-discover",
  "defaultStage": "discover",
  "defaultBootEnv": "sledgehammer",
  "unknownBootEnv": "discovery",
  "skipChecks": true,
  "force": false
}

Note

If the system already has a defaultWorkflow configured, then these values will be ignored as a noop; unless the force: true option is set, then Preference settings will be force changed.

The only supported values are as described in the above Example/Defaults. Values must be in the exact upper/lower case format as shown in the example.

In addition, if skipChecks is set to true, then the safety existence tests for Workflow , Stages, and Bootenvs will be skipped.

21.46.2.2.39. universal/burnin-classification-base-data

This classifer is the default classifier for the universal-burnin-classification-base workflow.

21.46.2.2.40. universal/image-deploy-classification-base-functions

This is the list of functions to add for the universal-image-deploy-classification-base base classifier.

21.46.2.2.41. universal/image-deploy-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.42. universal/image-deploy-classification-base-data

This classifer is the default classifier for the universal-image-deploy-classification-base workflow.

21.46.2.2.43. universal/maintenance-mode

Indicate that we are should go back to local disk

21.46.2.2.44. universal/bom

Indicate the bill-of-materials (BOM) to verify.

This can be used to match a profile that has validation or other pieces of configuration based upon the machine type.

21.46.2.2.45. universal/discover-classification-base-functions

This is the list of functions to add for the universal-discover-classification-base base classifier.

21.46.2.2.46. universal/esxi-config-classification-base-data

This classifer is the default classifier for the universal-esxi-config-classification-base workflow.

21.46.2.2.47. universal/hardware-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.48. universal/linux-install-classification-base-data

This classifer is the default classifier for the universal-linux-install-classification-base workflow.

21.46.2.2.49. universal/baseline-classification-base-data

This classifer is the default classifier for the universal-baseline-classification-base workflow.

21.46.2.2.50. universal/rack-build-bom-disable

Should the rack build bom classifier be disabled

21.46.2.2.51. universal/hardware-classification-base-data

This classifer is the default classifier for the universal-hardware-classification-base workflow.

21.46.2.2.52. universal/esxi-kickstart-classification-base-functions

This is the list of functions to add for the universal-esxi-kickstart-classification-base base classifier.

21.46.2.2.53. universal/rack-build-bom-hardware

Should the rack build bom classifier use hardware values

21.46.2.2.54. universal/solidfire-classification-base-data

This classifer is the default classifier for the universal-solidfire-classification-base workflow.

21.46.2.2.55. universal/decommission-classification-base-data

This classifer is the default classifier for the universal-decommission-classification-base workflow.

21.46.2.2.56. universal/bootstrap-classification-base-data

This classifer is the default classifier for the universal-bootstrap-classification-base workflow.

21.46.2.2.57. universal/linux-install-classification-base-functions

This is the list of functions to add for the universal-linux-install-classification-base base classifier.

21.46.2.2.58. universal/maintenance-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.59. universal/bootstrap-classification-list

Provides a list of stages to run during this workflow

21.46.2.2.60. universal/esxi-kickstart-classification-base-data

This classifer is the default classifier for the universal-esxi-kickstart-classification-base workflow.

21.46.2.3. profiles

The content package provides the following profiles.

21.46.2.3.1. universal-application-ubuntu-20.04.1

Apply this profile to a machine to get Ubuntu 20.04.1

21.46.2.3.2. universal-application-centos-7

Apply this profile to a machine to get CentOS 7

21.46.2.3.3. universal-application-debian-9

Apply this profile to a machine to get Debian 9

21.46.2.3.4. universal-application-esxi-700u1-kickstart

This profile configures the universal workflow to use the esxi kick start process to install esxi-700u1.

This requires that the esxi 700u1 bootenvs are available with iso by default.

21.46.2.3.5. universal-application-centos-8.2.2004

Apply this profile to a machine to get CentOS 8.2.2004

21.46.2.3.6. universal-application-ubuntu-16.04

Apply this profile to a machine to get Ubuntu 16.04

21.46.2.3.7. universal-application-photon-3

Apply this profile to a machine to get Photon 3

21.46.2.3.8. universal-application-ubuntu-18.04

Apply this profile to a machine to get Ubuntu 18.04

21.46.2.3.9. universal-application-ubuntu-20.04.2

Apply this profile to a machine to get Ubuntu 20.04.2

21.46.2.3.10. ua-debian-during-install-tasks

Debian Tasks to do during kickstart install

21.46.2.3.11. universal-application-centos-7.9.2009

Apply this profile to a machine to get CentOS 7.9.2009

21.46.2.3.12. universal-application-fedora-33

Apply this profile to a machine to get Fedora 33

21.46.2.3.13. universal-application-photon-4

Apply this profile to a machine to get Photon 4

21.46.2.3.14. universal-application-ubuntu-20.04.3

Apply this profile to a machine to get Ubuntu 20.04.3

21.46.2.3.15. ua-centos-during-install-tasks

CentOS Tasks to do during kickstart install

21.46.2.3.16. universal-application-ubuntu-18.04-arm64-hwe

Apply this profile to a machine to get Ubuntu 18.04 ARM64 HWE

21.46.2.3.17. ua-ubuntu-during-install-tasks

Ubuntu Tasks to do during kickstart install

21.46.2.3.18. universal-application-centos-7.7.1908

Apply this profile to a machine to get CentOS 7.7.1908

21.46.2.3.19. universal-application-centos-8

Apply this profile to a machine to get CentOS 8

21.46.2.3.20. universal-application-centos-8.1.1911

Apply this profile to a machine to get CentOS 8.1.1911

21.46.2.3.21. universal-application-debian-10

Apply this profile to a machine to get Debian 10

21.46.2.3.22. universal-application-rocky-8

Apply this profile to a machine to get Rocky 8

21.46.2.3.23. universal-application-debian-8

Apply this profile to a machine to get Debian 8

21.46.2.3.24. universal-application-esxi-700u1-image

This profile configures the universal workflow to use image-deploy to deploy esxi-700u1 through image-deploy and provide configuration post install.

This requires the esxi_700u1-16850804_rkn_vmware.xz that can be found at

https://s3-us-west-2.amazonaws.com/get.rebar.digital/images/vmware/image-deploy/esxi_700u1-16850804_rkn_vmware.xz

This is the RackN enabled generic 700u1 image at build 16850804.

This file should be placed in images under the files API in DRP.

e.g. drpcli files upload https://s3-us-west-2.amazonaws.com/get.rebar.digital/images/vmware/image-deploy/esxi_700u1-16850804_rkn_vmware.xz as images/esxi_700u1-16850804_rkn_vmware.xz

21.46.2.3.25. universal-application-fedora-31

Apply this profile to a machine to get Fedora 31

21.46.2.3.26. universal-application-fedora-34

Apply this profile to a machine to get Fedora 34

21.46.2.3.27. universal-application-ubuntu-20.04

Apply this profile to a machine to get Ubuntu 20.04

21.46.2.3.28. universal-application-centos-7.6.1810

Apply this profile to a machine to get CentOS 7.6.1810

21.46.2.3.29. universal-application-centos-7.8.2003

Apply this profile to a machine to get CentOS 7.8.2003

21.46.2.3.30. universal-application-centos-8.3.2011

Apply this profile to a machine to get CentOS 8.3.2011

21.46.2.3.31. universal-application-ubuntu-20.04.0

Apply this profile to a machine to get Ubuntu 20.04.0

21.46.2.4. stages

The content package provides the following stages.

21.46.2.4.1. universal-baseline-profiles

This stage builds a set of profiles that represent the hardware state of a machine.