Disabling Cloudera Data Flow for an environment

Disabling Cloudera Data Flow for an environment terminates the cloud infrastructure that was created as part of the enablement process.

When you disable Cloudera Data Flow for an environment, you can specify whether to preserve your environment event history. Preserving the event history retains your environment event history and allows you to view past events even after the environment has been disabled. Regardless of whether you choose to preserve the event history, you can enable Cloudera Data Flow for an environment again after a successful disablement operation.

What is destroyed when you disable an environment:

All deployments and associated flows
All Projects
All flow drafts in Flow Designer
All Shared Parameter Groups
All uploaded custom NARs
All uploaded custom Python processors

What remains after you disable a CDF service:

Flow Catalog and Catalog Collections
All flow definitions currently in the Flow Catalog

tip

Steps you can take to prepare for a disable operation if you want to re-enable Cloudera Data Flow for the same Cloudera Environment:

Document your projects, who has Access to them, and their level of access.
Document you flow drafts, so that you can recreate them from the Catalog.
If you have flow drafts that have not yet been published to the Catalog, publish them so that they are persisted as a flow definition in the Catalog
Document Shared Parameter Groups so that you can recreate them.
Extract Deployment Configuration via UI or CLI.
If you use the CLI to deploy flows: CLI commands reference a dfservicecrn and this crn is regenerated during re-enablement. You must update the CLI commands to use the regenerated dfservicecrn to ensure they point at the new Cloudera Data Flow service.

Disabling Cloudera Data Flow for an environment on the UI

Use the Cloudera Data Flow UI to disable an environment and choose whether to preserve its event history.

Disabling Cloudera Data Flow for an environment terminates the cloud infrastructure that was created during enablement. When you disable the environment, you can choose whether to preserve the environment event history.

On the Environments page in Cloudera Data Flow, select the environment that you want to disable.
Click Manage Cloudera Data Flow Service in the Environment Details pane.
You are redirected to the Manage Cloudera Data Flow Service page.
From the Actions menu, select Disable Cloudera Data Flow service.
Specify whether you want to Preserve event history.
Enter the environment name to confirm the action.
Click Disable to start the disablement process.

The disablement process starts. Disabling Cloudera Data Flow for an environment can take up to 30 minutes.

Disabling Cloudera Data Flow for an environment using the CLI

Use the CDP CLI to disable Cloudera Data Flow for an environment and specify whether to preserve event history.

Disabling Cloudera Data Flow for an environment terminates the cloud infrastructure that was created during enablement. You can preserve the environment event history and enable Cloudera Data Flow for the environment again after disablement completes successfully.

You have installed the CDP CLI.
You have run cdp df list-services to obtain the service-crn.

Run the following command to disable Cloudera Data Flow for the environment:

cdp df disable-service
--service-crn [***SERVICE_CRN***]
[--persist] [--no-persist]
[--terminate-deployments] [--no-terminate-deployments]
[help]

Replace the command options as follows:

service-crn provides the value you identified by running cdp df list-services.
[--persist] or [--no-persist] specifies whether you want to preserve environment history.
[--terminate-deployments] or [--no-terminate-deployments] specifies whether you want to gracefully terminate deployments associated with the environment. Regardless of this setting, all associated deployments are terminated when you disable Cloudera Data Flow.

When the command is accepted, the returned status is similar to the following:

{
  "status": {
    "state": "DISABLING",
    "message": "Disabling DataFlow",
    "detailedState": "TERMINATING_DEPLOYMENTS"
  }
}