Diffuser du contenu dynamique et héberger des microservices avec Cloud Run

Associez Cloud Run à Firebase Hosting pour générer et diffuser votre contenu dynamique ou créer des API REST en tant que microservices.

Avec Cloud Run, vous pouvez déployer une application empaquetée dans une image de conteneur. Ensuite, à l'aide de Firebase Hosting, vous pouvez diriger les requêtes HTTPS pour déclencher votre application conteneurisée.

  • Cloud Run est compatible avec plusieurs langages (y compris Go, Node.js, Python et Java), ce qui vous permet d'utiliser le langage de programmation et le framework de votre choix.
  • Cloud Run effectue un scaling automatique et horizontal de votre image de conteneur pour traiter les requêtes reçues, puis évolue à la baisse lorsque la demande diminue.
  • Vous ne payez que pour le processeur, la mémoire et le réseau utilisés lors du traitement des requêtes.

Pour obtenir des exemples de cas d'utilisation et d'intégration de Cloud Run à Firebase Hosting, consultez notre présentation du sans serveur.


Ce guide vous explique comment:

  1. Écrire une application Hello World simple
  2. Conteneuriser une application et l'importer dans Artifact Registry
  3. Déployer l'image de conteneur sur Cloud Run
  4. Diriger les requêtes Hosting vers votre application conteneurisée

Notez que pour améliorer les performances de la diffusion de contenu dynamique, vous pouvez éventuellement ajuster vos paramètres de cache.

Avant de commencer

Avant d'utiliser Cloud Run, vous devez effectuer certaines tâches initiales, y compris configurer un compte Cloud Billing, activer l'API Cloud Run et installer l'outil de ligne de commande gcloud.

Configurer la facturation de votre projet

Cloud Run propose un quota d'utilisation sans frais, mais vous devez tout de même disposer d'un compte Cloud Billing associé à votre projet Firebase pour utiliser ou tester Cloud Run.

Activer l'API et installer le SDK

  1. Activez l'API Cloud Run dans la console Google APIs:

    1. Ouvrez la page API Cloud Run dans la console Google APIs.

    2. Lorsque vous y êtes invité, sélectionnez votre projet Firebase.

    3. Cliquez sur Activer sur la page de l'API Cloud Run.

  2. Installez et initialisez le SDK Cloud.

  3. Vérifiez que l'outil gcloud est configuré pour le bon projet:

    gcloud config list

Étape 1: Écrire l'exemple d'application

Notez que Cloud Run est compatible avec de nombreuses autres langues en plus de celles présentées dans l'exemple suivant.

Accéder

  1. Créez un répertoire nommé helloworld-go, puis modifiez les sous-répertoires comme suit:

    mkdir helloworld-go
     
    cd helloworld-go

  2. Créez un fichier nommé helloworld.go, puis ajoutez le code suivant:

    package main

import (
	"fmt"
	"log"
	"net/http"
	"os"
)

func handler(w http.ResponseWriter, r *http.Request) {
	log.Print("helloworld: received a request")
	target := os.Getenv("TARGET")
	if target == "" {
		target = "World"
	}
	fmt.Fprintf(w, "Hello %s!\n", target)
}

func main() {
	log.Print("helloworld: starting server...")

	http.HandleFunc("/", handler)

	port := os.Getenv("PORT")
	if port == "" {
		port = "8080"
	}

	log.Printf("helloworld: listening on port %s", port)
	log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", port), nil))
}

    helloworld.go

    Ce code crée un serveur Web de base qui écoute le port défini par la variable d’environnement PORT.

Votre application est terminée et prête à être conteneurisée, puis importée dans Artifact Registry.

Node.js

  1. Créez un répertoire nommé helloworld-nodejs, puis modifiez les sous-répertoires comme suit:

    mkdir helloworld-nodejs
     
    cd helloworld-nodejs

  2. Créez un fichier package.json avec le contenu suivant :

    {
  "name": "knative-serving-helloworld",
  "version": "1.0.0",
  "description": "Simple hello world sample in Node",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "author": "",
  "license": "Apache-2.0",
  "dependencies": {
    "express": "^4.21.1"
  }
}

    package.json

  3. Créez un fichier nommé index.js, puis ajoutez le code suivant:

    const express = require('express');
const app = express();

app.get('/', (req, res) => {
  console.log('Hello world received a request.');

  const target = process.env.TARGET || 'World';
  res.send(`Hello ${target}!\n`);
});

const port = process.env.PORT || 8080;
app.listen(port, () => {
  console.log('Hello world listening on port', port);
});

    index.js

    Ce code crée un serveur Web de base qui écoute le port défini par la variable d’environnement PORT.

Votre application est terminée et prête à être conteneurisée, puis importée dans Artifact Registry.

Python

  1. Créez un répertoire nommé helloworld-python, puis modifiez les sous-répertoires comme suit:

    mkdir helloworld-python
     
    cd helloworld-python

  2. Créez un fichier nommé app.py, puis ajoutez le code suivant:

    import os

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello_world():
    target = os.environ.get('TARGET', 'World')
    return 'Hello {}!\n'.format(target)

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

    app.py

    Ce code crée un serveur Web de base qui écoute le port défini par la variable d’environnement PORT.

Votre application est terminée et prête à être conteneurisée, puis importée dans Artifact Registry.

Java

  1. Installez Java SE 8 ou une version ultérieure du JDK et CURL.

    Notez que nous n'avons à le faire que pour créer le projet Web à l'étape suivante. Le fichier Docker, décrit ultérieurement, chargera toutes les dépendances dans le conteneur.

  2. À partir de la console, créez un projet Web vide à l'aide des commandes cURL et unzip:

    curl https://start.spring.io/starter.zip \
    -d dependencies=web \
    -d name=helloworld \
    -d artifactId=helloworld \
    -o helloworld.zip
     
    unzip helloworld.zip

    Un projet SpringBoot est créé.

  3. Mettez à jour la classe SpringBootApplication dans src/main/java/com/example/helloworld/HelloworldApplication.java en ajoutant une valeur @RestController pour gérer le mappage /, et ajoutez également un champ @Value pour fournir la variable d'environnement TARGET:

    package com.example.helloworld;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
public class HelloworldApplication {

  @Value("${TARGET:World}")
  String target;

  @RestController
  class HelloworldController {
    @GetMapping("/")
    String hello() {
      return "Hello " + target + "!";
    }
  }

  public static void main(String[] args) {
    SpringApplication.run(HelloworldApplication.class, args);
  }
}

    HelloworldApplication.java

    Ce code crée un serveur Web de base qui écoute le port défini par la variable d’environnement PORT.

Votre application est terminée et prête à être conteneurisée, puis importée dans Artifact Registry.

Étape 2: Containerisez une application et importez-la dans Artifact Registry

  1. Conteneurisez l'application exemple en créant un fichier nommé Dockerfile dans le même répertoire que les fichiers sources. Copiez le contenu suivant dans votre fichier.

    Accéder

    # Use the official Golang image to create a build artifact.
# This is based on Debian and sets the GOPATH to /go.
FROM golang:latest AS builder

ARG TARGETOS
ARG TARGETARCH

# Create and change to the app directory.
WORKDIR /app

# Copy local code to the container image.
COPY . ./

# Install dependencies and tidy up the go.mod and go.sum files.
RUN go mod tidy

# Build the binary.
# -mod=readonly ensures immutable go.mod and go.sum in container builds.
RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -mod=readonly -v -o server

# Use the official Alpine image for a lean production container.
# https://hub.docker.com/_/alpine
# https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds
FROM alpine:3
RUN apk add --no-cache ca-certificates

# Copy the binary to the production image from the builder stage.
COPY --from=builder /app/server /server

# Run the web service on container startup.
CMD ["/server"]

    Dockerfile

    Node.js

    # Use the official lightweight Node.js 12 image.
# https://hub.docker.com/_/node
FROM node:12-slim

# Create and change to the app directory.
WORKDIR /usr/src/app

# Copy application dependency manifests to the container image.
# A wildcard is used to ensure both package.json AND package-lock.json are copied.
# Copying this separately prevents re-running npm install on every code change.
COPY package*.json ./

# Install production dependencies.
RUN npm install --only=production

# Copy local code to the container image.
COPY . ./

# Run the web service on container startup.
CMD [ "npm", "start" ]

    Dockerfile

    Python

    # Use the official lightweight Python image.
# https://hub.docker.com/_/python
FROM python:3.7-slim

# Allow statements and log messages to immediately appear in the Knative logs
ENV PYTHONUNBUFFERED True

# Copy local code to the container image.
ENV APP_HOME /app
WORKDIR $APP_HOME
COPY . ./

# Install production dependencies.
RUN pip install Flask gunicorn

# Run the web service on container startup. Here we use the gunicorn
# webserver, with one worker process and 8 threads.
# For environments with multiple CPU cores, increase the number of workers
# to be equal to the cores available.
CMD exec gunicorn --bind :$PORT --workers 1 --threads 8 --timeout 0 app:app

    Dockerfile

    Java

    # Use the official maven/Java 8 image to create a build artifact: https://hub.docker.com/_/maven
FROM maven:3.5-jdk-8-alpine AS builder

# Copy local code to the container image.
WORKDIR /app
COPY pom.xml .
COPY src ./src

# Build a release artifact.
RUN mvn package -DskipTests

# Use the Official OpenJDK image for a lean production stage of our multi-stage build.
# https://hub.docker.com/_/openjdk
# https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds
FROM openjdk:8-jre-alpine

# Copy the jar to the production image from the builder stage.
COPY --from=builder /app/target/helloworld-*.jar /helloworld.jar

# Run the web service on container startup.
CMD ["java", "-Djava.security.egd=file:/dev/./urandom", "-jar", "/helloworld.jar"]

    Dockerfile

  2. Créez votre image de conteneur à l'aide de Cloud Build en exécutant la commande suivante à partir du répertoire contenant votre fichier Dockerfile:

    gcloud builds submit --tag gcr.io/PROJECT_ID/helloworld

    En cas de réussite, un message SUCCESS apparaît contenant le nom de l'image
    (gcr.io/PROJECT_ID/helloworld).

L'image du conteneur est désormais stockée dans Artifact Registry et peut être réutilisée si vous le souhaitez.

Notez qu'au lieu de Cloud Build, vous pouvez utiliser une version de Docker installée en local pour créer votre conteneur en local.

Étape 3: Déployez l'image du conteneur sur Cloud Run

  1. Utilisez la commande suivante pour effectuer le déploiement :

    gcloud run deploy --image gcr.io/PROJECT_ID/helloworld

  2. Lorsque vous y êtes invité :

  3. Patientez quelques instants que le déploiement soit terminé. En cas de réussite, la ligne de commande affiche l'URL du service. Par exemple : https://helloworld-RANDOM_HASH-us-central1.a.run.app

  4. Accédez à votre conteneur déployé en ouvrant l'URL du service dans un navigateur Web.

L'étape suivante vous explique comment accéder à cette application conteneurisée à partir d'une URL Firebase Hosting afin qu'elle puisse générer du contenu dynamique pour votre site hébergé par Firebase.

Étape 4:Diriger les requêtes d'hébergement vers votre application conteneurisée

Les règles de réécriture vous permettent de rediriger les requêtes correspondant à des modèles spécifiques vers une seule destination.

L'exemple suivant montre comment diriger toutes les requêtes de la page /helloworld sur votre site Hosting pour déclencher le démarrage et l'exécution de votre instance de conteneur helloworld.

  1. Vérifiez les points suivants :

    Pour obtenir des instructions détaillées sur l'installation de la CLI et l'initialisation de Hosting, consultez le guide de démarrage pour Hosting.

  2. Ouvrez votre fichier firebase.json.

  3. Ajoutez la configuration rewrite suivante sous la section hosting:

    "hosting": {
  // ...

  // Add the "rewrites" attribute within "hosting"
  "rewrites": [ {
    "source": "/helloworld",
    "run": {
      "serviceId": "helloworld",  // "service name" (from when you deployed the container image)
      "region": "us-central1",    // optional (if omitted, default is us-central1)
      "pinTag": true              // optional (see note below)
    }
  } ]
}

  4. Déployez votre configuration d'hébergement sur votre site en exécutant la commande suivante à partir de la racine du répertoire de votre projet:

    firebase deploy --only hosting

Votre conteneur est désormais accessible via les URL suivantes:

  • Vos sous-domaines Firebase:
    PROJECT_ID.web.app/ et PROJECT_ID.firebaseapp.com/

  • Domaines personnalisés connectés:
    CUSTOM_DOMAIN/

Pour en savoir plus sur les règles de réécriture, consultez la page de configuration de Hosting. Vous pouvez également découvrir l'ordre de priorité des réponses pour différentes configurations Hosting.

Tester en local

Pendant le développement, vous pouvez exécuter et tester votre image de conteneur localement. Pour obtenir des instructions détaillées, consultez la documentation Cloud Run.

Étapes suivantes