Resource attributes
2 minute read
Every parameter value a resource includes is on its Parameters tab. An attribute is one you have promoted to the Overview tab, beside the resource’s group, owner, and rate, making it immediately visible.
Show a parameter as an attribute
Attributes are chosen at the parameter level, not the resource level, so the setting applies everywhere that parameter is used.
- Go to Admin > Parameters and open the parameter.
- Enable Show as Attribute. The switch saves once set.
A resource displays attributes it has values for, ordered by label. The same setting governs servers, where the value appears on the server’s Details tab. Enable it for a parameter used by both only if it belongs on both.
Give the attribute a value
The parameter must exist before any value can be assigned to it. There are two ways to provide a value.
At order time. Add the parameter to the blueprint’s Parameters tab and set its Destination to Resource, which sends the user’s order-form input to the deployed resource rather than to the servers it builds. See Blueprint-level parameters.
During deployment. A plugin build item can write a value that is only known once the resource exists, such as the URL or port a service ends up on, by calling resource.set_value_for_custom_field("parameter_name", value). The CloudBolt Forge has examples that store this kind of metadata on a resource.
Related
- Blueprint-level parameters: Add a parameter to a blueprint and choose where its value lands.
- Parameters: Create the parameter and set its type, options, and constraints.
- Resource types (XaaS): Show a parameter as a column on the list of resources of one type.