Workload Manager includes an improvement to allow service parameters to be displayed to end users during deployments. Users can define parameters as deployment parameters and set preferences for them. These preferences govern if the parameters should be visible, editable, and optional during a deployment.
Adding Deployment Parameters
Deployment Parameters are intended to be customized by the user at deployment time and can be created at the service level and used as inherited parameters within an application or directly created when modeling an application.
Service-Level Parameters: The parameter is specific to service. If you define a deployment parameter at the service level, then it is displayed as an inherited parameter in the tier where the service is used while modeling an application. You can customize the visibility preferences for this parameter and override the default value when modeling an application.
The following screenshot shows a service-level parameter.
- Tier-Level Parameters: The parameter is specific to each step or tier within an application. You can define a deployment parameter at the tier level when modeling an application. You can control the visibility preferences for this parameter during the application modeling process and configure them to be visible, editable, or options during the deployment process.
The following screenshot shows tier-level parameters.
Using Deployment Parameters
See Using Parameters for additional details.
Inherited Deployment Parameters
If a parameter is defined at the service level, then this parameter displays (inherited) when viewed at the tier level.
The following screenshot shows inherited deployment parameters.
These parameters are made available to users that use this service when deploying applications.
When users model applications, these parameters are visible to those using this service. If used at application modeling time, you can only edit the default values for a deployment parameter.
Granular Control for User-Defined Parameters
This section explains the options that allow granular control for deployment parameters. The following image highlights the Use Defaults switch.
This switch is present in the parameters editor dialog box to the right of the value of each parameter which is visible and not locked.
On: Default. Workload Manager uses the default value specified in the parameter definition.
Off: If the field is not locked and you type a value for the parameter, the toggle is automatically turned off.
The User Options that the following table describes provide granular control over a user-defined parameters:
|Should this parameter be visible to the user?|
This parameter will be visible to users during the application deployment.
Users can override the visibility setting during the application modeling process.
|This parameter is not visible to users during the application deployment.|
|Should this parameter be editable by the user?|
This parameter will be editable by users during the application deployment.
Users can override the edit setting during the application modeling process.
|This service becomes automatically is disabled for users, and therefore not editable during the application deployment.|
|Should this parameter be optional?|
Marked optional – This parameter will be optional for users during the application deployment.
Users can override the optional setting during the application modeling process.
Marked required – This parameter is requires and the user must provide or select a value during the application deployment.
|Allow selection of multiple values (only displayed if a "list" parameter is selected)||Users can select multiple values for this parameter during the application deployment.||Users can select one value for this parameter during the application deployment.|
Deployment Parameters Icons
Note that the header for each parameter section has the following icons on the right side:
- + adds a new resource – at the required point
- - deletes an existing parameter
- ↑ moves the priority of the resource further up the list.
- ↓ moves the priority of the resource further down the list.
Deleting Deployment Parameters
If a deployment parameter is deleted at the service level, then all usage for this parameter is impacted – this deployment parameter will not be available when:
You edit an application containing that service.
Users deploy an application containing that service.
Editing Deployment Parameters
If the default value for a deployment parameter is changed at the service level, then this change reflects in the usage for this parameter at the application level IF the default value was not overridden during the application modeling process.
Deployment Service Parameters
You can define deployment parameters in new and existing services:
If an app is not modified, these parameters show on the deployment flow based on visibility
At app level, deployment parameters are shown from the service.
You cannot remove deployment parameters at the app level.
You can edit the default values or visibility setting; app level values take precedence
If you edit the default values, the values are stored only in the app.
If you remove an updated parameter from service, it is not shown in the app or job.
If you change parameter values to the same values of service, it is not saved at the app level and it is picked up at the service level.
Define deployment parameters on the Service page. To do so, click Edit for the service and scroll down to the Deployment Parameters area. By default, parameters are collapsed. You can click any parameter to expand it and see its configuration.
Part of configuration includes these check boxes. These settings become the defaults when modeling an app. You can change values according to your needs.
Should this parameter be visible to the user?
Should this parameter be editable by the user?
Should this parameter be optional?
Allow selection of multiple values?
You can click Add a parameter to add your own parameter.
When you model an app and drag a service in the Topology Modeler page, the Properties display shows how many deployment parameters exist. Click the Deployment Parameters field to see the name of each parameter. The "inherited" designation next to a parameter means that the parameter comes from the Services page and is not defined here. You can expand each parameter further.
An inherited parameter cannot be deleted here (the Minus button is disabled).
To update a parameter, click it. For inherited parameters, you cannot update the Parameter Name, Display Name, Help Text, or Type fields (these fields are disabled). You can update the Default Value and User Options (options are Should this parameter be visible to the user?; Should this parameter be editable by the user?; Should this parameter be optional?; Allow selection of multiple users?).
You can click Add a Parameter to define a custom deployment parameter for the app. You cannot define a new parameter that has the same name as an inherited parameter.
On the Deploy page, in the Tier Settings area, you can see each deployment parameter that is defined. If a value is defined as editable for the parameter, you can edit it here, while deploying the app.
On the Deployment Details page, you can see the parameters for a deployment under Parameters (applies to global, custom, and deployment parameters).
- No labels