La extensión de VS Code para Realtime Compute for Apache Flink simplifica el proceso de desarrollo local de trabajos de Flink. Úsela para desarrollar, desplegar y gestionar trabajos SQL, JAR y Python, así como para sincronizar configuraciones de trabajos desde la nube. Este tema explica cómo utilizar la extensión.
Requisitos previos
Cuenta con activated Realtime Compute for Apache Flink.
Dispone de un AccessKey ID y un AccessKey Secret. El AccessKey debe tener los permisos obligatorios para el namespace de destino. Para obtener más información, consulte How do I obtain an AccessKey ID and AccessKey Secret? y Grant permissions in the Development Console.
Tiene instalada la versión 1.74.0 o posterior de VS Code. De no ser así, descárguela desde el sitio web oficial de VS Code.
Limitaciones
No se admite la configuración de registros.
La extensión no permite extraer trabajos existentes desde la nube.
Instalación y configuración de la extensión
-
Descargue e instale la extensión.
Método 1: Vaya al VS Code Marketplace y haga clic en Install.
-
Método 2:
Abra VS Code y haga clic en EXTENSIONS en el panel de navegación izquierdo.
En la barra de búsqueda, busque la extensión Flink Realtime Compute Studio.
Haga clic en Install.
En la barra de menú superior, haga clic en y seleccione una carpeta local.
-
Configure su información de AccessKey.
Espacio de trabajo actual
En el panel de navegación izquierdo, haga clic en el icono
. En la sección Configure AK&SK, haga clic en Configure in a .vvprc file. La extensión crea automáticamente un archivo con la extensión .vvprc.-
Agregue la siguiente configuración al archivo:
{ "accessKey": "xxx", "secretKey": "xxx", "namespace": "xxx", "workspace": "xxx", "regionId" : "xxx" }Parámetro
Descripción
Notas
accessKey
El AccessKey ID de su cuenta de Alibaba Cloud.
Para obtener más información, consulte How do I obtain an AccessKey ID and AccessKey Secret?
secretKey
El AccessKey Secret de su cuenta de Alibaba Cloud.
namespace
El nombre del namespace de Flink.
Para obtener más información, consulte View and delete a namespace.
workspace
El ID del espacio de trabajo de Flink.
Para obtener más información, consulte How do I view the workspace ID and other information?.
regionId
El ID de la región.
Encuentre el ID de la región en Endpoints.
Global
En el panel de navegación izquierdo, haga clic en el icono
.-
En la sección Configure AK&SK, haga clic en Configure in global user settings. VS Code abre la página de configuración global.
Busque
flinkStudioy configure los siguientes campos: Flink Studio: Access Key, Flink Studio: Secret Key, Flink Studio: Namespace, Flink Studio: Region ID (predeterminado: cn-hangzhou) y Flink Studio: Workspace. -
Según sea necesario, seleccione User o Workspace para la configuración.
NotaSe recomienda establecer el ámbito en User, lo cual aplica la configuración a todos los proyectos. El ámbito Workspace aplica la configuración únicamente al espacio de trabajo actual.
Parámetro
Descripción
Notas
Access Key
El AccessKey ID de su cuenta de Alibaba Cloud.
Para obtener más información, consulte How do I obtain an AccessKey ID and AccessKey Secret?
Secret Key
El AccessKey Secret de su cuenta de Alibaba Cloud.
Para obtener más información, consulte How do I obtain an AccessKey ID and AccessKey Secret?
Namespace
El nombre del namespace de Flink.
Para obtener más información, consulte View and delete a namespace.
Workspace
El ID del espacio de trabajo de Flink.
Para obtener más información, consulte How do I view the workspace ID and other information?.
Region ID
El ID de la región.
Encuentre el ID de la región en Endpoints.
NotaPrioridad de configuración: Carpeta actual > Carpeta principal > Global.
Una vez aplicada la configuración, el nombre del namespace aparece en la barra de estado en la parte inferior del editor.
-
(Opcional) Puede instalar las siguientes extensiones para mejorar su experiencia de desarrollo.
Flink SQL: Instale la extensión Flink SQL Language Features. Esta proporciona un servicio de lenguaje para Flink SQL y es compatible con la sintaxis completa de Flink SQL.
Configuración de Flink: Se recomienda instalar la extensión YAML para VS Code, que ofrece autocompletado para las configuraciones de Flink.
Procedimiento
Paso 1: Crear un trabajo
Método 1: En el panel de navegación izquierdo, haga clic en el icono
. En la sección QUICK START, haga clic en Create a new deployment. Introduzca un nombre en la parte superior y presione Enter para crear un archivo con la extensión .vvp. La extensión genera un trabajo con campos predeterminados.Método 2: Cree un nuevo archivo con la extensión
.vvpdirectamente en el explorador de archivos. La extensión rellena el archivo con una configuración de trabajo predeterminada.
Paso 2: Configurar el trabajo
Los parámetros se pueden configurar directamente en el formulario de la interfaz de usuario.
Si está familiarizado con la configuración de trabajos, haga clic en Raw File en la esquina superior izquierda para configurar el trabajo en el archivo fuente. Al hacer clic en el nombre de un parámetro en el formulario de la interfaz, se navega a su definición en el archivo fuente.
{
"name": "test",
"artifact": {
"kind": "SQLSCRIPT",
"sqlArtifact": {
"additionalDependencies": [],
"sqlScript": ""
}
},
"deploymentTarget": {
"mode": "PER_JOB",
"name": "default-queue"
},
...
}
-
Basic: Configure los parámetros básicos.
Resources: Para obtener más información sobre los parámetros de recursos del trabajo, consulte Configure job resources.
Parameters: Para obtener más información sobre los parámetros de ejecución del trabajo, consulte Configure runtime parameters.
Paso 3: Desplegar el trabajo
Una vez que termine de desarrollar o configurar el trabajo, haga clic en Create en la parte inferior para desplegar un nuevo trabajo, o haga clic en Update para actualizar y desplegar un trabajo local existente.
Para trabajos SQL, la extensión valida el script SQL, el plan de recursos y otras configuraciones; posteriormente muestra los resultados de la validación.
Paso 4: Iniciar el trabajo
Para un trabajo desplegado, el estado más reciente se muestra en la esquina superior derecha. Puede hacer clic en Start y seleccionar un modo de inicio. Para obtener más información sobre los modos de inicio, consulte Start a job.
Paso 5: Operación y mantenimiento del trabajo
Después de desplegar y poner en marcha el trabajo, aparece un estado RUNNING en verde en la barra de acciones en la parte superior del editor. El área Basic muestra información clave del despliegue en una tabla, incluidos Deployment ID, Deployment Name, Execution Mode, Engine Version (por ejemplo, vvr-8.0.7-flink-1.17), Deployment Target y Deployment Type.
Open Online: Haga clic en Open Online para abrir la página de operación y mantenimiento del trabajo en la Development Console, donde podrá consultar el estado de ejecución y realizar operaciones de gestión.
Synchronize: Extrae la configuración del trabajo desde la nube. Al hacer clic en Synchronize se abre una vista previa de la configuración en línea. Nota: La vista previa no incluye cambios en borrador realizados en trabajos SQL desde la consola. Haga clic en
Acceptpara sobrescribir su archivo local con la configuración en línea.Cancel: Detiene el trabajo en ejecución.
Documentación relacionada
Para consultar los conectores compatibles, véase Supported connectors.
Para obtener información sobre cómo desarrollar y depurar trabajos JAR de Flink, consulte Develop a JAR job.
Para obtener información sobre cómo desarrollar y depurar trabajos Python de Flink, consulte Develop a Python job.
Para mejorar el rendimiento de sus trabajos SQL de Flink, consulte High-performance Flink SQL optimization techniques.