Editing a deployment

You can edit the KPIs, alerts, NiFi configuration, sizing and scaling, and notifications of your deployment under Deployment Settings or using the CDP CLI.

You can either edit your deployment on the Cloudera Data Flow UI or through the CLI.

You must have the DFFlowAdmin role assigned to perform this task.
You must have a deployed flow definition in Cloudera Data Flow.

Editing deployments on the user interface

Learn about editing deployments using the Cloudera Data Flow web UI.

Open Cloudera Data Flow by clicking the Data Flow tile in the Cloudera sidebar.
Click Deployments from the left navigation pane.
The Deployments page is displayed, by default the Deployments tab is active.

tip

You can customize this page view by using the Deployment Status, Flow Status, Environments, Projects, Metrics window, and Items per page options.
Select a deployment to expand the Deployment & Flows pane where you can view deployment details, KPIs, system metrics, alerts, and event history information. This is the view where you can also access flows on that specific deployment.
In Deployment & Flows, click Actions > Manage Deployment.
You are redirected to the Deployment Manager page.
Select KPIs and Alerts
- to add new KPIs
- edit the alerts existing KPIs trigger
Select Sizing and Scaling
- to change the size and number of NiFi nodes provisioned for the deployment
- to toggle auto-scaling
- to view storage type
Select NiFi Configuration
- to configure inbound connection
- custom NAR configuration
- custom Python configuration
- reporting tasks
- access NiFi metrics endpoint URL for metrics scraping
tip

Check the UI for CLI usage examples to help you learn to automate your common Cloudera Data Flow tasks.
Click Apply Changes before exiting each tab.

You can confirm by finding the Deployment Update success message in Alerts under Deployment Details.

Editing a deployment using the CLI

Learn about editing a deployment using the CLI.

You have installed Cloudera CLI.
You have run df list-deployments. The output includes the crn field containing the deployment-crn and the service.crn field containing the environment-crn.
To obtain the configuration-version, you have run the following command, the output of which contains the configurationVersion field containing the configuration-version value:
```
dfworkload get-deployment-configuration 
--environment-crn [***ENVIRONMENT_CRN***] 
--deployment-crn [***DEPLOYMENT_CRN***]
```

To edit an existing deployment, use the cdp dfworkload update-deployment command.

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, if you are using one for this flow.
[--kpis] – Specifies the location of the KPIs JSON file, if you are providing KPIs for this flow.

This is an example for updating static node count:


cdp dfworkload update-deployment \
    --environment-crn $ENVIRONMENT_CRN \
    --deployment-crn $DEPLOYMENT_CRN \
    --configuration-version $CONFIGURATION_VERSION \
    --static-node-count 2

This is an example for using 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