Manage Openflow

This topic describes the steps to manage Openflow components.

Create an Openflow Runtime from the CLI

  1. From the AWS Console UI for EC2, right-click on the InfraAdminEC2-{data-plane-key} instance with your Data Plane key.

  2. Click Connect in the context menu.

  3. Switch from EC2 Instance Connect to Connect using EC2 Instance Connect Endpoint. Leave the default EC2 Instance Connect Endpoint in place.

  4. Click Connect. A new browser tab or window will appear with a command line interface.

  5. Run ./runtime.sh from this browser-based CLI. This logs you in to the Runtime Manager and presents a prompt for the various actions you can take with your Runtimes.

  6. Enter 1 to create a new Runtime, then follow the prompts for choosing the size of the Runtime and setting its name. For example, a Runtime with the name Openflow Database Connector can have an output similar to the following:

    Select a Runtime action:
1) Create
2) List
3) Get
4) Resize
5) Suspend
6) Activate
7) Upgrade
8) Delete
Press Esc to exit

Creating a new Runtime ...

Enter Name: Openflow Database Connector

1) SMALL
2) STANDARD
3) HIGH_PERFORMANCE

Select Node Type [1]: 1

Enter Min Nodes [1]:

Enter Max Nodes [1]:

Finding latest versions ...

SERVER:      2025.1.21.14
EXTENSIONS:  2025.1.24.8

Proceed with creation of Runtime 'openflow-database-connector' [Y/n]: Y

NAME:        openflow-database-connector
TYPE:        SMALL
SERVER:      2025.1.21.14
EXTENSIONS:  2025.1.24.8
MIN:         1
MAX:         1
READY:       [0/1]
STATE:       ACTIVE
URL:         https://openflow.your_domain.com/openflow-database-connector/nifi/

OIDC Sign-in Redirect URI:  https://openflow.your_domain.com:443/openflow-database-connector/nifi-api/access/oidc/callback
OIDC Sign-out Redirect URI: https://openflow.your_domain.com:443/openflow-database-connector/nifi/logout-complete

Press any key to continue ...

    The CLI shows the two URIs needed for OIDC access to your Runtime. Based on the previous example, they are as follows:

    • Sign-in redirect URI:

      https://openflow.your_domain.com:443/openflow-database-connector/nifi-api/access/oidc/callback

    • Sign-out redirect URI:

      https://openflow.your_domain.com:443/openflow-database-connector/nifi/logout-complete

  7. Add the two URIs into your OIDC application in their appropriate sections.

  8. Open a web browser at https://openflow.your_domain.com:443/openflow-database-connector/nifi/ to log in to your Openflow Runtime.

Delete a Data Plane

  1. From the AWS Console UI for EC2, right-click on the InfraAdminEC2-{data-plane-key} instance with your Data Plane key.

  2. Click Connect in the context menu.

  3. Switch from EC2 Instance Connect to Connect using EC2 Instance Connect Endpoint. Leave the default EC2 Instance Connect Endpoint in place.

  4. Click Connect. A new browser tab or window will appear with a command line interface.

  5. Run ./destroy.sh from the shell. This may take 20-30 minutes. If your connection is interrupted, the process continues running in the background. You can log back in and view its status.

  6. Navigate to CloudFormation (https://us-east-1.console.aws.amazon.com/cloudformation/home) in the AWS Console UI for your region.

  7. Delete the CloudFormation stack for your Data Plane.

  8. Remove the CNAME record from your DNS Manager.

Upgrade a Data Plane

Performing an upgrade operation on a BYOC Data Plane allows you to apply any infrastructure improvements that the Snowflake Openflow team has released. This upgrade process for Headless BYOC Data Planes lets you control when you want those changes applied to your data pipelines.

There is a separate process for upgrading the Runtimes and Connectors themselves. Use the

  1. From the AWS Console UI for EC2, right-click on the InfraAdminEC2-{data-plane-key} instance with your Data Plane key.

  2. Click Connect in the context menu.

  3. Switch from EC2 Instance Connect to Connect using EC2 Instance Connect Endpoint. Leave the default EC2 Instance Connect Endpoint in place.

  4. Click Connect. A new browser tab or window will appear with a command line interface.

  5. Run ./upgrade.sh from the shell.

Upgrade a Runtime

When a new version of a connector or new processors is available, you’ll have the option to upgrade individual Runtimes with those updates via the Runtime CLI.

  1. From the AWS Console UI for EC2, right-click on the InfraAdminEC2-{data-plane-key} instance with your Data Plane key.

  2. Click Connect in the context menu.

  3. Switch from EC2 Instance Connect to Connect using EC2 Instance Connect Endpoint. Leave the default EC2 Instance Connect Endpoint in place.

  4. Click Connect. A new browser tab or window will appear with a command line interface.

  5. Run ./runtime.sh from the shell.

  6. Enter 7 to upgrade a Runtime and follow the CLI prompts.

Language: English