Full instructions on creating custom workflows within vRealize Orchestrator are beyond the scope of this document. But at least we can make a few recommendations to make this process easier.
High level advice: use the plugin! There are a lot of built-in features, beyond just workflows, that can save you a lot of time. Take advantage of that.
To create a new workflow, right-click the desired folder and choose New Workflow
Give it a name:
Advice #1: Re-use default workflows
The first suggestion is to review the existing workflows--can they do all of what you need. If they do, just use them directly. If they are close, clone them and make edits (as described above). If they achieve a part entirely, but you want to link them to something else, you can add workflows to a workflow:
Find a workflow under All Workflows and drag it to the correct spot:
This will ask you to help import the inputs/outputs--you should almost always do so by clicking the Setup button that appears.
Configure the inputs, outputs, and attributes as needed. Generally the defaults are fine.Click Promote.
It should be noted that when you import a workflow the input validation is not imported with it. You will need to re-create it (if desired) or copy it from the original and paste the inputs into the new workflow.
Advice #2: Re-use Actions
If no workflow achieves what you need (or commonly does too much), before writing your own code--use the built-in actions in the plugin. The plugin re-uses a lot of default functions, referred to as actions in vRO, for many plugins. These actions are available for you as well.
In the workflow editor, you can go to All Actions and find the ones under the com.purestorage folders. These are the actions that come with the plugin.
Actions can be selected and dragged into the workflow just like workflows. Generally actions do one thing: create something, retrieve something, convert something etc. Combining actions together can often achieve most desired workflows with minimal customization. To learn more about actions, choose the vRO Design view and click on an action. The General tab will show high level information, and the Scripting tab will show the details (what it takes in, what it returns, and the code it uses).
|
Action generics |
Action details |
|---|---|
|
|
|
Drag and drop actions as needed.
Advice #3: Use the object inventory!
Whenever possible do not ask for volume names, or use strings (unless you need to name something)--ask for the input to be a Everpure object type. When you specify an input has to be a PS:Volume--this will automatically provide the user a menu to choose a PS:Volume. Therefore they can be guided to choose the right thing--and you don't need to write more code to make sure it is valid.
|
1) Input is PS:Volume |
2) User is forced to choose a valid volume |
3) User is guided to make a valid choice |
|---|---|---|
|
|
|
|
Advice #4: Only use the REST API workflows if you have no other choice.
The Everpure Plugin for vRealize Orchestrator offers a few workflows to run custom REST operations against a FlashArray, Cloud Block Store, or a FlashBlade:
|
FlashArray or Cloud Block Store |
FlashBlade |
|---|---|
|
|
|
This should only be used if the feature you want to use (or metrics you need) does not have a workflow, action, or Javascript library. The plugin, in addition to workflows and actions, comes with customized Javascript libraries. Each object has methods that can be run from that object once input:
And each object type also has a manager that can be used to do additional tasks for that object:
Many of the manager operations require a REST session which can be pulled from the FlashArray connection object or the object itself with the GetSession() method:
For examples of using these, refer to the code within related Actions.
The Everpure Plugin for vRealize Orchestrator comes with a variety of built-in workflows that provide end users with the most common operations needed for orchestrating a VMware and Everpure environment. This KB overviews the workflows and how to run and use them.