Install the Azure Ververica Agent

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

Connect Your Ververica Account with Azure Marketplace

1. On any page in the Dashboard, click the Profile icon to open the profile options dropdown and select Payment.
2. Click Connect to Azure Marketplace.
3. Click Get it now on the Confirm your details to continue dialog.
4. Click Subscribe to be redirected to the Azure Marketplace.
5. Subscribe to the plan you want to use.
6. After you are subscribed, select the option to configure the product. You are redirected to Ververica, where you are prompted to link your new Azure Marketplace subscription to your Ververica account.

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:
3. Go to the Ververica Portal.
4. Click your Profile icon.
5. Click Agents.
6. Click Download Agent Configuration.

Install the Ververica Agent

Run the Helm command to install or upgrade the Ververica Agent.

In the downloaded values.yaml file, all fields are pre-filled, except for the vvcTenantManagedIdentityClientID field. You must pass this parameter to the Helm command when you install the Ververica Agent.

The value for this field is obtained at the end of the previous section, Create a Managed Identity and Role Assignment, in the environment variable ${VVC_TENANT_MANAGED_IDENTITY_CLIENT_ID}.

Environment Variables

1export VV_AGENT_NAMESPACE=vv-agent
2export VV_AGENT_NAME=vv-agent
3export VV_AGENT_VERSION=2.4.1-byoc

Install Command

1helm -n ${VV_AGENT_NAMESPACE} upgrade --install ${VV_AGENT_NAME} oci://registry.ververica.cloud/agent-charts/vv-agent \
2  --version ${VV_AGENT_VERSION} \
3  --set global.vvcTenantManagedIdentityClientID="${VVC_TENANT_MANAGED_IDENTITY_CLIENT_ID}" \
4  --values ./values.yaml

Alternatively, you can manually add the vvcTenantManagedIdentityClientID field and its value to the values.yaml file.

Example:

1global:
2  vvcTenantManagedIdentityClientID: "<managed identity client ID>"

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 you create a new BYOC workspace, you must provide the following information:

Cloud Provider This corresponds to the cloud provider environment that the workspace uses. It is automatically selected to match the cloud provider for your marketplace subscription.

Workspace Name Enter a unique name that identifies your workspace.

Ververica Agent Select a registered agent that will manage this workspace.

Object Storage Enter the path of the dedicated object storage container in the following format. This is used to store runtime artifacts and Flink checkpoints of all the deployments in the workspace.

<container name>@<storage account name>.dfs.core.windows.net

The <container name> parameter is the name of your storage container where job artifacts, checkpoints, and state data are stored for your workspace. The <storage account name> is the name of your Azure Storage Account.

Example: workspace1@vvcbyoc1eus2.dfs.core.windows.net

Uninstall the Ververica Agent

To uninstall the Ververica Agent from your cluster, complete the following steps:

1. Verify that no virtual clusters (vclusters) are currently active in your Kubernetes cluster.
2. Run the following kubectl commands to remove the associated webhook configurations.

1kubectl delete mutatingwebhookconfiguration 0100-pyxis-mutating-webhook
2kubectl delete validatingwebhookconfiguration pyxis-validating-webhook

1. Run the following Helm command to uninstall the Ververica Agent. Example:

1helm -n <ververica agent namespace> uninstall vv-agent