Develop Flink jobs using VS Code - Realtime Compute for Apache Flink

Prerequisites

You have created a workspace.
You have obtained an AccessKey pair with permissions for the target namespace.
You have installed VS Code v1.74.0+.

Limitations

Log configuration is not supported.
Pulling existing jobs is not supported.

Install and configure the extension

Download and install the extension.
- Method 1: Go to the Visual Studio Marketplace and install Flink Realtime Compute Studio.
- Method 2:
  1. Open VS Code and click EXTENSIONS in the left navigation menu.
  2. In the search bar, enter Flink Realtime Compute Studio.
  3. Click Install.
In the menu bar, click File > Open Folder and select a local folder.

Configure AccessKey credentials.

Workspace-wide

Click in the left menu bar. In the Configure AK&SK section, click Configure in a .vvprc file. The extension automatically creates a file with the .vvprc extension.

Enter the following configuration information.

{
  "accessKey": "xxx",
  "secretKey": "xxx",
  "namespace": "xxx",
  "workspace": "xxx",
  "regionId" : "xxx"
}

Parameter	Description	Notes
accessKey	Your AccessKey ID.	How do I find my AccessKey ID and AccessKey secret?
secretKey	Your AccessKey secret.	How do I find my AccessKey ID and AccessKey secret?
namespace	The name of the Flink namespace.	See View and delete a namespace.
workspace	The ID of the Flink workspace.	See View workspace information.
regionId	The region ID.	See the region ID in Endpoints.

Globally

Click in the left menu bar.
Click Configure AK&SK > Configure in global user settings. VS Code opens the global settings.

Select User or Workspace to configure the settings as needed.

Note

User applies globally to all VS Code projects and is stored in the global configuration file. Workspace applies only to the current workspace.

Parameter	Description	Notes
Access Key	Your AccessKey ID.	See View AccessKey ID and AccessKey Secret
Secret Key	Your AccessKey secret.	See View AccessKey ID and AccessKey Secret
Namespace	The name of the Flink namespace.	See View and delete a namespace.
Workspace	The ID of the Flink workspace.	See View workspace information
Region ID	The region ID.	See the region ID in Endpoints.

Note

Configuration priority: Current folder > Parent folder > Global.

After configuration, the namespace name appears in the status bar.

(Optional) Install helper extensions.
- Flink SQL: Install Flink SQL Language Features for SQL syntax support.
- Flink configuration: Install YAML for YAML file auto-completion.

Procedure

Step 1: Create a job

Method 1: Click in the left menu bar. Under QUICK START, click Create a new deployment. Enter a name and press Enter to create a .vvp file with default settings.
Method 2: In the file tree, create a .vvp file.

Step 2: Configure the job

Configure the job:

To edit the source file directly, click Raw File. Click any parameter name to jump to its location in the source.

Basic settings:

SQL job

Parameter	Description
Deployment Name	The name of the job.
Execution Mode	The deployment mode. Valid values: STREAM and BATCH.
Engine Version	The engine version to run the job. See Engine versions. Use the recommended version.
Deployment Target	The destination resource queue for the job. For more information, see Manage queues.
Deployment Type	Select SQL.
SQL Script	Click Open in external editor to open the local editor and write your code. Note This opens a virtual file. If VS Code displays `The editor could not be opened because the file was not found` after a restart, click Open in external editor again.
Additional Dependencies	URI of additional dependencies for the job.
Description	Enter remarks for the job.

JAR job

For more information about parameter settings, see Deploy a JAR job.

Parameter	Description
DeploymentName	The name of the job.
Execution Mode	The deployment mode. Valid values: STREAM and BATCH.
Engine Version	The engine version to run the job. See Engine versions. Use the recommended version.
Deployment Target	The destination resource queue for the job. For more information, see Manage queues.
Deployment Type	The type of job to deploy. Select JAR.
JAR URI	The OSS path or URL of the JAR package. Upload dependencies to Artifacts in the Development Console or a bound OSS bucket first.
Entry Point Class	The entry point class. If the JAR does not specify a main class, enter the standard path of your entry point class.
Entry Point Main Arguments	Input parameters for the main method.
Additional Dependencies	OSS path or URL of additional dependency files. URLs must end with a file name. Upload dependencies to Artifacts in the Development Console or a bound OSS bucket first.
Description	Enter remarks for the job.

Python job

For more information about parameter settings, see Deploy a Python job.

Parameter	Description
Deployment Name	The name of the job.
Execution Mode	The deployment mode. Valid values: STREAM and BATCH.
Engine Version	The engine version to run the job. See Engine versions. Use the recommended version.
Deployment Target	The destination resource queue for the job. For more information, see Manage queues.
Deployment Type	The type of job to deploy. Select Python.
Python Uri	The Python job file path. Supports .py and .zip files.
Entry Module	The entry class for the program. Optional for .py files. Required for .zip files.
Entry Point Main Arguments	Input arguments for the main method.
Python Libraries	Third-party Python packages for Python UDFs, added to the PYTHONPATH of the Python worker process. Use third-party Python packages.
Python Archives	Archive files. For more information, see Use a custom Python virtual environment and Use data files.
Additional Dependencies	OSS path or URL of additional dependency files. Upload dependencies to Artifacts in the Development Console or a bound OSS bucket first.
Description	Enter remarks for the job.

Resources: See Configure job resources.
Parameters: See Parameters.

Step 3: Deploy the job

Click Create to deploy the job, or click Update for existing jobs.

For SQL jobs, the extension validates the SQL script, resource plan, and configurations, and displays the results.

Step 4: Start the job

For a deployed job, the status appears in the upper-right corner. Click Start and select a startup mode. Start a job.

Step 5: Perform job O&M

Open Online: View job status or perform O&M operations in the Development Console.
Synchronize: Pull configurations from the console. Click Synchronize to preview the cloud version, then click Accept to overwrite the local file. SQL draft updates are not included.
Cancel: Stop the job.

Realtime Compute for Apache Flink:Develop jobs using VS Code