Skip to main content

Configure Deployment Manager

The Designer Cloud Powered by Trifacta platform supports multiple types of platform environments. Through the Deployment Manager, you can deploy your flows from a development instance to a production instance.

Tip

When you initially set up a platform instance, you should decide whether it is a Dev instance, a Prod instance or both. Details are below.

Note

Assignment of roles must be executed through the Admin Settings page. You cannot assign roles through API commands.

Platform Instance Type

Description

User Management

Default?

Development (Dev) only

A Development instance of the platform is used to build and test your flows and recipes until they are ready for operational use in production.

All users can build and execute flows.

No users can access the Deployments area.

Yes

Production (Prod) only

A Production instance serves to host production versions of your flows, to manage the versions that are in use, and to execute jobs. It is primarily a read-only instance of the platform. You cannot access the Transformer page to modify your recipes in a Production instance.

When a flow is ready for production use, you can export the flow from the Dev instance and import it into the Prod instance.

For more information, seeOverview of Deployment Manager.

No users can build and execute flows.

All users access the Deployments area.

No

Both

(All-in-One)

A Development environment can be configured to serve as both instance types.

Users can access the Deployments area only if the Deployments role has been added to their accounts.

No

Enable Export and Import

The ability to export and import flow packages must be enabled in your environment.

Steps:

  1. Login as a workspace administrator.

  2. You apply this change through the Workspace Settings Page. For more information, see Platform Configuration Methods.

  3. Locate the following settings, and verify that they are set to Enabled.

    Export
    Import
  4. Test the export of a flow.

Enable Dev-Only Environment

Deployment Manager configuration is required.

Note

Do not include the Deployment role in any users accounts. See Users Page.

Enable Prod-Only Environment

If you are installing separate instances of the Designer Cloud Powered by Trifacta platform to serve as Dev/Test and Prod environments, you can configure the Prod environment to serve only production purposes. Users who are permitted access to this environment can create and manage deployments, releases within them, and jobs triggered for these releases.

Tip

Separate Dev and Prod platform instances is recommended.

By default, the installed instance of the platform is configured as a Development instance. To configure the installed platform to operate as a Production instance, please complete the following steps.

Note

If you are enabling a Production-only instance of the platform, you should verify that you have deployed sufficient cluster resources for executing jobs and have sufficient nodes and users in your Alteryx license to support it. For more information, see Overview of Deployment Manager.

Steps:

  1. You can apply this change through the Admin Settings Page (recommended) or trifacta-conf.json. For more information, see Platform Configuration Methods.

  2. Configure the following setting to be true:

    "deploymentManagement.enabled" : true,
  3. Save your changes and restart the platform.

User Management for Prod-only

You must create accounts in the Prod instance for users who are to be permitted to create and manage deployments.

Tip

You should limit the number of users who can access a Production environment.

Tip

A deployment user should be assigned the flow author role for the workspace. Lesser flow roles may prevent the deployment user from properly importing and managing flows. See Roles Page.

Note

Any user who has access to a Production-only instance of the platform can perform all deployment-related actions in the environment. The Deployment role does not apply. For more information, see Users Page.

Enable All-in-One Environment

In this environment, individual user accounts may access development and testing features of the platform or the Deployment Manager, but not both. A user is a development user or a production user, based upon roles in the user's account.

Steps:

  1. You can apply this change through the Admin Settings Page (recommended) or trifacta-conf.json. For more information, see Platform Configuration Methods.

  2. Configure the following setting to be false:

    "deploymentManagement.enabled" : false,
  3. Save your changes and restart the platform.

User management for All-in-One environment

In this environment, access to Deployment Manager is determined by the presence of the Deployment role in a user's account:

When deploymentManagement.enabled=false:

Deployment role

Description

Not present in the account

User experiences the platform instance as a default Dev experience.

User can create flows, recipes, and datasets, as well as run jobs on both a scheduled and ad-hoc basis.

Present in the account

User experiences the platform instance as a Prod environment.

User can create and manage deployments and their releases. User can review connections and flows, although interaction may be limited.

Note

Users should avoid making changes to flows in a Production environment. When a new release of a flow is imported, those changes are lost.

Switching roles

In an All-in-One environment, administrators can change account permissions to enable or disable access to Prod features.

  • Administrators should not apply these permission changes to admin accounts; use a separate account instead.

  • If you switch the Deployment role on a single account, changes that you make to a Dev version of a flow are not automatically applied to a Prod version of the same flow, and vice-versa. You must still export the flow from one environment and import into the other to see any changes.