Déployez une version de base de Google Traduction application sur Python 2 Cloud Run (Docker)

1. Présentation

Cette série d'ateliers de programmation (tutoriels pratiques à suivre à votre rythme) est destinée à aider les développeurs à comprendre les différentes options dont ils disposent pour déployer leurs applications. Dans cet atelier de programmation, vous allez apprendre à utiliser l'API Google Cloud Translation avec Python, et à l'exécuter localement ou à la déployer sur une plate-forme de calcul sans serveur Cloud (App Engine, Cloud Functions ou Cloud Run). L'application exemple disponible dans le dépôt de ce tutoriel peut être déployée de (au moins) huit façons différentes avec seulement de légères modifications de configuration:

  1. Serveur Flask local (Python 2)
  2. Serveur Flask local (Python 3)
  3. App Engine (Python 2)
  4. App Engine (Python 3)
  5. Cloud Functions (Python 3)
  6. Cloud Run (Python 2 via Docker)
  7. Cloud Run (Python 3 via Docker)
  8. Cloud Run (Python 3 via les buildpacks Cloud)

Cet atelier de programmation est consacré au déploiement de cette application sur la ou les plates-formes en gras ci-dessus.

Vous apprendrez à effectuer les tâches suivantes :

Prérequis

  • Un projet Google Cloud avec un compte de facturation Cloud actif
  • Flask installé pour l'exécution en local ou une plate-forme de calcul cloud sans serveur activée pour les déploiements cloud
  • Des connaissances de base en Python
  • Bonne connaissance des commandes de base du système d'exploitation

Enquête

Comment allez-vous utiliser ce tutoriel ?

Le lire et effectuer les exercices Le lire uniquement

Quel est votre niveau d'expérience avec Python ?

Débutant Intermédiaire Expert

Quel est votre niveau d'expérience avec les services Google Cloud ?

Débutant Intermédiaire Expert

2. Préparation

Configuration de l'environnement au rythme de chacun

  1. Connectez-vous à la console Google Cloud, puis créez un projet ou réutilisez un projet existant. (Si vous ne possédez pas encore de compte Gmail ou Google Workspace, vous devez en créer un.)

96a9c957bc475304.png

b9a10ebdf5b5a448.png

a1e3c01a38fa61c2.png

  • Le nom du projet est le nom à afficher pour les participants au projet. Il s'agit d'une chaîne de caractères qui n'est pas utilisée par les API Google, et que vous pouvez modifier à tout moment.
  • L'ID du projet doit être unique sur l'ensemble des projets Google Cloud et doit être immuable (vous ne pouvez pas le modifier une fois que vous l'avez défini). Cloud Console génère automatiquement une chaîne unique dont la composition importe peu, en général. Dans la plupart des ateliers de programmation, vous devrez référencer l'ID du projet (généralement identifié comme PROJECT_ID), donc s'il ne vous convient pas, générez-en un autre au hasard ou définissez le vôtre, puis vérifiez s'il est disponible. Il est ensuite "gelé" une fois le projet créé.
  • La troisième valeur est le numéro de projet, utilisé par certaines API. Pour en savoir plus sur ces trois valeurs, consultez la documentation.
  1. Vous devez ensuite activer la facturation dans Cloud Console afin d'utiliser les ressources/API Cloud. L'exécution de cet atelier de programmation est très peu coûteuse, voire sans frais. Pour arrêter les ressources afin d'éviter qu'elles ne vous soient facturées après ce tutoriel, suivez les instructions de nettoyage indiquées à la fin de l'atelier. Les nouveaux utilisateurs de Google Cloud peuvent participer au programme d'essai gratuit pour bénéficier d'un crédit de 300 $.

3. Activer l'API Translation

Activer les API Cloud

Dans cette section, vous allez apprendre à activer les API Google en général. Pour notre application exemple, vous allez activer l'API Cloud Translation, Cloud Run et Cloud Artifact Registry.

Introduction

Quelle que soit l'API Google que vous souhaitez utiliser dans votre application, elle doit être activée. L'exemple suivant montre deux façons d'activer l'API Cloud Vision. Une fois que vous avez appris à activer une API Cloud, vous pouvez activer d'autres API, car la procédure est similaire.

Option 1: Depuis Cloud Shell ou votre interface de ligne de commande

Bien qu'il soit plus courant d'activer les API depuis la console Cloud, certains développeurs préfèrent tout faire depuis la ligne de commande. Pour ce faire, vous devez rechercher le "nom de service " d'une API. Il ressemble à une URL: SERVICE_NAME.googleapis.com. Vous les trouverez dans le tableau des produits compatibles ou vous pouvez les interroger de manière programmatique à l'aide de l'API Google Discovery.

Avec ces informations, vous pouvez activer une API à l'aide de Cloud Shell (ou de votre environnement de développement local avec l'outil de ligne de commande gcloud installé) comme suit:

gcloud services enable SERVICE_NAME.googleapis.com

Par exemple, cette commande active l'API Cloud Vision:

gcloud services enable vision.googleapis.com

Cette commande active App Engine:

gcloud services enable appengine.googleapis.com

Vous pouvez également activer plusieurs API en une seule requête. Par exemple, cette ligne de commande active Cloud Run, Cloud Artifact Registry et l'API Cloud Translation:

gcloud services enable artifactregistry.googleapis.com run.googleapis.com translate.googleapis.com

Option 2: Depuis Cloud Console

Vous pouvez également activer l'API Vision dans le gestionnaire d'API. Dans Cloud Console, accédez au Gestionnaire d'API, puis sélectionnez Bibliothèque.

fb0f1d315f122d4a.png

Si vous souhaitez activer l'API Cloud Vision, commencez à saisir "vision" dans la barre de recherche. Tout ce qui correspond à ce que vous avez saisi jusqu'à présent s'affiche:

2275786a24f8f204.png

Sélectionnez l'API que vous souhaitez activer, puis cliquez sur Activer:

2556f923b628e31.png

Coût

Bien que de nombreuses API Google puissent être utilisées sans frais, l'utilisation des produits et API Google Cloud n'est pas sans frais. Lorsque vous activez des API Cloud, vous pouvez être invité à renseigner un compte de facturation actif. Il est toutefois important de noter que certains produits Google Cloud disposent d'un niveau"Always Free" (quotidien/mensuel) que vous devez dépasser pour que la facturation démarre. Sinon, votre carte de crédit (ou le mode de facturation spécifié) ne sera pas débitée.

Les utilisateurs doivent consulter les informations tarifaires de toute API avant de l'activer, en particulier pour savoir si elle propose un niveau sans frais et, le cas échéant, de quoi il s'agit. Si vous activez l'API Cloud Vision, consultez la page de ses informations tarifaires. Cloud Vision dispose d'un quota sans frais. Tant que votre utilisation agrégée ne dépasse pas les limites (pour chaque mois), aucuns frais ne vous seront facturés.

Les tarifs et les niveaux sans frais varient selon les API Google. Exemples :

  • Google Cloud/GCP : chaque produit est facturé différemment et est généralement facturé par cycle de processeur virtuel, par espace de stockage consommé, par utilisation de la mémoire ou par utilisation. Consultez les informations sur l'échelon sans frais ci-dessus.
  • Google Maps : propose une suite d'API et offre aux utilisateurs un crédit mensuel total de 200 USD.
  • API Google Workspace (anciennement G Suite) : leur utilisation est sans frais (dans certaines limites) et couverte par les frais d'abonnement mensuels Workspace. Par conséquent, il n'y a pas de facturation directe pour l'utilisation des API Gmail, Google Drive, Agenda, Docs, Sheets et Slides.

La procédure de facturation est différente selon les produits Google. Par conséquent, assurez-vous de vous référer à la documentation de votre API pour obtenir ces informations.

Résumé

Maintenant que vous savez comment activer les API Google en général, accédez au gestionnaire d'API et activez l'API Cloud Translation, Cloud Run et Cloud Artifact Registry (si ce n'est pas déjà fait). Vous activez la première, car notre application l'utilise. Vous devez activer ce dernier, car c'est là que nos images de conteneur sont stockées avant d'être déployées pour démarrer votre service Cloud Run. C'est pourquoi vous devez l'activer. Si vous préférez les activer tous avec l'outil gcloud, exécutez plutôt la commande suivante à partir de votre terminal:

gcloud services enable artifactregistry.googleapis.com run.googleapis.com translate.googleapis.com

Bien que son quota mensuel ne soit pas indiqué sur la page récapitulative du niveau "Toujours sans frais ", la page des tarifs de l'API Translation indique que tous les utilisateurs bénéficient d'un nombre fixe de caractères traduits par mois. Vous ne devriez pas être facturé par l'API si vous restez en dessous de ce seuil. Si d'autres frais liés à Google Cloud sont facturés, ils seront indiqués à la fin de la section "Nettoyage".

4. Obtenir le code de l'exemple d'application

Clonez le code du dépôt localement ou dans Cloud Shell (à l'aide de la commande git clone), ou téléchargez le fichier ZIP à partir du bouton vert Code, comme illustré dans la capture d'écran suivante:

5cd6110c4414cf65.png

Maintenant que vous avez tout, créez une copie complète du dossier pour suivre ce tutoriel spécifique, car vous devrez probablement supprimer ou modifier les fichiers. Si vous souhaitez effectuer un autre déploiement, vous pouvez recommencer en copiant l'original pour ne pas avoir à le cloner ni à le télécharger à nouveau.

5. Visite de l'application exemple

L'application exemple est un dérivé simple de Google Traduction qui invite les utilisateurs à saisir du texte en anglais et à recevoir la traduction équivalente de ce texte en espagnol. Ouvrez maintenant le fichier main.py pour voir comment il fonctionne. En ignorant les lignes commentées sur la licence, le fichier se présente comme suit en haut et en bas:

from flask import Flask, render_template, request
import google.auth
from google.cloud import translate

app = Flask(__name__)
_, PROJECT_ID = google.auth.default()
TRANSLATE = translate.TranslationServiceClient()
PARENT = 'projects/{}'.format(PROJECT_ID)
SOURCE, TARGET = ('en', 'English'), ('es', 'Spanish')

# . . . [translate() function definition] . . .

if __name__ == '__main__':
    import os
    app.run(debug=True, threaded=True, host='0.0.0.0',
            port=int(os.environ.get('PORT', 8080)))
  1. Les importations apportent la fonctionnalité Flask, le module google.auth et la bibliothèque cliente de l'API Cloud Translation.
  2. Les variables globales représentent l'application Flask, l'ID de projet Cloud, le client de l'API Translation, le "chemin d'accès" parent pour les appels de l'API Translation, ainsi que les langues source et cible. Dans ce cas, il s'agit de l'anglais (en) et de l'espagnol (es), mais vous pouvez remplacer ces valeurs par d'autres codes de langue compatibles avec l'API Cloud Translation.
  3. Le grand bloc if en bas est utilisé dans le tutoriel pour exécuter cette application en local. Il utilise le serveur de développement Flask pour diffuser notre application. Cette section est également présente dans les tutoriels de déploiement Cloud Run au cas où le serveur Web ne serait pas groupé dans le conteneur. Vous êtes invité à activer le regroupement du serveur dans le conteneur. Toutefois, si vous ne le faites pas, le code de l'application utilisera le serveur de développement Flask. (Ce n'est pas un problème avec App Engine ni Cloud Functions, car ce sont des plates-formes basées sur des sources, ce qui signifie que Google Cloud fournit et exécute un serveur Web par défaut.)

Enfin, au milieu de main.py se trouve le cœur de l'application, la fonction translate():

@app.route('/', methods=['GET', 'POST'])
def translate(gcf_request=None):
    """
    main handler - show form and possibly previous translation
    """

    # Flask Request object passed in for Cloud Functions
    # (use gcf_request for GCF but flask.request otherwise)
    local_request = gcf_request if gcf_request else request

    # reset all variables (GET)
    text = translated = None

    # if there is data to process (POST)
    if local_request.method == 'POST':
        text = local_request.form['text']
        data = {
            'contents': [text],
            'parent': PARENT,
            'target_language_code': TARGET[0],
        }
        # handle older call for backwards-compatibility
        try:
            rsp = TRANSLATE.translate_text(request=data)
        except TypeError:
            rsp = TRANSLATE.translate_text(**data)
        translated = rsp.translations[0].translated_text

    # create context & render template
    context = {
        'orig':  {'text': text, 'lc': SOURCE},
        'trans': {'text': translated, 'lc': TARGET},
    }
    return render_template('index.html', **context)

La fonction principale récupère la saisie de l'utilisateur et appelle l'API Translation pour effectuer les tâches lourdes. Décomposons-la:

  1. Vérifiez si les requêtes proviennent de Cloud Functions à l'aide de la variable local_request. Cloud Functions envoie son propre objet de requête Flask, tandis que tous les autres (exécutés localement ou déployés sur App Engine ou Cloud Run) obtiennent l'objet de requête directement depuis Flask.
  2. Réinitialisez les variables de base du formulaire. Cela concerne principalement les requêtes GET, car les requêtes POST contiennent des données qui les remplacent.
  3. S'il s'agit d'une requête POST, récupérez le texte à traduire et créez une structure JSON représentant les exigences de métadonnées de l'API. Appelez ensuite l'API, en revenant à une version précédente de l'API si l'utilisateur utilise une bibliothèque plus ancienne.
  4. Quoi qu'il en soit, mettez en forme les résultats réels (POST) ou aucune donnée (GET) dans le contexte du modèle et affichez-les.

La partie visuelle de l'application se trouve dans le fichier de modèle index.html. Il affiche les résultats déjà traduits (vides dans le cas contraire), suivis du formulaire demandant à traduire un élément:

<!doctype html>
<html><head><title>My Google Translate 1990s</title><body>
<h2>My Google Translate (1990s edition)</h2>

{% if trans['text'] %}
    <h4>Previous translation</h4>
    <li><b>Original</b>:   {{ orig['text'] }}  (<i>{{ orig['lc'][0] }}</i>)</li>
    <li><b>Translated</b>: {{ trans['text'] }} (<i>{{ trans['lc'][0] }}</i>)</li>
{% endif %}

<h4>Enter <i>{{ orig['lc'][1] }}</i> text to translate to <i>{{ trans['lc'][1] }}</i>:</h4>
<form method="POST"><input name="text"><input type="submit"></form>
</body></html>

6. Déployer le service

Vous êtes maintenant prêt à déployer votre service de traduction sur Cloud Run en exécutant la commande suivante:

gcloud run deploy translate --source . --allow-unauthenticated --platform managed

Le résultat doit se présenter comme suit et fournir des invites pour les prochaines étapes:

$ gcloud run deploy translate --source . --allow-unauthenticated --platform managed
Please specify a region:
 [1] asia-east1
 [2] asia-east2
. . . (other regions) . . .
 [28] us-west4
 [29] cancel
Please enter your numeric choice:  REGION_CHOICE

To make this the default region, run `gcloud config set run/region REGION`.

Deploying from source requires an Artifact Registry repository to
store build artifacts. A repository named [cloud-run-source-deploy] in
 region [REGION] will be created.

Do you want to continue (Y/n)?

This command is equivalent to running "gcloud builds submit --pack image=[IMAGE] ." and "gcloud run deploy translate --image [IMAGE]"

Building . . . and deploying container to Cloud Run service [translate] in project [PROJECT_ID] region [REGION]
✓ Building and deploying... Done.
  ✓ Creating Container Repository...
  ✓ Uploading sources...
  ✓ Building Container... Logs are available at [https://console.cloud.google.com/cloud-build/builds/60e1b
  9bb-b991-4b4e-8d8a-HASH?project=PROJECT_NUMBER].
  ✓ Creating Revision...
  ✓ Routing traffic...
  ✓ Setting IAM Policy...
Done.
Service [translate] revision [translate-00001-xyz] has been deployed and is serving 100 percent of traffic.
Service URL: https://SVC_NAME-HASH-REG_ABBR.a.run.app

Maintenant que votre application est disponible dans le monde entier, vous devriez pouvoir y accéder à l'URL contenant votre ID de projet, comme indiqué dans la sortie de déploiement:

169f6edf5f7d2068.png

Traduisez un texte pour voir comment ça marche.

31554e71cb80f1b4.png

7. Conclusion

Félicitations ! Vous avez appris à activer l'API Cloud Translation, à obtenir les identifiants nécessaires et à déployer une application Web simple dans Cloud Run Python 2. Pour en savoir plus sur ce déploiement, consultez ce tableau du dépôt.

Effectuer un nettoyage

L'API Cloud Translation vous permet de traduire un nombre fixe de caractères par mois sans frais. App Engine dispose également d'un quota sans frais, tout comme Cloud Functions et Cloud Run. Des frais vous seront facturés si vous dépassez l'un de ces deux seuils. Si vous prévoyez de passer à l'atelier de programmation suivant, vous n'avez pas besoin d'arrêter votre application.

Toutefois, si vous n'êtes pas encore prêt à passer au tutoriel suivant ou si vous craignez que l'application que vous venez de déployer soit découverte sur Internet, désactivez votre application App Engine, supprimez votre fonction Cloud ou désactivez votre service Cloud Run pour éviter de payer des frais. Lorsque vous serez prêt à passer au prochain atelier de programmation, vous pourrez le réactiver. En revanche, si vous ne souhaitez pas poursuivre cette application ou d'autres ateliers de programmation et que vous souhaitez tout supprimer complètement, vous pouvez arrêter votre projet.

De plus, le déploiement sur une plate-forme de calcul sans serveur Google Cloud entraîne des coûts de compilation et de stockage mineurs. Cloud Build dispose de son propre quota sans frais, tout comme Cloud Storage. Pour plus de transparence, Cloud Build crée l'image de votre application, qui est ensuite stockée dans Cloud Container Registry ou Artifact Registry, son successeur. Le stockage de cette image utilise une partie de ce quota, tout comme la sortie réseau lors du transfert de cette image vers le service. Toutefois, il est possible que vous ne résidiez pas dans une région où ce niveau d'utilisation sans frais est disponible. Veillez donc à surveiller votre utilisation de l'espace de stockage pour minimiser les coûts potentiels.

8. Ressources supplémentaires

Dans les sections suivantes, vous trouverez des ressources de lecture supplémentaires ainsi que des exercices recommandés pour approfondir les connaissances acquises dans ce tutoriel.

Étude supplémentaire

Maintenant que vous avez acquis une certaine expérience avec l'API Translation, effectuons quelques exercices supplémentaires pour développer vos compétences. Pour poursuivre votre parcours d'apprentissage, modifiez notre application exemple afin de:

  1. Terminez toutes les autres éditions de cet atelier de programmation pour l'exécuter en local ou le déployer sur les plates-formes de calcul sans serveur Google Cloud (voir le README du dépôt).
  2. Suivez ce tutoriel dans un autre langage de programmation.
  3. Modifiez cette application pour qu'elle prenne en charge différentes langues source ou cibles.
  4. Mettez à niveau cette application pour pouvoir traduire du texte dans plusieurs langues. Modifiez le fichier de modèle pour afficher un menu déroulant des langues cibles compatibles.

En savoir plus

Google App Engine

Google Cloud Functions

Google Cloud Run

Google Cloud Buildpacks, Container Registry, Artifact Registry

Google Cloud Translation et Google ML Kit

Autres produits/pages Google Cloud

Python et Flask

Licence

Ce tutoriel est publié sous une licence Creative Commons Attribution 2.0 Generic, tandis que le code source du dépôt est sous licence Apache 2.