L'extension Realtime Compute for Apache Flink pour VS Code simplifie le processus de développement local des jobs Flink. Elle vous permet de développer, déployer et gérer des jobs SQL, JAR et Python, ainsi que de synchroniser les configurations de jobs depuis le cloud. Cette rubrique explique comment utiliser l'extension.
Prérequis
Vous avez activé Realtime Compute for Apache Flink.
Vous disposez d'un AccessKey ID et d'un AccessKey Secret. L'AccessKey doit disposer des permissions requises pour le namespace cible. Pour plus d'informations, consultez Comment obtenir un AccessKey ID et un AccessKey Secret ? et Accorder des permissions dans la Development Console.
VS Code v1.74.0 ou une version ultérieure est installé. Si ce n'est pas le cas, téléchargez-le depuis le site Web officiel de VS Code.
Limitations
La configuration des journaux n'est pas prise en charge.
L'extension ne permet pas de récupérer les jobs existants depuis le cloud.
Installer et configurer l'extension
-
Téléchargez et installez l'extension.
Méthode 1 : Accédez à la place de marché VS Code et cliquez sur Install.
-
Méthode 2 :
Ouvrez VS Code et cliquez sur EXTENSIONS dans le volet de navigation de gauche.
Dans la barre de recherche, saisissez Flink Realtime Compute Studio.
Cliquez sur Install.
Dans la barre de menu supérieure, accédez à et sélectionnez un dossier local.
-
Configurez vos informations AccessKey.
Current workspace
Dans le volet de navigation de gauche, cliquez sur l'icône
. Dans la section Configure AK&SK, cliquez sur Configure in a .vvprc file. L'extension crée automatiquement un fichier avec l'extension .vvprc.-
Ajoutez la configuration suivante au fichier :
{ "accessKey": "xxx", "secretKey": "xxx", "namespace": "xxx", "workspace": "xxx", "regionId" : "xxx" }Parameter
Description
Notes
accessKey
L'AccessKey ID de votre compte Alibaba Cloud.
Pour plus d'informations, consultez Comment obtenir un AccessKey ID et un AccessKey Secret ?
secretKey
L'AccessKey Secret de votre compte Alibaba Cloud.
namespace
Le nom du namespace Flink.
Pour plus d'informations, consultez Afficher et supprimer un namespace.
workspace
L'ID de l'espace de travail Flink.
Pour plus d'informations, consultez Comment afficher l'ID de l'espace de travail et d'autres informations ?.
regionId
L'ID de la région.
Trouvez l'ID de la région dans Endpoints.
Global
Dans le volet de navigation de gauche, cliquez sur l'icône
.-
Dans la section Configure AK&SK, cliquez sur Configure in global user settings. VS Code ouvre la page des paramètres globaux.
Recherchez
flinkStudioet définissez les champs suivants : Flink Studio: Access Key, Flink Studio: Secret Key, Flink Studio: Namespace, Flink Studio: Region ID (par défaut : cn-hangzhou) et Flink Studio: Workspace. -
Sélectionnez User ou Workspace pour la configuration, selon vos besoins.
RemarqueNous recommandons de définir la portée sur User, ce qui applique la configuration à tous les projets. La portée Workspace applique la configuration uniquement à l'espace de travail actuel.
Parameter
Description
Notes
Access Key
L'AccessKey ID de votre compte Alibaba Cloud.
Pour plus d'informations, consultez Comment obtenir un AccessKey ID et un AccessKey Secret ?
Secret Key
L'AccessKey Secret de votre compte Alibaba Cloud.
Pour plus d'informations, consultez Comment obtenir un AccessKey ID et un AccessKey Secret ?
Namespace
Le nom du namespace Flink.
Pour plus d'informations, consultez Afficher et supprimer un namespace.
Workspace
L'ID de l'espace de travail Flink.
Pour plus d'informations, consultez Comment afficher l'ID de l'espace de travail et d'autres informations ?.
Region ID
L'ID de la région.
Trouvez l'ID de la région dans Endpoints.
RemarquePriorité de la configuration : Dossier actuel > Dossier parent > Global.
Une fois la configuration appliquée, le nom du namespace s'affiche dans la barre d'état en bas de l'éditeur.
-
(Facultatif) Vous pouvez installer les extensions suivantes pour améliorer l'expérience de développement.
Flink SQL : Installez l'extension Flink SQL Language Features. Elle fournit un service linguistique pour Flink SQL et prend en charge la syntaxe complète de Flink SQL.
Configuration Flink : Nous recommandons d'installer l'extension YAML VS Code, qui offre la saisie semi-automatique pour les configurations Flink.
Procédure
Étape 1 : Créer une tâche
Méthode 1 : Dans le volet de navigation de gauche, cliquez sur l'icône
. Dans la section QUICK START, cliquez sur Create a new deployment. Saisissez un nom en haut et appuyez sur Entrée pour créer un fichier avec l'extension .vvp. Cette extension génère une tâche avec des champs par défaut.Méthode 2 : Créez directement un nouveau fichier avec l'extension
.vvpdans l'explorateur de fichiers. L'extension remplit le fichier avec une configuration de tâche par défaut.
Étape 2 : Configurer la tâche
Vous pouvez configurer les paramètres directement dans le formulaire de l'interface utilisateur.
Si vous maîtrisez la configuration des tâches, cliquez sur Raw File en haut à gauche pour configurer la tâche dans le fichier source. Le fait de cliquer sur un nom de paramètre dans le formulaire de l'interface utilisateur permet d'accéder à sa définition dans le fichier source.
{
"name": "test",
"artifact": {
"kind": "SQLSCRIPT",
"sqlArtifact": {
"additionalDependencies": [],
"sqlScript": ""
}
},
"deploymentTarget": {
"mode": "PER_JOB",
"name": "default-queue"
},
...
}
-
Basic : configurez les paramètres de base.
Resources : pour plus d'informations sur les paramètres de ressources des tâches, consultez Configurer les ressources des tâches.
Parameters : pour plus d'informations sur les paramètres d'exécution des tâches, consultez Configurer les paramètres d'exécution.
Étape 3 : Déployer la tâche
Une fois le développement ou la configuration de la tâche terminé, cliquez sur Create en bas pour déployer une nouvelle tâche, ou cliquez sur Update pour mettre à jour et déployer une tâche locale existante.
Pour les tâches SQL, l'extension valide le script SQL, le plan de ressources et les autres configurations, puis affiche les résultats de la validation.
Étape 4 : Démarrer la tâche
Pour une tâche déployée, le dernier statut s'affiche dans le coin supérieur droit. Vous pouvez cliquer sur Start et sélectionner un mode de démarrage. Pour plus d'informations sur les modes de démarrage, consultez Démarrer une tâche.
Étape 5 : Exploitation et maintenance (O&M) des tâches
Une fois la tâche déployée et en cours d'exécution, un statut vert RUNNING apparaît dans la barre d'action en haut de l'éditeur. La zone Basic affiche les informations clés du déploiement dans un tableau, notamment l'ID de déploiement, le nom du déploiement, le mode d'exécution, la version du moteur (par exemple, vvr-8.0.7-flink-1.17), la cible de déploiement et le type de déploiement.
Open Online : cliquez sur Open Online pour ouvrir la page d'O&M des tâches dans la console de développement, où vous pouvez consulter le statut d'exécution et effectuer des opérations d'O&M.
Synchronize : extrait la configuration de la tâche depuis le cloud. Cliquer sur Synchronize ouvre un aperçu de la configuration en ligne. Remarque : l'aperçu n'inclut pas les modifications brouillon apportées aux tâches SQL dans la console. Cliquez sur
Acceptpour écraser votre fichier local avec la configuration en ligne.Cancel : arrête la tâche en cours d'exécution.
Documentation connexe
Pour connaître les connecteurs pris en charge, consultez Connecteurs pris en charge.
Pour savoir comment développer et déboguer des tâches Flink JAR, consultez Développer une tâche JAR.
Pour savoir comment développer et déboguer des tâches Flink Python, consultez Développer une tâche Python.
Pour améliorer les performances de vos tâches Flink SQL, consultez Techniques d'optimisation haute performance pour Flink SQL.