Manage Openflow¶

This topic describes the steps to manage Openflow components.

Delete a deployment¶

  1. From the AWS Console UI for EC2, right-click on the InfraAdminEC2-{data-plane-key} instance with your deployment 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 in the AWS Console UI for your region.

  7. Delete the CloudFormation stack for your deployment.

  8. Remove the CNAME record from your DNS Manager.

Upgrade a deployment¶

Within the Openflow deployment, there are several components that may require updating. Currently, this is executed through an Openflow deployment agent script. Components include the agent, the deployment service, the deployment UI, the runtime gateway, and the runtime operator. All components will be upgraded by the following procedures.

Verify and initiate deployment upgrades¶

This section outlines how to verify if deployment upgrades are available and how to initiate them.

Connect to the deployment agent¶

  1. Navigate to Openflow.

  2. Select the Deployments tab.

  3. View your deployment details and note the deployment key.

  4. In your AWS account, view the EC2 hosts and filter using the deployment key.

  5. Locate the deployment agent EC2 instance.

  6. Connect to it using EC2 Instance Connect and accepting all defaults.

Check for available upgrades¶

Execute the following script on the deployment agent EC2 instance, run the following script:

./upgrade-data-plane.sh
Copy

The script will display the current versions of various deployment components. If no upgrades are available, you will see an output similar to this:

openflow-data-plane-agent-aws is set to version 0.13.0
      No upgrade is available
openflow-dataplane-service-chart is set to version 0.38.0-9ea0e552
      No upgrade is available
openflow-dataplane-ui-chart is set to version 0.4.0-b4b1258f
      No upgrade is available
openflow-runtime-gateway is set to version 2025.5.5.14
      No upgrade is available
runtime-operator-chart is set to version 0.30.0-52360e44
      No upgrade is available

Initiate the upgrade¶

If the output indicates that upgrades are available, you have two options:

  • Wait for an automatic upgrade: The system will automatically initiate the upgrade process within approximately 10 minutes.

  • Manual upgrade: To start the upgrade immediately, run the following command:

./create.sh
Copy

Monitor the upgrade process¶

To track the progress of the upgrade, use the journalctl command:

journalctl -u openflow-apply-infrastructure -f -n 250
Copy

Verify a successful upgrade¶

A successful upgrade will typically show output similar to this:

All resources applied successfully and log uploaded to s3
openflow-apply-infrastructure.service: Deactivated successfully

Upgrade a runtime¶

Updates will be made available by Snowflake, both when introducing new Openflow processors or newer versions of existing processors, as well as when introducing new Openflow runtime functionality. When updates are available for Openflow runtimes, you will see an Upgrade icon next to your runtime on the Openflow UI.

To upgrade a runtime, do the following:

  1. Navigate to Openflow.

  2. Select the Runtimes tab.

  3. In the row of the runtime you want to upgrade, select the More options icon.

  4. Select Upgrade.

Language: English