Tester un service Cloud Run localement

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Pendant le développement, vous pouvez exécuter et tester votre image de conteneur localement, avant de la déployer. Vous pouvez utiliser Cloud Code ou Docker installé localement pour exécuter et tester en local, y compris avec un accès aux services Google Cloud.

Émulateur Cloud Code

Le plug-in Cloud Code pour les IDE JetBrains et VS Code vous permet d'exécuter et de déboguer votre image de conteneur localement dans un émulateur Cloud Run au sein de votre IDE. Cet émulateur vous permet de configurer un environnement représentatif de votre service exécuté sur Cloud Run.

Vous pouvez configurer des propriétés telles que l'allocation de processeur et de mémoire, spécifier des variables d'environnement et définir les connexions à la base de données Cloud SQL.

  1. Installez Cloud Code pour un IDE JetBrains ou VS Code.
  2. Suivez les instructions permettant de développer et de déboguer en local dans votre IDE.
  3. VS Code : développement et débogage en local
  4. IntelliJ : développement et débogage en local

CLI gcloud

Google Cloud CLI contient un environnement de développement local permettant d'émuler Cloud Run, qui peut créer un conteneur à partir de la source, exécuter le conteneur sur votre machine locale, puis reconstruire automatiquement le conteneur en fonction des modifications du code source.

Pour démarrer l'environnement de développement local :

  1. Remplacez le répertoire par celui qui contient le code source de votre service.

  2. Appelez la commande :

    gcloud beta code dev

Si un Dockerfile est présent dans le répertoire local, il est utilisé pour créer le conteneur. Si aucun Dockerfile n'est présent, le conteneur est créé avec des packs de création Google Cloud.

Pour voir votre service en cours d'exécution, saisissez l'adresse http://localhost:8080/ dans votre navigateur. Si vous avez spécifié un port personnalisé avec l'option --local-port, n'oubliez pas d'ouvrir votre navigateur pour ce port.

Pour arrêter le serveur local :

  • Mac OS et Linux : Contrôle+C
  • Windows : Contrôle-Pause

Personnaliser la configuration du service

Vous pouvez personnaliser la configuration Cloud Run du service qui s'exécute localement à l'aide d'un fichier YAML. Le format YAML peut être utilisé pour déployer un service Cloud Run, mais n'est compatible qu'avec un sous-ensemble des paramètres de service Cloud Run. gcloud beta code dev recherche et utilise tous les fichiers se terminant par *.service.dev.yaml dans le répertoire actuel. Si aucun fichier n'est trouvé, le fichier se terminant par *.service.yaml est utilisé.

Vous pouvez configurer les paramètres suivants pour le développement local :

Le champ image du conteneur n'est pas requis pour le développement local, car l'image est créée et fournie au service lors de l'exécution de la commande.

Vous pouvez utiliser l'exemple de fichier service.dev.yaml suivant pour le développement local :

  apiVersion: serving.knative.dev/v1
  kind: Service
  metadata:
    name: my-service-name
  spec:
    template:
      spec:
        containers:
        - env:
          - name: FOO
            value: bar

Utiliser des identifiants

Pour autoriser le conteneur à utiliser les services Google Cloud, vous devez lui attribuer un identifiant d'accès.

  • Pour permettre au conteneur d'accéder à un identifiant à l'aide de votre propre compte, connectez-vous à l'aide de gcloud et utilisez l'option --application-default-credential :

    gcloud auth application-default login
    gcloud beta code dev --dockerfile=PATH_TO_DOCKERFILE --application-default-credential

  • Pour attribuer des identifiants à l'application en tant que compte de service, utilisez l'option --service-account :

    gcloud beta code dev --dockerfile=PATH_TO_DOCKERFILE --service-account=SERVICE_ACCOUNT_EMAIL

    L'option --service-account entraîne le téléchargement et la mise en cache en local d'une clé de compte de service. L'utilisateur est tenu de sécuriser la clé et de la supprimer lorsqu'elle n'est plus nécessaire.

Docker

Pour tester votre image de conteneur localement à l'aide de Docker, procédez comme suit :

  1. Exécutez la commande Docker :

    PORT=8080 && docker run -p 9090:${PORT} -e PORT=${PORT} IMAGE_URL

    Remplacez IMAGE_URL par une référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/hello:latest.

    La variable d'environnement PORT spécifie le port que votre application utilisera pour écouter les requêtes HTTP ou HTTPS. Il s'agit d'une exigence du contrat d’exécution du conteneur. Dans cet exemple, nous utilisons le port 8080.

  2. Ouvrez http://localhost:9090 dans votre navigateur.

Si vous débutez avec les conteneurs, consultez le guide de démarrage de Docker. Pour en savoir plus sur les commandes Docker, consultez la documentation de Docker.

Docker avec accès Google Cloud

Si vous utilisez des bibliothèques clientes Google Cloud pour intégrer votre application aux services Google Cloud, et si vous n'avez pas encore sécurisé ces services pour contrôler l'accès externe, vous pouvez configurer votre conteneur local pour vous authentifier auprès des services Google Cloud à l'aide des identifiants par défaut de l'application.

Pour exécuter une image en local, procédez comme suit :

  1. Reportez-vous à la page Premier pas avec l'authentification pour savoir comment générer, récupérer et configurer vos identifiants de compte de service.

  2. Les options d'exécution de Docker suivantes injectent les identifiants et la configuration de votre système local dans le conteneur local :

    1. Utilisez l'option --volume (-v) pour injecter le fichier d'identifiants dans le conteneur (en supposant que vous avez déjà défini votre variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur votre machine) :
      -v $GOOGLE_APPLICATION_CREDENTIALS:/tmp/keys/FILE_NAME.json:ro
    2. Utilisez l'option --environment (-e) pour définir la variable GOOGLE_APPLICATION_CREDENTIALS dans le conteneur :
      -e GOOGLE_APPLICATION_CREDENTIALS=/tmp/keys/FILE_NAME.json
  3. Vous pouvez éventuellement utiliser la commande Docker run entièrement configurée ci-après :

    PORT=8080 && docker run \
    -p 9090:${PORT} \
    -e PORT=${PORT} \
    -e K_SERVICE=dev \
    -e K_CONFIGURATION=dev \
    -e K_REVISION=dev-00001 \
    -e GOOGLE_APPLICATION_CREDENTIALS=/tmp/keys/FILE_NAME.json \
    -v $GOOGLE_APPLICATION_CREDENTIALS:/tmp/keys/FILE_NAME.json:ro \
    IMAGE_URL

    Notez que le chemin d'accès

    /tmp/keys/FILE_NAME.json
    indiqué dans l'exemple ci-dessus est un emplacement approprié pour placer vos identifiants à l'intérieur du conteneur.

    D'autres emplacements de répertoire peuvent également convenir. L'essentiel est que la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS corresponde à l'emplacement du montage lié (bind mount) dans le conteneur.

    Notez également qu'avec certains services Google Cloud, vous pouvez utiliser une autre configuration pour isoler le dépannage local des performances et des données de production.

Étape suivante