Install the AWS Ververica Agent

To install and configure the Ververica Agent in your Kubernetes environment, complete the following steps:

1. Click the Profile icon on any page in the Dashboard to open the profile options dropdown.
2. Go to Payment.
3. Connect to AWS.

Watch this video for an overview about installing and configuring the Ververica Agent for Ververica Cloud: Bring Your Own Cloud.

• Link your Ververica account with AWS Marketplace and subscribe to Ververica Cloud: Bring Your Own Cloud.
• Install the Ververica Agent (Pyxis) using Helm and verify its registration in the Ververica Portal.
• Create a new BYOC workspace.

Connect Your Ververica Account with AWS Marketplace

1. Click Subscribe. Ververica Cloud: Bring Your Own Cloud (PAYG) product page on AWS Marketplace displays, where you can subscribe to the product.
2. After you subscribe, AWS Marketplace redirects you to a page where you can link your Ververica account with AWS.

Register the Agent in the Ververica Portal

1.Open the registration page and follow the prompts to register the agent.

2.After registering, download the Helm values.yaml file from the portal.

Update the Helm Values

In the downloaded values.yaml file, most fields will be pre-filled, except for the pyxisRoleArn field.

Manually add the pyxisRoleArn entry to the global section of values.yaml. For example:

1global:
2  # ...
3  pyxisRoleArn: "arn:aws:iam::<your-aws-account-id>:role/VVCAdminRole" # Add this line to the downloaded configuration file.
4  # ...

Configure an outbound proxy (private clusters)

If your EKS nodes sit in a private subnet and reach the internet through a corporate proxy, the Agent needs proxy settings in values.yaml — otherwise it cannot reach agent.ververica.cloud and registration fails.

1global:
2  # Route Agent egress through your corporate proxy.
3  httpProxy: "http://proxy.example.com:3128"
4  httpsProxy: "http://proxy.example.com:3128"
5  noProxy: "localhost,127.0.0.1,.svc,.cluster.local"

Install Ververica Agent

Run the following Helm command to install or upgrade Pyxis :

1helm -n <your-namespace> upgrade --install vv-agent oci://registry.ververica.cloud/agent-charts/vv-agent --version 2.4.1-byoc -f ./values.yaml

Alternatively, instead of editing the file, you can pass pyxisRoleArn as a command argument:

1helm -n <your-namespace> install vv-agent oci://registry.ververica.cloud/agent-charts/vv-agent 
2--version 2.4.1-byoc --set global.pyxisRoleArn="arn:aws:iam::<your-aws-account-id>:role/VVCAdminRole"
3--values ./values.yaml
4

Verify Agent Registration

After the Agent contacts the Control Plane, its status changes to online. You can verify this by checking the Agents page in the Ververica Portal.

When the agent is online, it indicates that it has successfully registered and is ready for use.

Create a Workspace

When creating a new BYOC workspace, you must provide the following information:

1. Provider:
   Specify the provider for the workspace.
   This corresponds to the environment or infrastructure provider that the workspace will use.
2. Workspace Name:
   Enter a unique name that identifies your workspace.
3. Cluster Agent:
   Choose the cluster agent where the workspace agent will be deployed.
   This ensures that workloads run on the infrastructure managed by that specific agent.
4. S3 Bucket:
   Select the S3 bucket to be used by the new workspace.
   The chosen bucket stores runtime artifacts and Flink checkpoints for the workspace’s deployments.

Uninstall the Agent

To uninstall the Ververica Agent from your cluster, follow these steps:

1.Ensure no vclusters are running:
Verify that no virtual clusters (vclusters) are currently active in your Kubernetes cluster.

2.Delete associated webhooks:
Run the following commands to remove the associated webhook configurations:

3.Uninstall the Helm chart:
Use Helm to uninstall the Ververica Agent:

1export VV_AGENT_NAMESPACE=vv-agent
2export VV_AGENT_NAME=vv-agent
3helm -n <your-namespace> uninstall vv-agent