22.46. universal - Universal Workflow Content¶
The following documentation is for Universal Workflow Content (universal) content package at version v4.10.0-alpha00.20+gbf1b48a64b12fd2a0a5819f050eb74d9ff4b5199.
22.46.1. Universal Workflows (aka Pipelines)¶
Universal Workflow architectural, Universal Workflow Architecture, and Universal Workflow operations, Universal Workflow Operations, contain more details about the universal workflow system.
22.46.2. Object Specific Documentation¶
22.46.2.1. blueprints¶
The content package provides the following blueprints.
22.46.2.1.1. universal-application-application-base¶
Runs the Workload part of the universal-runbook Workflow
This is used when a machine is in WorkOrder mode and needs to maintain the pipeline
22.46.2.1.2. universal-application-base-cluster¶
WorkOrder maintenance for Base Cluster pipeline
This is used when a machine is in WorkOrder mode and needs to maintain the pipeline
22.46.2.1.3. universal-application-broker-base¶
WorkOrder maintenance for Broker base pipeline
This is used when a machine is in WorkOrder mode and needs to maintain the pipeline
22.46.2.1.4. universal-application-multi-site-manager-demo-cluster¶
WorkOrder maintenance for Multi-Site Manager Demo pipeline
This is used when a machine is in WorkOrder mode and needs to maintain the pipeline
22.46.2.2. params¶
The content package provides the following params.
22.46.2.2.1. 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
22.46.2.2.2. universal/baseline-classification-base-data¶
This classifer is the default classifier for the universal-baseline-classification-base workflow.
22.46.2.2.3. universal/baseline-classification-base-functions¶
This is the list of functions to add for the universal-baseline-classification-base base classifier.
22.46.2.2.4. universal/baseline-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.5. universal/baseline/application¶
Parameter is used to name the baseline profiles. See universal/application for more information about application values.
22.46.2.2.6. 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.
22.46.2.2.7. 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.
22.46.2.2.8. universal/bootstrap-classification-base-data¶
This classifer is the default classifier for the universal-bootstrap-classification-base workflow.
22.46.2.2.9. universal/bootstrap-classification-base-functions¶
This is the list of functions to add for the universal-bootstrap-classification-base base classifier.
22.46.2.2.10. universal/bootstrap-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.11. 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: falseJSON 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.
22.46.2.2.12. universal/burnin-classification-base-data¶
This classifer is the default classifier for the universal-burnin-classification-base workflow.
22.46.2.2.13. universal/burnin-classification-base-functions¶
This is the list of functions to add for the universal-burnin-classification-base base classifier.
22.46.2.2.14. universal/burnin-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.15. universal/cluster-destroy-classification-base-data¶
This classifer is the default classifier for the universal-cluster-destroy-classification-base workflow.
22.46.2.2.16. universal/cluster-destroy-classification-base-functions¶
This is the list of functions to add for the universal-cluster-destroy-classification-base base classifier.
22.46.2.2.17. universal/cluster-destroy-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.18. universal/cluster-provision-classification-base-data¶
This classifer is the default classifier for the universal-cluster-provision-classification-base workflow.
22.46.2.2.19. universal/cluster-provision-classification-base-functions¶
This is the list of functions to add for the universal-cluster-provision-classification-base base classifier.
22.46.2.2.20. universal/cluster-provision-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.21. universal/decommission-classification-base-data¶
This classifer is the default classifier for the universal-decommission-classification-base workflow.
22.46.2.2.22. universal/decommission-classification-base-functions¶
This is the list of functions to add for the universal-decommission-classification-base base classifier.
22.46.2.2.23. universal/decommission-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.24. universal/discover-classification-base-data¶
This classifer is the default classifier for the universal-discover-classification-base workflow.
The data for the universal-discover-classification-base classifier. Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Modifying Discovery Classifier
22.46.2.2.25. universal/discover-classification-base-functions¶
This is the list of functions to add for the universal-discover-classification-base base classifier. Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Modifying Discovery Classifier
22.46.2.2.26. universal/discover-classification-list¶
Provides a list of stages to run during this workflow
classification param universal/discover-classification-list for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Modifying Discovery Classifier
22.46.2.2.27. universal/discover-post-flexiflow¶
flexiflow param universal/discover-post-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Adding Tasks to a Workflow
22.46.2.2.28. universal/discover-post-validation¶
Validation After Discover
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Using Validations
22.46.2.2.29. universal/discover-pre-flexiflow¶
flexiflow param universal/discover-pre-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Adding Tasks to a Workflow
22.46.2.2.30. universal/esxi-config-classification-base-data¶
This classifer is the default classifier for the universal-esxi-config-classification-base workflow.
22.46.2.2.31. universal/esxi-config-classification-base-functions¶
This is the list of functions to add for the universal-esxi-config-classification-base base classifier.
22.46.2.2.32. universal/esxi-config-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.33. universal/esxi-install-classification-base-data¶
This classifer is the default classifier for the universal-esxi-install-classification-base workflow.
22.46.2.2.34. universal/esxi-install-classification-base-functions¶
This is the list of functions to add for the universal-esxi-install-classification-base base classifier.
22.46.2.2.35. universal/esxi-install-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.36. universal/esxi-kickstart-classification-base-data¶
This classifer is the default classifier for the universal-esxi-kickstart-classification-base workflow.
22.46.2.2.37. universal/esxi-kickstart-classification-base-functions¶
This is the list of functions to add for the universal-esxi-kickstart-classification-base base classifier.
22.46.2.2.38. universal/esxi-kickstart-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.39. 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.
22.46.2.2.40. universal/hardware-classification-base-data¶
This classifer is the default classifier for the universal-hardware-classification-base workflow.
22.46.2.2.41. universal/hardware-classification-base-functions¶
This is the list of functions to add for the universal-hardware-classification-base base classifier.
22.46.2.2.42. universal/hardware-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.43. universal/image-deploy-classification-base-data¶
This classifer is the default classifier for the universal-image-deploy-classification-base workflow.
22.46.2.2.44. universal/image-deploy-classification-base-functions¶
This is the list of functions to add for the universal-image-deploy-classification-base base classifier.
22.46.2.2.45. universal/image-deploy-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.46. universal/linux-install-classification-base-data¶
This classifer is the default classifier for the universal-linux-install-classification-base workflow.
22.46.2.2.47. universal/linux-install-classification-base-functions¶
This is the list of functions to add for the universal-linux-install-classification-base base classifier.
22.46.2.2.48. universal/linux-install-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.49. universal/local-classification-base-data¶
This classifer is the default classifier for the universal-local-classification-base workflow.
22.46.2.2.50. universal/local-classification-base-functions¶
This is the list of functions to add for the universal-local-classification-base base classifier.
22.46.2.2.51. universal/local-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.52. universal/maintenance-classification-base-data¶
This classifer is the default classifier for the universal-maintenance-classification-base workflow.
22.46.2.2.53. universal/maintenance-classification-base-functions¶
This is the list of functions to add for the universal-maintenance-classification-base base classifier.
22.46.2.2.54. universal/maintenance-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.55. universal/maintenance-mode¶
Indicate that we are should go back to local disk
22.46.2.2.56. 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.
22.46.2.2.57. universal/rack-build-bom-disable¶
Should the rack build bom classifier be disabled
22.46.2.2.58. universal/rack-build-bom-function¶
This is the list of functions to add for the rack-build-bom classifier.
22.46.2.2.59. universal/rack-build-bom-hardware¶
Should the rack build bom classifier use hardware values
22.46.2.2.60. universal/rebuild-classification-base-data¶
This classifer is the default classifier for the universal-rebuild-classification-base workflow.
22.46.2.2.61. universal/rebuild-classification-base-functions¶
This is the list of functions to add for the universal-rebuild-classification-base base classifier.
22.46.2.2.62. universal/rebuild-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.63. universal/runbook-classification-base-data¶
This classifer is the default classifier for the universal-runbook-classification-base workflow.
22.46.2.2.64. universal/runbook-classification-base-functions¶
This is the list of functions to add for the universal-runbook-classification-base base classifier.
22.46.2.2.65. universal/runbook-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.66. universal/runbook-during-flexiflow¶
Tasks for pipeline execution during Runbook operations
Learn more about:
universal: Universal Workflow Architecture
this workflow: Runbook Processing
this task: Adding Tasks to a Workflow
22.46.2.2.67. universal/runbook-post-flexiflow¶
Insert tasks for pipeline execution after running the primary Runbook operations
Learn more about:
universal: Universal Workflow Architecture
this workflow: Runbook Processing
this task: Adding Tasks to a Workflow
22.46.2.2.68. universal/runbook-pre-flexiflow¶
Insert tasks for pipeline execution before running the primary Runbook operations
Learn more about:
universal: Universal Workflow Architecture
this workflow: Runbook Processing
this task: Adding Tasks to a Workflow
22.46.2.2.69. universal/solidfire-classification-base-data¶
This classifer is the default classifier for the universal-solidfire-classification-base workflow.
22.46.2.2.70. universal/solidfire-classification-base-functions¶
This is the list of functions to add for the universal-solidfire-classification-base base classifier.
22.46.2.2.71. universal/solidfire-classification-list¶
Provides a list of stages to run during this workflow
22.46.2.2.72. universal/start-classification-base-data¶
This classifer is the default classifier for the universal-start-classification-base workflow.
The data for the universal-start-classification-base classifer. Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Modifying Discovery Classifier
22.46.2.2.73. universal/start-classification-base-functions¶
The functions for the universal-start-classification-base base classifier.
This is the list of functions to add for the universal-start-classification-base base classifier. Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Modifying Discovery Classifier
22.46.2.2.74. universal/start-classification-list¶
Provides a list of stages to run during this workflow
classification param universal/start-classification-list for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Modifying Discovery Classifier
22.46.2.2.75. universal/start-post-flexiflow¶
flexiflow param universal/start-post-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Adding Tasks to a Workflow
22.46.2.2.76. universal/start-post-validation¶
Validation After Start
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Using Validations
22.46.2.2.77. universal/start-pre-flexiflow¶
flexiflow param universal/start-pre-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Adding Tasks to a Workflow
22.46.2.2.78. 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.
22.46.2.2.79. 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.
Learn more about:
pipelines: Pipelines
universal: Universal Workflow Architecture
22.46.2.2.80. 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
22.46.2.2.81. 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.
22.46.2.3. profiles¶
The content package provides the following profiles.
22.46.2.3.1. ua-centos-during-install-tasks¶
CentOS Tasks to do during kickstart install
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.2. ua-debian-during-install-tasks¶
Debian Tasks to do during kickstart install
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.3. ua-ubuntu-during-install-tasks¶
Ubuntu Tasks to do during kickstart install
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.4. universal-application-alma-8¶
Apply this profile to a machine to install the latest AlmaLinux 8
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.5. universal-application-alma-8.4¶
Apply this profile to a machine to install AlmaLinux 8.4
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.6. universal-application-alma-8.5¶
Apply this profile to a machine to install AlmaLinux 8.5
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.7. universal-application-application-base¶
Apply this profile to install applications on machine using general purpose tooling operations.
This reference pipeline includes linux-package-updates during the pre-flexiflow stage because many cloud machines require a package update before installing software. If your cloud images include all the needed pre-reqs or are not allowed to connect to the internet, you should remove this flexiflow task.
Learn more about:
pipelines: Pipelines
workflow: Runbook Processing
universal: Universal Workflow Architecture
22.46.2.3.8. universal-application-base-cluster¶
Apply this profile to install applications on machine using general purpose tooling operations.
Learn more about:
pipelines: Pipelines
workflow: Runbook Processing
universal: Universal Workflow Architecture
22.46.2.3.9. universal-application-broker-base¶
Apply this profile to install a broker in a general way. Ends with broker being set to work order mode.
Learn more about:
pipelines: Pipelines
workflow: Runbook Processing
universal: Universal Workflow Architecture
22.46.2.3.10. universal-application-centos-7¶
Apply this profile to a machine to get CentOS 7
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.11. universal-application-centos-7.6.1810¶
Apply this profile to a machine to get CentOS 7.6.1810
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.12. universal-application-centos-7.7.1908¶
Apply this profile to a machine to get CentOS 7.7.1908
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.13. universal-application-centos-7.8.2003¶
Apply this profile to a machine to get CentOS 7.8.2003
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.14. universal-application-centos-7.9.2009¶
Apply this profile to a machine to get CentOS 7.9.2009
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.15. universal-application-centos-8¶
Apply this profile to a machine to get CentOS 8
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.16. universal-application-centos-8.1.1911¶
Apply this profile to a machine to get CentOS 8.1.1911
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.17. universal-application-centos-8.2.2004¶
Apply this profile to a machine to get CentOS 8.2.2004
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.18. universal-application-centos-8.3.2011¶
Apply this profile to a machine to get CentOS 8.3.2011
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.19. universal-application-centos-8.4.2105¶
Apply this profile to a machine to get CentOS 8.4.2105
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.20. universal-application-debian-10¶
Apply this profile to a machine to get Debian 10
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.21. universal-application-debian-8¶
Apply this profile to a machine to get Debian 8
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.22. universal-application-debian-9¶
Apply this profile to a machine to get Debian 9
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.23. universal-application-drp-server¶
Apply this profile to a machine to get a DRP server.
If this is a bare machine, it will install centos8 first.
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.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
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
22.46.2.3.25. 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.
Note that the generic and vmware indexes are equivalent, but older vmware Plugin Providers esxi-patch-install Task only supports the the vmware entry correctly. This is corrected in v4.9.x vmware Plugin Provider versions.
22.46.2.3.26. universal-application-fedora-31¶
Apply this profile to a machine to get Fedora 31
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.27. universal-application-fedora-33¶
Apply this profile to a machine to get Fedora 33
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.28. universal-application-fedora-34¶
Apply this profile to a machine to get Fedora 34
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.29. universal-application-image-deploy¶
This profile configures the universal workflow system to use image-deploy to deploy an image. The image data should be provided by an additional profile.
22.46.2.3.30. universal-application-multi-site-manager-demo-cluster¶
This pipeline creates a four region edge sites for testing Multi-Site manager functionality. It provides a quick and automated way to build a working distributed system that follows RackN guidelines for a distributed system including having unique management users.
The multi-site system will use DRP endpoint names based on the cluster name. Since these must be registered in your DRP license, we recommend reusing the same cluster names during testing.
Users are highly encouraged to set the dr-server/initial-password param for security purposes (default is r0cketsk8ts)
The process is as follows:
cluster calls broker to build 4 machine cluster (cluster/count is ignored)
new machines start the DRP server install pipeline
dr-install is installed using bootstrap/install.sh or downloaded
dr-install will run with –universal flag set to bootstrap
cluster waits for all sites to be up, then will register (and remove) Endpoints from manager. This is performed by the registered flexiflow tasks in the pipeline.
This process will create TWO entries for each edge site: one for the machine created by the broker that runs the dr-install process and a second for the self-runner on the edge site. The self-runner is actually registered and running from the edge site and visible because of the management mirroring.
After the DRP endpoints are registered, operations should add set the universal-stable or universal-tip version sets for the Endpoints and enable synchronization.
To demostrate functionality, operators may create a cluster on the Manager using the context-broker and select one of the registered Endpoints. This will create container backed machines on the edge endpoint that are also mirrored in the Manager for control.
Note: It is primarily tested with the Linode broker but is not cloud specific. In Linode, the automation will explicitly use multiple regions. To duplicate this effect when using other clouds, make a copy of this pipeline and provide cloud specific region/image information.
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.31. universal-application-photon-3¶
Apply this profile to a machine to get Photon 3
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.32. universal-application-photon-4¶
Apply this profile to a machine to get Photon 4
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.33. universal-application-photon-full-4¶
Apply this profile to a machine to get Photon 4 latest install from the FULL ISO. This is useful for airgap deployments.
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.34. universal-application-photon-rt-4¶
Apply this profile to a machine to get Photon 4 realtime kernel
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.35. universal-application-rhel-server-8-dvd¶
Apply this profile to a machine to install RHEL Server 8 from the full DVD ISO.
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.36. universal-application-rhel-server-8.4-dvd¶
Apply this profile to a machine to install RHEL Server 8.4 from the full DVD ISO.
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.37. universal-application-rocky-8¶
Apply this profile to a machine to get Rocky 8
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.38. universal-application-rocky-8.4¶
Apply this profile to a machine to get Rocky 8.4
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.39. universal-application-rocky-8.5¶
Apply this profile to a machine to get Rocky 8.5
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.40. universal-application-ubuntu-16.04¶
Apply this profile to a machine to get Ubuntu 16.04
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.41. universal-application-ubuntu-18.04¶
Apply this profile to a machine to get Ubuntu 18.04
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.42. universal-application-ubuntu-18.04-arm64-hwe¶
Apply this profile to a machine to get Ubuntu 18.04 ARM64 HWE
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.43. universal-application-ubuntu-20.04¶
Apply this profile to a machine to get Ubuntu 20.04
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.44. universal-application-ubuntu-20.04.0¶
Apply this profile to a machine to get Ubuntu 20.04.0
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.45. universal-application-ubuntu-20.04.1¶
Apply this profile to a machine to get Ubuntu 20.04.1
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.46. universal-application-ubuntu-20.04.2¶
Apply this profile to a machine to get Ubuntu 20.04.2
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.3.47. universal-application-ubuntu-20.04.3¶
Apply this profile to a machine to get Ubuntu 20.04.3
Learn more about:
pipelines: Pipelines
workflow: Linux Install
universal: Universal Workflow Architecture
22.46.2.4. stages¶
The content package provides the following stages.
22.46.2.4.1. universal-baseline-classification¶
classification stage universal-baseline-classification for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Build Baseline
this stage: Modifying Discovery Classifier
22.46.2.4.2. universal-baseline-classification-base¶
base classification stage universal-baseline-classification-base for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Build Baseline
this stage: Modifying Discovery Classifier
22.46.2.4.3. universal-baseline-complete-callback¶
callback stage universal-baseline-complete-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Build Baseline
this stage: Configuring Callbacks
22.46.2.4.4. universal-baseline-post-flexiflow¶
flexiflow stage universal-baseline-post-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Build Baseline
this stage: Adding Tasks to a Workflow
22.46.2.4.5. universal-baseline-post-validation¶
validation stage universal-baseline-post-validation for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Build Baseline
this stage: Using Validations
22.46.2.4.6. universal-baseline-pre-flexiflow¶
flexiflow stage universal-baseline-pre-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Build Baseline
this stage: Adding Tasks to a Workflow
22.46.2.4.7. universal-baseline-profiles¶
This stage builds a set of profiles that represent the hardware state of a machine.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Build Baseline
22.46.2.4.8. universal-baseline-start-callback¶
callback stage universal-baseline-start-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Build Baseline
this stage: Configuring Callbacks
22.46.2.4.9. universal-bootstrap¶
Uses the DRP self-runner to complete or update installation of the server.
The function of Pipeline can be signficantly expanded by including one or more of the bootstrap-* profiles included in the task-library to setup contexts, hardware tooling and other advanced services on the Digital Rebar endpoint.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Digital Rebar Bootstrap
22.46.2.4.10. universal-bootstrap-classification¶
classification stage universal-bootstrap-classification for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Digital Rebar Bootstrap
this stage’s role: Modifying Discovery Classifier
22.46.2.4.11. universal-bootstrap-classification-base¶
base classification stage universal-bootstrap-classification-base for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Digital Rebar Bootstrap
this stage’s role: Modifying Discovery Classifier
22.46.2.4.12. universal-bootstrap-complete-callback¶
callback stage universal-bootstrap-complete-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Digital Rebar Bootstrap
this stage’s role: Configuring Callbacks
22.46.2.4.13. universal-bootstrap-post-flexiflow¶
flexiflow stage universal-bootstrap-post-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Digital Rebar Bootstrap
this stage’s role: Adding Tasks to a Workflow
22.46.2.4.14. universal-bootstrap-post-validation¶
validation stage universal-bootstrap-post-validation for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Digital Rebar Bootstrap
this stage’s role: Using Validations
22.46.2.4.15. universal-bootstrap-pre-flexiflow¶
Add tasks as defined by flexiflow/list-parameter
Learn more about:
universal: Universal Workflow Architecture
this workflow: Digital Rebar Bootstrap
this stage’s role: Adding Tasks to a Workflow
22.46.2.4.16. universal-bootstrap-start-callback¶
Make callbacks as defined by start callback/action param
Learn more about:
universal: Universal Workflow Architecture
this workflow: Digital Rebar Bootstrap
this stage’s role: Modifying Discovery Classifier
22.46.2.4.17. universal-burnin-classification¶
classification stage universal-burnin-classification for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Burnin
this stage’s role: Modifying Discovery Classifier
22.46.2.4.18. universal-burnin-classification-base¶
base classification stage universal-burnin-classification-base for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Burnin
this stage’s role: Modifying Discovery Classifier
22.46.2.4.19. universal-burnin-complete-callback¶
callback stage universal-burnin-complete-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Burnin
this stage’s role: Configuring Callbacks
22.46.2.4.20. universal-burnin-post-flexiflow¶
flexiflow stage universal-burnin-post-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Burnin
this stage’s role: Adding Tasks to a Workflow
22.46.2.4.21. universal-burnin-post-validation¶
validation stage universal-burnin-post-validation for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Burnin
this stage’s role: Using Validations
22.46.2.4.22. universal-burnin-pre-flexiflow¶
flexiflow stage universal-burnin-pre-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Burnin
this stage’s role: Adding Tasks to a Workflow
22.46.2.4.23. universal-burnin-start-callback¶
callback stage universal-burnin-start-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Burnin
this stage’s role: Configuring Callbacks
22.46.2.4.24. universal-chain-workflow¶
Change Machine Workflow to use the workflow defined by the universal/workflow-chain-map value.
NOTE: This is a REQUIRED Digital Rebar Pipeline state for all workflows that are included in pipelines.
Learn more about:
universal: Universal Workflow Architecture
22.46.2.4.25. universal-cluster-destroy-classification¶
classification stage universal-cluster-destroy-classification for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Destroying a Cluster
this stage: Modifying Discovery Classifier
22.46.2.4.26. universal-cluster-destroy-classification-base¶
base classification stage universal-cluster-destroy-classification-base for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Destroying a Cluster
this stage: Modifying Discovery Classifier
22.46.2.4.27. universal-cluster-destroy-complete-callback¶
callback stage universal-cluster-destroy-complete-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Destroying a Cluster
this stage: Configuring Callbacks
22.46.2.4.28. universal-cluster-destroy-post-flexiflow¶
“flexiflow stage universal-cluster-destroy-post-flexiflow for universal workflow”
Learn more about:
universal: Universal Workflow Architecture
this workflow: Destroying a Cluster
this stage: Adding Tasks to a Workflow
22.46.2.4.29. universal-cluster-destroy-post-validation¶
validation stage universal-cluster-destroy-post-validation for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Destroying a Cluster
this stage: Using Validations
22.46.2.4.30. universal-cluster-destroy-pre-flexiflow¶
flexiflow stage universal-cluster-destroy-pre-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Destroying a Cluster
this stage: Adding Tasks to a Workflow
22.46.2.4.31. universal-cluster-destroy-start-callback¶
callback stage universal-cluster-destroy-start-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Destroying a Cluster
this stage: Configuring Callbacks
22.46.2.4.32. universal-cluster-provision-classification¶
classification stage universal-cluster-provision-classification for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Cluster Provision
this stage: Modifying Discovery Classifier
22.46.2.4.33. universal-cluster-provision-classification-base¶
base classification stage universal-cluster-provision-classification-base for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Cluster Provision
this stage: Modifying Discovery Classifier
22.46.2.4.34. universal-cluster-provision-complete-callback¶
callback stage universal-cluster-provision-complete-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Cluster Provision
this stage: Configuring Callbacks
22.46.2.4.35. universal-cluster-provision-post-flexiflow¶
flexiflow stage universal-cluster-provision-post-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Cluster Provision
this stage: Adding Tasks to a Workflow
22.46.2.4.36. universal-cluster-provision-post-validation¶
validation stage universal-cluster-provision-post-validation for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Cluster Provision
this stage: Using Validations
22.46.2.4.37. universal-cluster-provision-pre-flexiflow¶
flexiflow stage universal-cluster-provision-pre-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Cluster Provision
this stage: Adding Tasks to a Workflow
22.46.2.4.38. universal-cluster-provision-start-callback¶
callback stage universal-cluster-provision-start-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Cluster Provision
this stage: Configuring Callbacks
22.46.2.4.39. universal-decommission¶
tbd
Learn more about:
universal: Universal Workflow Architecture
this workflow: Decomission
22.46.2.4.40. universal-decommission-classification¶
classification stage universal-decommission-classification for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Decomission
this stage: Modifying Discovery Classifier
22.46.2.4.41. universal-decommission-classification-base¶
base classification stage universal-decommission-classification-base for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Decomission
this stage: Modifying Discovery Classifier
22.46.2.4.42. universal-decommission-complete-callback¶
callback stage universal-decommission-complete-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Decomission
this stage: Configuring Callbacks
22.46.2.4.43. universal-decommission-post-flexiflow¶
flexiflow stage universal-decommission-post-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Decomission
this stage: Adding Tasks to a Workflow
22.46.2.4.44. universal-decommission-post-validation¶
validation stage universal-decommission-post-validation for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Decomission
this stage: Using Validations
22.46.2.4.45. universal-decommission-pre-flexiflow¶
flexiflow stage universal-decommission-pre-flexiflow for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Decomission
this stage: Adding Tasks to a Workflow
22.46.2.4.46. universal-decommission-start-callback¶
callback stage universal-decommission-start-callback for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Decomission
this stage: Configuring Callbacks
22.46.2.4.47. universal-discover-classification¶
classification stage universal-discover-classification for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Modifying Discovery Classifier
22.46.2.4.48. universal-discover-classification-base¶
base classification stage universal-discover-classification-base for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Modifying Discovery Classifier
22.46.2.4.49. universal-discover-complete-callback¶
Run the callback-task operations during the post phase of the Discover pipeline segment
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Configuring Callbacks
22.46.2.4.50. universal-discover-post-flexiflow¶
Run tasks defined by the flexiflow operations during the post phase of the Discover pipeline segment.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Adding Tasks to a Workflow
22.46.2.4.51. universal-discover-post-validation¶
Run validation steps defined by the validation operations during the post phase of the Discover pipeline segment.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Using Validations
22.46.2.4.52. universal-discover-pre-flexiflow¶
Run tasks defined by the flexiflow operations during the pre phase of the Discover pipeline segment.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage: Adding Tasks to a Workflow
22.46.2.4.53. universal-discover-start-callback¶
Make callbacks defined by the callback params operations during the pre phase of the Discover pipeline segment.
Must define universal-discover-start
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
this stage’s role: Configuring Callbacks
22.46.2.4.54. universal-esxi-config-start-callback¶
Icon/Color do not match the standards - this is to create a consistent appearance with other pipeline segments that begin with start or discover.
22.46.2.4.55. universal-post-cleanup¶
This stage provides late workflow cleanups after the post customization injections during decommission or a rebuild of a system.
It is added after the post customizations, as the profiles that are removed may specify post-flexiflow, post-classify, and post-callback injection.
By default this task will remove any ^universal-application-.*
wildcard matched profiles on the Machine object. These are generally
considered “pipeline profiles”, that customize the Universal Pipeline
experience. They usually contain customizations and configuration
to the pipeline.
If a Machine is changing role to a new Pipeline defined declared state, then the old Universal Application Pipeline Profiles need to be removed first.
This task can be disabled by setting the boolean config value:
profile-cleanup-skip: true
The default action is to remove all profiles matching the pattern
of ^universal-application-.*
from the Machine object.
Note
The wildcard pattern is applied in this Stage definition.
Order of precedence in param evaluation apply, so if the
profile-cleanup-selection-pattern
is found in a higher order
of precedence, it’ll override this Stage defined behavior.
22.46.2.4.56. universal-start-classification¶
Provides Classification for Local O/S Start Stage
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Modifying Discovery Classifier
22.46.2.4.57. universal-start-classification-base¶
base classification stage universal-start-classification-base for universal workflow
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Modifying Discovery Classifier
22.46.2.4.58. universal-start-complete-callback¶
Run the callback-task operations during the post phase of the Start pipeline segment
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Configuring Callbacks
22.46.2.4.59. universal-start-post-flexiflow¶
Run tasks defined by the flexiflow operations during the post phase of the Start pipeline segment.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Adding Tasks to a Workflow
22.46.2.4.60. universal-start-post-validation¶
Run validation steps defined by the validation operations during the post phase of the Start pipeline segment.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Using Validations
22.46.2.4.61. universal-start-pre-flexiflow¶
Run tasks defined by the flexiflow operations during the pre phase of the Start pipeline segment.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Adding Tasks to a Workflow
22.46.2.4.62. universal-start-start-callback¶
Make callbacks defined by the callback params operations during the pre phase of the Start pipeline segment.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start
this stage’s role: Configuring Callbacks
22.46.2.5. tasks¶
The content package provides the following tasks.
22.46.2.5.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.
22.46.2.5.2. universal-chain-workflow¶
Choose next step of the process based upon maps
22.46.2.6. workflows¶
The content package provides the following workflows.
22.46.2.6.1. universal-baseline¶
Baseline collects hardware configuration information about the system running the pipeline as a reference (aka baseline) for setting up other systems using universal-hardware
Learn more about:
universal: Universal Workflow Architecture
this workflow: Build Baseline
22.46.2.6.2. universal-bootstrap¶
This workflow is used to bootstrap Digital Rebar servers
Learn more about:
universal: Universal Workflow Architecture
this workflow: Digital Rebar Bootstrap
22.46.2.6.3. universal-burnin¶
This workflow is used to burn in machines to validate their fitness for commissioning.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Burnin
22.46.2.6.4. universal-cluster-destroy¶
This pipeline segment provides a path to clean up and destroy a cluster.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Cluster Provision
22.46.2.6.5. universal-cluster-provision¶
This pipeline segment provides a method to create a cluster.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Cluster Provision
22.46.2.6.6. universal-decommission¶
Universal Workflow for the decommission
Decomission is used to clear, wipe and otherwise reset machines that are being removed from service.
See also: Rebuild
Learn more about:
universal: Universal Workflow Architecture
this workflow: Decommission
22.46.2.6.7. universal-discover¶
Provides common discover process for Digital Rebar running in Pipeline / Universal Workflow mode.
This Workflow is an expected pipeline segment for most Digital Rebar pipelines that include Sledgehammer.
If you are using machines that already have an operating system installed on them then use the universal-linux-start or similar. Unlike those Workflows, this Workflow enforces Sledgehammer in multiple stages.
NOTE: This should be used instead of discover when running in Pipeline mode.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Discover
22.46.2.6.8. universal-esxi-config¶
Universal Workflow for the esxi-config
NOTE: By design, this workflow does NOT start with discover. In the future, the start stage could be added; however, start only runs on Linux as of v4.8.
Learn more about:
universal: Universal Workflow Architecture
this workflow: ESXi Kickstart, Install, Config
22.46.2.6.9. universal-esxi-install¶
Universal Workflow for the esxi-install
Learn more about:
universal: Universal Workflow Architecture
this workflow: ESXi Kickstart, Install, Config
22.46.2.6.10. universal-esxi-kickstart¶
Universal Workflow for the esxi-kickstart
Learn more about:
universal: Universal Workflow Architecture
this workflow: ESXi Kickstart, Install, Config
22.46.2.6.11. universal-hardware¶
Universal Workflow for the hardware
Learn more about:
universal: Universal Workflow Architecture
this workflow: Hardware IPMI, Flash, RAID and BIOS Configure
22.46.2.6.12. universal-image-deploy¶
Universal Workflow for the image-deploy
Learn more about:
universal: Universal Workflow Architecture
this workflow: Image Deploy
22.46.2.6.13. universal-linux-install¶
Univeral Workflow to install Linux on Physical Server
Learn more about:
universal: Universal Workflow Architecture
this workflow: Linux Install
22.46.2.6.14. universal-local¶
Provides a mimial Universal Workflow for local starting in specialized environments, like ESXi, or when comming out of maintenance Workflows.
Unlike universal-start, this workflow is intended to as a midpoint in a Pipeline. See Start.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Hardware IPMI, Flash, RAID and BIOS Configure
22.46.2.6.15. universal-maintenance¶
Universal Workflow for the maintenance
Minimal operations performed in this stage, it is primarily a place holder to ready systems for maintenance opertions.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Maintenance
22.46.2.6.16. universal-rebuild¶
Universal Workflow for the rebuild
Similar to universal-decomission, except designed to reset the machine back to it’s original purpose
See also: Decommission
Learn more about:
universal: Universal Workflow Architecture
this workflow: Rebuild
22.46.2.6.17. universal-runbook¶
This pipeline segment provides a post-install / post-start path to run customization tasks.
Using the during-flexiflow parameters to inject tasks.
Learn more about:
universal: Universal Workflow Architecture
universal: Runbook Processing
22.46.2.6.18. universal-solidfire¶
Installs Solidfire
Learn more about:
universal: Universal Workflow Architecture
universal: Solidfire RTFI
22.46.2.6.19. universal-start¶
Provides common start/join process systems provisioned outside of Digital Rebar discover workflows. Uses the start stage to provide control.sh.
This workflow replicates the universal-discover workflow but does not change BootEnv (meaning it does NOT enforced sledgehammer). Idempotent by design, there should be no harm if this is run after universal-discover.
For a workflow minimial local Workflow that can be used inside a Pipeline, please see Local.
Learn more about:
universal: Universal Workflow Architecture
this workflow: Start