Développement InnerLoop à l'aide de Cloud Workstations avec Python

1. Présentation

Cet atelier présente des fonctionnalités conçues pour simplifier le workflow de développement des ingénieurs logiciels chargés de développer des applications Python dans un environnement conteneurisé. Le développement de conteneurs typique exige de l'utilisateur qu'il comprenne les détails des conteneurs et du processus de création de conteneurs. De plus, les développeurs doivent généralement interrompre leur flux de travail et quitter leur IDE pour tester et déboguer leurs applications dans des environnements distants. Grâce aux outils et technologies mentionnés dans ce tutoriel, les développeurs peuvent travailler efficacement avec des applications conteneurisées sans quitter leur IDE.

Objectifs de l'atelier

Dans cet atelier, vous allez découvrir des méthodes de développement avec des conteneurs dans GCP, y compris :

• Créer une application de démarrage Python
• Parcourir le processus de développement
• Développer un service REST CRUD simple
• Déployer sur GKE
• Déboguer un état d'erreur
• Utiliser des points d'arrêt / journaux
• Déployer à chaud les modifications sur GKE

2. Préparation

Configuration de l'environnement d'auto-formation

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.)

• Le nom du projet est le nom à afficher pour les participants au projet. Il s'agit d'une chaîne de caractères non utilisée par les API Google. Vous pouvez le modifier à tout moment.
• L'ID du projet est unique parmi tous les projets Google Cloud et non modifiable une fois défini. La console Cloud génère automatiquement une chaîne unique (en général, vous n'y accordez d'importance particulière). Dans la plupart des ateliers de programmation, vous devrez indiquer l'ID du projet (généralement identifié par PROJECT_ID). Si l'ID généré ne vous convient pas, vous pouvez en générer un autre de manière aléatoire. Vous pouvez également en spécifier un et voir s'il est disponible. Après cette étape, l'ID n'est plus modifiable et restera donc le même pour toute la durée du projet.
• Pour information, il existe une troisième valeur (le numéro de projet) que certaines API utilisent. Pour en savoir plus sur ces trois valeurs, consultez la documentation.

Attention : Un ID de projet est unique au niveau mondial. Une fois que vous l'avez choisi, personne d'autre ne peut l'employer. Vous en êtes le seul utilisateur. Même si un projet est supprimé, son ID ne peut pas être réutilisé.

Remarque : Si vous utilisez un compte Gmail, vous pouvez conserver l'emplacement par défaut défini sur Aucune organisation. Si vous utilisez un compte Google Workspace, choisissez un emplacement pertinent pour votre organisation.

2. Vous devez ensuite activer la facturation dans la console Cloud pour utiliser les ressources/API Cloud. L'exécution de cet atelier de programmation est très peu coûteuse, voire sans frais. Pour désactiver les ressources et éviter ainsi que des frais ne vous soient facturés après ce tutoriel, vous pouvez supprimer le projet ou les ressources que vous avez créées. Les nouveaux utilisateurs de Google Cloud peuvent participer au programme d'essai sans frais pour bénéficier d'un crédit de 300$.

Démarrer l'éditeur Cloudshell

Cet atelier a été conçu et testé pour être utilisé avec l'éditeur Cloud Shell. Pour accéder à l'éditeur :

1. Accédez à votre projet Google à l'adresse https://console.cloud.google.com.
2. En haut à droite, cliquez sur l'icône de l'éditeur Cloud Shell.

3. Un nouveau volet s'ouvre en bas de la fenêtre.
4. Cliquez sur le bouton "Ouvrir l'éditeur".

5. L'éditeur s'ouvre avec un explorateur à droite et un éditeur dans la zone centrale.
6. Un volet de terminal doit également être disponible en bas de l'écran.
7. Si le terminal n'est PAS ouvert, utilisez la combinaison de touches "ctrl+`" pour ouvrir une nouvelle fenêtre de terminal.

Configuration de l'environnement

Dans Cloud Shell, définissez l'ID et le numéro de votre projet. Enregistrez-les en tant que variables PROJECT_ID et PROJECT_ID.

export PROJECT_ID=$(gcloud config get-value project)
export PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID \
    --format='value(projectNumber)')

Provisionner l'infrastructure utilisée dans cet atelier

Dans cet atelier, vous allez déployer du code sur GKE et accéder aux données stockées dans une base de données Spanner. Vous utiliserez également Cloud Workstations comme IDE. Le script de configuration ci-dessous prépare cette infrastructure pour vous.

1. Téléchargez le script d'installation et rendez-le exécutable.

wget https://raw.githubusercontent.com/GoogleCloudPlatform/container-developer-workshop/main/labs/python/setup_with_cw.sh
chmod +x setup_with_cw.sh

2. Ouvrez le fichier setup_with_cw.sh et modifiez les valeurs des mots de passe actuellement définis sur "CHANGEME".
3. Exécutez le script de configuration pour créer un cluster GKE et une base de données Spanner que vous utiliserez dans cet atelier.

./setup_with_cw.sh &

Cluster Cloud Workstations

1. Ouvrez Cloud Workstations dans la console Cloud. Attendez que le cluster soit à l'état READY.

Créer une configuration de stations de travail

1. Si votre session Cloud Shell a été déconnectée, cliquez sur "Se reconnecter", puis exécutez la commande gcloud CLI pour définir l'ID du projet. Avant d'exécuter la commande, remplacez l'ID de projet exemple ci-dessous par l'ID de votre projet Qwiklabs.

gcloud config set project qwiklabs-gcp-project-id

2. Téléchargez et exécutez le script ci-dessous dans le terminal pour créer la configuration Cloud Workstations.

wget https://raw.githubusercontent.com/GoogleCloudPlatform/container-developer-workshop/main/labs/python/workstation_config_setup.sh
chmod +x workstation_config_setup.sh
./workstation_config_setup.sh

3. Vérifiez les résultats dans la section "Configurations". Le passage à l'état PRÊT prendra deux minutes.

4. Ouvrez Cloud Workstations dans la console et créez une instance.

5. Remplacez le nom par my-workstation et sélectionnez la configuration existante : codeoss-python.

6. Vérifiez les résultats dans la section "Postes de travail".

Lancer la station de travail

1. Démarrez et lancez la station de travail. Le démarrage de la station de travail prend quelques minutes.

2. Autorisez les cookies tiers en cliquant sur l'icône dans la barre d'adresse.

3. Cliquez sur "Impossible d'accéder au site ?".

4. Cliquez sur "Autoriser les cookies".

5. Une fois la station de travail lancée, l'IDE Code OSS s'affiche. Cliquez sur "Marquer comme terminé" sur la page "Premiers pas" de l'IDE de la station de travail.

3. Créer une application de démarrage Python

Dans cette section, vous allez créer une application Python.

1. Ouvrez un nouveau terminal.

2. Créer un répertoire et l'ouvrir en tant qu'espace de travail

mkdir music-service && cd music-service

code-oss-cloud-workstations -r --folder-uri="$PWD"

Si ce message s'affiche, cliquez sur le bouton "Autoriser" pour pouvoir copier et coller le texte dans la station de travail.

3. Créez un fichier nommé requirements.txt et copiez-y le contenu suivant :

Flask
gunicorn
google-cloud-spanner
ptvsd==4.3.2

4. Créez un fichier nommé app.py et collez-y le code suivant :

import os
from flask import Flask, request, jsonify
from google.cloud import spanner

app = Flask(__name__)

@app.route("/")
def hello_world():
    message="Hello, World!"
    return message

if __name__ == '__main__':
    server_port = os.environ.get('PORT', '8080')
    app.run(debug=False, port=server_port, host='0.0.0.0')

5. Créez un fichier nommé Dockerfile et collez-y le code suivant :

FROM python:3.8
ARG FLASK_DEBUG=0
ENV FLASK_DEBUG=$FLASK_DEBUG
ENV FLASK_APP=app.py
WORKDIR /app
COPY requirements.txt .
RUN pip install --trusted-host pypi.python.org -r requirements.txt
COPY . .
ENTRYPOINT ["python3", "-m", "flask", "run", "--port=8080", "--host=0.0.0.0"]

Remarque : FLASK_DEBUG=1 vous permet de recharger automatiquement les modifications de code dans une application Python Flask. Ce Dockerfile vous permet de transmettre cette valeur en tant qu'argument de compilation.

Générer des fichiers manifestes

Dans votre terminal, exécutez la commande suivante pour générer un fichier skaffold.yaml et deployment.yaml par défaut.

1. Initialisez Skaffold à l'aide de la commande suivante :

skaffold init --generate-manifests

Lorsque vous y êtes invité, utilisez les flèches pour déplacer le curseur et la barre d'espace pour sélectionner les options.

Choisissez :

• 8080 pour le port
• y pour enregistrer la configuration

Mettre à jour les configurations Skaffold

• Modifier le nom de l'application par défaut
• Ouvrir skaffold.yaml
• Sélectionnez le nom de l'image actuellement défini sur dockerfile-image.
• Effectuez un clic droit et sélectionnez "Modifier toutes les occurrences".
• Saisissez le nouveau nom, par exemple python-app.
• Modifiez la section "build" pour
• Ajouter docker.buildArgs à la carte FLASK_DEBUG=1
• Synchroniser les paramètres pour charger les modifications apportées aux fichiers *.py de l'IDE au conteneur en cours d'exécution

Après les modifications, la section de compilation du fichier skaffold.yaml se présente comme suit :

build:
 artifacts:
 - image: python-app
   docker:
     buildArgs:
       FLASK_DEBUG: "1"
     dockerfile: Dockerfile
   sync:
     infer:
     - '**/*.py'

Modifier le fichier de configuration Kubernetes

1. Modifier le nom par défaut

• Ouvrir le fichier deployment.yaml
• Sélectionnez le nom de l'image actuellement défini sur dockerfile-image.
• Effectuez un clic droit et sélectionnez "Modifier toutes les occurrences".
• Saisissez le nouveau nom, par exemple python-app.

4. Parcourir le processus de développement

Maintenant que la logique métier est ajoutée, vous pouvez déployer et tester votre application. La section suivante montre comment utiliser le plug-in Cloud Code. Ce plug-in s'intègre, entre autres, à skaffold pour simplifier votre processus de développement. Lorsque vous déployez sur GKE lors des étapes suivantes, Cloud Code et Skaffold créent automatiquement votre image de conteneur, la transfèrent vers Container Registry, puis déploient l'application your sur GKE. Cela se produit en arrière-plan, en masquant les détails du flux de développement.

Se connecter à Google Cloud

1. Cliquez sur l'icône Cloud Code, puis sélectionnez "Se connecter à Google Cloud" :

2. Cliquez sur "Continuer".

3. Vérifiez le résultat dans le terminal et ouvrez le lien :

4. Connectez-vous avec vos identifiants Qwiklabs pour les étudiants.

5. Sélectionnez "Autoriser" :

6. Copiez le code de validation et revenez à l'onglet "Poste de travail".

7. Collez le code de validation, puis appuyez sur Entrée.

Ajouter un cluster Kubernetes

1. Ajouter un cluster

2. Sélectionnez Google Kubernetes Engine :

3. Sélectionnez un projet.

4. Sélectionnez "python-cluster" créé lors de la configuration initiale.

5. Le cluster apparaît désormais dans la liste des clusters Kubernetes sous Cloud Code. À partir de là, parcourez et explorez le cluster.

Définir l'ID du projet actuel à l'aide de gcloud CLI

1. Copiez l'ID du projet pour cet atelier à partir de la page Qwiklabs.

2. Dans le terminal, exécutez la commande gcloud CLI pour définir l'ID du projet. Remplacez l'ID du projet exemple avant d'exécuter la commande. REMPLACEZ l'ID du projet avant d'exécuter la commande ci-dessous.

gcloud config set project qwiklabs-gcp-project-id

Déployer sur Kubernetes

1. Dans le volet situé au bas de l'éditeur Cloud Shell, sélectionnez Cloud Code .

2. Dans le panneau qui s'affiche en haut, sélectionnez Exécuter sur Kubernetes. Si vous y êtes invité, sélectionnez "Oui" pour utiliser le contexte Kubernetes actuel.

Cette commande compile le code source, puis exécute les tests. L'exécution de la compilation et des tests prend quelques minutes. Ces tests incluent des tests unitaires ainsi qu'une étape de validation qui vérifie les règles définies pour l'environnement de déploiement. Cette étape de validation est déjà configurée. Elle vous permet d'être averti en cas de problème de déploiement, même lorsque vous travaillez toujours dans votre environnement de développement.

3. La première fois que vous exécutez la commande, une invite s'affiche en haut de l'écran pour vous demander si vous souhaitez utiliser le contexte Kubernetes actuel. Sélectionnez "Oui" pour accepter et utiliser le contexte actuel.
4. Une invite s'affiche ensuite pour vous demander quel registre de conteneurs utiliser. Appuyez sur Entrée pour accepter la valeur par défaut fournie.
5. Sélectionnez l'onglet "Sortie" dans le volet inférieur pour afficher la progression et les notifications. Dans le menu déroulant, sélectionnez "Kubernetes: Run/Debug" (Kubernetes : exécuter/déboguer).

6. Sélectionnez "Kubernetes: Run/Debug - Detailed" (Kubernetes : Exécuter/Déboguer – Détails) dans le menu déroulant à droite pour afficher des informations supplémentaires et les journaux diffusés en direct depuis les conteneurs.

Une fois la compilation et les tests terminés, l'URL http://localhost:8080 s'affiche dans les journaux de l'onglet "Sortie" de la vue "Kubernetes : Exécuter/Déboguer".

7. Dans le terminal Cloud Code, pointez sur la première URL de la sortie (http://localhost:8080), puis sélectionnez "Ouvrir l'aperçu sur le Web" dans l'info-bulle qui s'affiche.
8. Un nouvel onglet de navigateur s'ouvre et affiche le message Hello, World!.

Hot reload

1. Ouvrez le fichier app.py.
2. Modifie le message d'accueil en Hello from Python

Vous remarquerez immédiatement que, dans la fenêtre Output, vue Kubernetes: Run/Debug, le détecteur synchronise les fichiers mis à jour avec le conteneur dans Kubernetes.

Update initiated
Build started for artifact python-app
Build completed for artifact python-app

Deploy started
Deploy completed

Status check started
Resource pod/python-app-6f646ffcbb-tn7qd status updated to In Progress
Resource deployment/python-app status updated to In Progress
Resource deployment/python-app status completed successfully
Status check succeeded
...

3. Si vous passez à la vue Kubernetes: Run/Debug - Detailed, vous remarquerez qu'elle reconnaît les modifications apportées aux fichiers, puis compile et redéploie l'application.

files modified: [app.py]
Syncing 1 files for gcr.io/veer-pylab-01/python-app:3c04f58-dirty@sha256:a42ca7250851c2f2570ff05209f108c5491d13d2b453bb9608c7b4af511109bd
Copying files:map[app.py:[/app/app.py]]togcr.io/veer-pylab-01/python-app:3c04f58-dirty@sha256:a42ca7250851c2f2570ff05209f108c5491d13d2b453bb9608c7b4af511109bd
Watching for changes...
[python-app] * Detected change in '/app/app.py', reloading
[python-app] * Restarting with stat
[python-app] * Debugger is active!
[python-app] * Debugger PIN: 744-729-662

4. Actualisez l'onglet de votre navigateur dans lequel vous avez vu les résultats précédents pour afficher les résultats mis à jour.

Débogage

1. Accédez à la vue Déboguer et arrêtez le thread actuel . Si vous y êtes invité, vous pouvez choisir de nettoyer après chaque exécution.
2. 
3. Cliquez sur Cloud Code dans le menu du bas, puis sélectionnez Debug on Kubernetes pour exécuter l'application en mode debug.

• Dans la vue Kubernetes Run/Debug - Detailed de la fenêtre Output, notez que Skaffold déploie cette application en mode débogage.

4. Lorsque le processus est terminé. Vous remarquerez qu'un débogueur est associé et que l'onglet "Output" (Sortie) indique Attached debugger to container "python-app-8476f4bbc-h6dsl" successfully., et que l'URL http://localhost:8080 est listée.

Port forwarding pod/python-app-8bd64cf8b-cskfl in namespace default, remote port 5678 -> http://127.0.0.1:5678

5. La couleur de la barre d'état inférieure passe du bleu à l'orange, ce qui indique qu'elle est en mode Débogage.
6. Dans la vue Kubernetes Run/Debug, notez qu'un conteneur débogable est démarré.

**************URLs*****************
Forwarded URL from service python-app: http://localhost:8080
Debuggable container started pod/python-app-8bd64cf8b-cskfl:python-app (default)
Update succeeded
***********************************

Utiliser les points d'arrêt

1. Ouvrez le fichier app.py.
2. Recherchez l'instruction return message.
3. Ajoutez un point d'arrêt à cette ligne en cliquant sur l'espace vide à gauche du numéro de ligne. Un indicateur rouge s'affiche pour indiquer que le point d'arrêt est défini.
4. La première fois que vous exécutez cette commande, une invite vous demande où se trouve la source dans le conteneur. Cette valeur est liée aux répertoires du fichier Dockerfile.

Appuyez sur Entrée pour accepter la valeur par défaut.

La création et le déploiement de l'application prennent quelques minutes.

5. Rechargez votre navigateur et notez que le débogueur arrête le processus au point d'arrêt et vous permet d'examiner les variables et l'état de l'application qui s'exécute à distance dans GKE.
6. Cliquez sur la section "VARIABLES".
7. Cliquez sur "Locals" (Variables locales), puis recherchez la variable "message".
8. Double-cliquez sur le nom de la variable "message", puis, dans le pop-up, remplacez la valeur par une autre valeur, par exemple "Greetings from Python".
9. Cliquez sur le bouton "Continuer" dans le panneau de configuration du débogage .
10. Examinez la réponse dans votre navigateur. Elle affiche désormais la valeur modifiée que vous venez de saisir.
11. Arrêtez le mode "Débogage" en appuyant sur le bouton d'arrêt , puis supprimez le point d'arrêt en cliquant à nouveau dessus.

5. Développer un service REST CRUD simple

À ce stade, votre application est entièrement configurée pour le développement conteneurisé et vous avez parcouru le workflow de développement de base avec Cloud Code. Dans les sections suivantes, vous allez mettre en pratique ce que vous avez appris en ajoutant des points de terminaison de service REST qui se connectent à une base de données gérée dans Google Cloud.

Coder le service REST

Le code ci-dessous crée un service REST simple qui utilise Spanner comme base de données pour l'application. Créez l'application en copiant le code suivant dans votre application.

1. Créez l'application principale en remplaçant app.py par le contenu suivant :

import os
from flask import Flask, request, jsonify
from google.cloud import spanner


app = Flask(__name__)


instance_id = "music-catalog"

database_id = "musicians"

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)


@app.route("/")
def hello_world():
    return "<p>Hello, World!</p>"

@app.route('/singer', methods=['POST'])
def create():
    try:
        request_json = request.get_json()
        singer_id = request_json['singer_id']
        first_name = request_json['first_name']
        last_name = request_json['last_name']
        def insert_singers(transaction):
            row_ct = transaction.execute_update(
                f"INSERT Singers (SingerId, FirstName, LastName) VALUES" \
                f"({singer_id}, '{first_name}', '{last_name}')"
            )
            print("{} record(s) inserted.".format(row_ct))

        database.run_in_transaction(insert_singers)

        return {"Success": True}, 200
    except Exception as e:
        return e



@app.route('/singer', methods=['GET'])
def get_singer():

    try:
        singer_id = request.args.get('singer_id')
        def get_singer():
            first_name = ''
            last_name = ''
            with database.snapshot() as snapshot:
                results = snapshot.execute_sql(
                    f"SELECT SingerId, FirstName, LastName FROM Singers " \
                    f"where SingerId = {singer_id}",
                    )
                for row in results:
                    first_name = row[1]
                    last_name = row[2]
                return (first_name,last_name )
        first_name, last_name = get_singer()  
        return {"first_name": first_name, "last_name": last_name }, 200
    except Exception as e:
        return e


@app.route('/singer', methods=['PUT'])
def update_singer_first_name():
    try:
        singer_id = request.args.get('singer_id')
        request_json = request.get_json()
        first_name = request_json['first_name']
        
        def update_singer(transaction):
            row_ct = transaction.execute_update(
                f"UPDATE Singers SET FirstName = '{first_name}' WHERE SingerId = {singer_id}"
            )

            print("{} record(s) updated.".format(row_ct))

        database.run_in_transaction(update_singer)
        return {"Success": True}, 200
    except Exception as e:
        return e


@app.route('/singer', methods=['DELETE'])
def delete_singer():
    try:
        singer_id = request.args.get('singer')
    
        def delete_singer(transaction):
            row_ct = transaction.execute_update(
                f"DELETE FROM Singers WHERE SingerId = {singer_id}"
            )
            print("{} record(s) deleted.".format(row_ct))

        database.run_in_transaction(delete_singer)
        return {"Success": True}, 200
    except Exception as e:
        return e

port = int(os.environ.get('PORT', 8080))
if __name__ == '__main__':
    app.run(threaded=True, host='0.0.0.0', port=port)

Ajouter des configurations de base de données

Pour vous connecter à Spanner de manière sécurisée, configurez l'application pour qu'elle utilise les identités de charge de travail. Cela permet à votre application d'agir en tant que compte de service et de disposer d'autorisations individuelles lors de l'accès à la base de données.

1. Mettez à jour deployment.yaml. Ajoutez le code suivant à la fin du fichier (assurez-vous de conserver les retraits de tabulation de l'exemple ci-dessous)

      serviceAccountName: python-ksa
      nodeSelector:
        iam.gke.io/gke-metadata-server-enabled: "true" 

Une fois les modifications effectuées, la section "spec" devrait se présenter comme suit :

   spec:
     containers:
     - name: python-app
       image: python-app
     serviceAccountName: python-ksa
     nodeSelector:
       iam.gke.io/gke-metadata-server-enabled: "true"

Déployer et valider l'application

1. Dans le volet situé au bas de l'éditeur Cloud Shell, sélectionnez Cloud Code, puis Debug on Kubernetes en haut de l'écran.
2. Une fois la compilation et les tests terminés, l'onglet "Résultat" indique Resource deployment/python-app status completed successfully et affiche l'URL "URL transférée depuis le service python-app : http://localhost:8080".
3. Ajoutez quelques entrées.

Dans le terminal Cloud Shell, exécutez la commande ci-dessous.

curl -X POST http://localhost:8080/singer -H 'Content-Type: application/json' -d '{"first_name":"Cat","last_name":"Meow", "singer_id": 6}'

4. Testez la requête GET en exécutant la commande ci-dessous dans le terminal.

curl -X GET http://localhost:8080/singer?singer_id=6

5. Test de suppression : essayez maintenant de supprimer une entrée en exécutant la commande suivante. Modifiez la valeur de item-id si nécessaire.

curl -X DELETE http://localhost:8080/singer?singer_id=6

    This throws an error message

500 Internal Server Error

Identifier et résoudre le problème

1. Passez en mode débogage et identifiez le problème. Voici quelques conseils :

• Nous savons que quelque chose ne va pas avec la méthode DELETE, car elle ne renvoie pas le résultat souhaité. Vous définissez donc le point d'arrêt dans app.py dans la méthode delete_singer.
• Exécutez l'exécution pas à pas et observez les variables à chaque étape pour voir les valeurs des variables locales dans la fenêtre de gauche.
• Pour observer des valeurs spécifiques telles que singer_id et request.args, ajoutez ces variables à la fenêtre "Espion".

2. Notez que la valeur attribuée à singer_id est None. Modifiez le code pour résoudre le problème.

L'extrait de code corrigé se présente comme suit.

@app.route('/delete-singer', methods=['DELETE', 'GET'])
def delete_singer():
    try:
        singer_id = request.args.get('singer_id')

3. Une fois l'application redémarrée, réessayez de supprimer le fichier.
4. Arrêtez la session de débogage en cliquant sur le carré rouge dans la barre d'outils de débogage .

6. Nettoyage

Félicitations ! Dans cet atelier, vous avez créé une application Python à partir de zéro et l'avez configurée pour qu'elle fonctionne efficacement avec les conteneurs. Vous avez ensuite déployé et débogué votre application sur un cluster GKE distant en suivant le même flux de développement que celui utilisé dans les piles d'applications traditionnelles.

Pour effectuer le nettoyage une fois l'atelier terminé :

1. Supprimer les fichiers utilisés dans l'atelier

cd ~ && rm -rf ~/music-service

2. Supprimer le projet pour supprimer toute l'infrastructure et les ressources associées