Editing a flow deployment
You can edit the KPIs, alerts, parameters, size and scale details of your flow deployment under Deployment Settings or using the CDP CLI.
Before you begin
-
Required Role: DFFlowAdmin
-
You must have deployed a flow definition in Cloudera DataFlow.
Steps
- Go to .
- Select KPIs and Alerts to edit KPIs or the alerts they trigger.
- Select Sizing and Scaling to change the number of NiFi nodes provisioned for your flow deployment and whether to auto-sclae your flow deployment nodes.
- Select Parameters to change flow deployment parameter values.
- Click Apply Changes before exiting each tab.
Result
You can confirm by finding the Deployment Update success
, in
Deployment Alerts.
Before you begin
- You have installed CDP CLI.
- You have run
df list-deployments
. The output includes thecrn
field containing thedeployment-crn
and theservice.crn
field containing theenvironment-crn
. - To obtain the configuration-version, you have run the following command, the output of
which contains the
configurationVersion
field containing theconfiguration-version
value:dfworkload get-deployment-configuration --environment-crn [***ENVIRONMENT_CRN***] --deployment-crn [***DEPLOYMENT_CRN***]
Steps
- To edit an existing flow deployment, enter:
cdp dfworkload update-deployment --environment-crn <value> --configuration-version <value> --deployment-crn <value> [--parameter-groups <value>] [--auto-scaling-enabled | --no-auto-scaling-enabled] [--auto-scale-min-nodes <value>] [--auto-scale-max-nodes <value>] [--static-node-count <value>] [--kpis <value>] [--asset-update-request-crn <value>]
- [--static-node-count] – Specifies the number of NiFi nodes when autoscaling is not enabled. You can select between 1 and 32 nodes. The default value is 1.
- [--auto-scaling-enabled | --no-auto-scaling-enabled] – Specifies whether you want to
enable autoscaling. The default is to disable autoscaling.
- [--auto-scale-min-nodes] – Specifies the minimum nodes when you have autoscaling enabled. If you have autoscaling enabled, this parameter is required.
- [--auto-scale-max-nodes] – Specifies the maximum nodes when autoscaling is enabled. If you have autoscaling enabled, this parameter is required.
- [--parameter-groups] – Specifies the location of the parameter group JSON file you, if you are using one for this flow deployment.
- [--kpis] – Specifies the location of the KPIs JSON file, if you are providing KPIs for this flow.
Example of updating your static node count
cdp dfworkload update-deployment \
--environment-crn $ENVIRONMENT_CRN \
--deployment-crn $DEPLOYMENT_CRN \
--configuration-version $CONFIGURATION_VERSION \
--static-node-count 2
Example of how to use a .json file to update parameter values
cdp dfworkload update-deployment \
--environment-crn $ENVIRONMENT_CRN \
--deployment-crn $DEPLOYMENT_CRN \
--configuration-version $CONFIGURATION_VERSION \
--parameter-groups file:///tmp/parameter-groups.json