esegui il deployment del backend dell'API

Questa pagina spiega come eseguire il deployment del codice di backend dell'API e del proxy di servizio Extensible (ESP) in Google Kubernetes Engine e Compute Engine.

Sebbene i passaggi di deployment variano a seconda della piattaforma che ospita l'API, esiste sempre un passaggio in cui fornisci a ESP il nome del servizio e un'opzione che configura ESP in modo da utilizzare la configurazione del servizio Cloud Endpoints di cui è stato eseguito il deployment più di recente. Con queste informazioni, ESP può ottenere la configurazione degli endpoint dell'API, che consente di eseguire il proxy delle richieste e delle risposte in modo che Cloud Endpoints possa gestire l'API.

Prerequisiti

Per iniziare, questa pagina presuppone che tu abbia:

Preparazione al deployment

Compute Engine

Affinché Endpoints possa gestire la tua API, devi installare e configurare ESP, nonché il codice del server di backend per l'API. Devi installare Docker sull'istanza VM Compute Engine per poter eseguire l'immagine Docker ESP disponibile gratuitamente in Container Registry.

Prima del deployment:

Prima di poter eseguire il deployment dell'API e dell'ESP su Compute Engine, completa i seguenti passaggi:

  1. Crea, configura e avvia l'istanza VM.
  2. Installa Docker Enterprise Edition (EE) o Docker Community Edition (CE) sull'istanza VM.
  3. Crea un container Docker per il codice del server di backend.
  4. Esegui il push del container in Artifact Registry} o in un altro registry.

  5. Assicurati di poter:

GKE

Quando crei un cluster nella console Google Cloud, per impostazione predefinita gli ambiti OAuth concessi all'account di servizio del cluster includono gli ambiti richiesti da Endpoints:

  • Service Control: abilitato
  • Gestione servizi: sola lettura

Quando crei un cluster utilizzando il comando gcloud container clusters create o un file di configurazione di terze parti, assicurati di specificare i seguenti ambiti:

  • "https://www.googleapis.com/auth/servicecontrol"
  • "https://www.googleapis.com/auth/service.management.readonly"

Per ulteriori informazioni, consulta Che cosa sono gli ambiti di accesso?.

Prima del deployment:

Con l'aggiunta di una piccola sezione al file manifest di deployment, puoi eseguire l'immagine Docker ESP sui tuoi cluster di container insieme all'applicazione containerizzata. Prima di poter eseguire il deployment dell'API con ESP in GKE, completa i seguenti passaggi:

  1. Esegui il deployment dell'applicazione containerizzata nei cluster di container. I passaggi generali descritti nella documentazione di GKE sono:

    1. Pacchettizza l'applicazione in un'immagine Docker.
    2. Carica l'immagine in un registry.
    3. Crea un cluster di container.
    4. Esegui il deployment dell'applicazione nel cluster.
    5. Esponi la tua applicazione a internet.

  2. Assicurati di poter:

    • Avvia il server dell'API.
    • Invia richieste alla tua API.

Eseguire il deployment dell'API e di ESP

Compute Engine

Per eseguire il deployment dell'API con ESP in Compute Engine con Docker:

  1. Connettiti all'istanza VM. Sostituisci INSTANCE_NAME con il nome dell'istanza VM:

    gcloud compute ssh INSTANCE_NAME

  2. Crea la tua rete di contenitori denominata esp_net:

    sudo docker network create --driver bridge esp_net

  3. Esegui un'istanza dell'immagine del codice del server di backend e connettila alla rete del container esp_net:

    sudo docker run \
    --detach \
    --name=YOUR_API_CONTAINER_NAME \
    --net=esp_net \
    gcr.io/YOUR_PROJECT_ID/YOUR_IMAGE:1
    • Sostituisci YOUR_API_CONTAINER_NAME con il nome del contenitore.
    • Sostituisci YOUR_PROJECT_ID con l'ID del progetto Google Cloud che hai utilizzato per eseguire il push dell'immagine.
    • Sostituisci YOUR_IMAGE con il nome dell'immagine.

  4. Recupera il nome del servizio della tua API. Si tratta del nome specificato nel campo name del file YAML di configurazione del servizio.

  5. Esegui un'istanza dell'immagine Docker ESP:

    sudo docker run \
    --detach \
    --name=esp \
    --publish=80:9000 \
    --net=esp_net \
    gcr.io/endpoints-release/endpoints-runtime:1 \
    --service=SERVICE_NAME \
    --rollout_strategy=managed \
    --http2_port=9000 \
    --backend=grpc://YOUR_API_CONTAINER_NAME:8000
    • Sostituisci SERVICE_NAME con il nome del servizio.
    • Sostituisci YOUR_API_CONTAINER_NAME con il nome del contenitore dell'API.

    L'opzione --rollout_strategy=managed configura ESP in modo che utilizzi la configurazione del servizio di cui è stato eseguito il deployment più recente. Quando specifichi questa opzione, fino a 5 minuti dopo aver eseguito il deployment di una nuova configurazione del servizio, ESP rileva la modifica e inizia a utilizzarla automaticamente. Ti consigliamo di specificare questa opzione anziché un ID configurazione specifico da utilizzare per ESP.

Se devi configurare ESP per utilizzare un ID configurazione specifico:

  1. Includi l'opzione --version e impostala su un ID configurazione specifico.

  2. Rimuovi l'opzione --rollout_strategy=managed o imposta --rollout_strategy su fixed. L'opzione fixed configura ESP in modo da utilizzare la configurazione del servizio specificata in --version.

  3. Esegui di nuovo il comando docker run.

Se specifichi sia --rollout_strategy=managed sia l'opzione --version, l'ESP si avvia con la configurazione specificata in --version, ma poi viene eseguito in modalità gestita e ottiene la configurazione più recente.

Ti consigliamo di non mantenere l'ESP configurato per l'utilizzo di un ID configurazione specifico per troppo tempo, perché se esegui il deployment di una configurazione del servizio aggiornata, devi riavviare l'ESP per utilizzare la nuova configurazione.

Per rimuovere l'ID configurazione specifico:

  1. Nei flag ESP per docker run, rimuovi l'opzione --version.

  2. Aggiungi l'opzione --rollout_strategy=managed.

  3. Per riavviare l'ESP, esegui il comando docker run.

Consulta Opzioni di avvio di ESP per l'elenco completo delle opzioni che puoi specificare all'avvio di ESP.

GKE

Per eseguire il deployment di ESP in GKE:

  1. Recupera il nome del servizio della tua API.

  2. Apri il file manifest del deployment (chiamato deployment.yaml) e aggiungi quanto segue alla sezione containers:

          containers:
      - name: esp
        image: gcr.io/endpoints-release/endpoints-runtime:1
        args: [
          "--http2_port=9000",
          "--service=SERVICE_NAME",
          "--rollout_strategy=managed",
          "--backend=grpc://127.0.0.1:8000"
        ]
        ports:
          - containerPort: 9000

    Sostituisci SERVICE_NAME con il nome del servizio dell'API.

  3. Avvia il servizio Kubernetes utilizzando il comando kubectl create:

        kubectl create -f deployment.yaml

Se devi configurare ESP per utilizzare un ID configurazione specifico:

  1. Nel file manifest di Deployment, aggiungi l'opzione --version e impostala su un ID configurazione specifico.

  2. Rimuovi --rollout_strategy=managed o imposta --rollout_strategy su fixed. L'opzione fixed configura l'ESP in modo da utilizzare la configurazione del servizio specificata in --version.

  3. Avvia il servizio Kubernetes: kubectl create -f deployment.yaml

Se specifichi sia --rollout_strategy=managed sia l'opzione --version, ESP si avvia con la configurazione specificata in --version, ma poi viene eseguito in modalità gestita e ottiene la configurazione più recente.

Ti consigliamo di non mantenere l'ESP configurato per l'utilizzo di un ID configurazione specifico per troppo tempo, perché se esegui il deployment di una configurazione del servizio aggiornata, devi riavviare l'ESP per utilizzare la nuova configurazione.

Per rimuovere l'ID configurazione specifico:

  1. Nel file manifest di Deployment, rimuovi l'opzione --version.

  2. Aggiungi --rollout_strategy=managed.

  3. Avvia il servizio Kubernetes: kubectl create -f deployment.yaml

Consulta Opzioni di avvio di ESP per l'elenco completo delle opzioni che puoi specificare all'avvio di ESP.

monitora l'attività dell'API

Dopo aver eseguito il deployment dell'ESP e del backend dell'API, puoi utilizzare strumenti come curl o Postman per inviare richieste all'API. Se non ricevi una risposta positiva, consulta la sezione Risolvere i problemi relativi alle risposte.

Dopo aver inviato alcune richieste, puoi:

  • Per visualizzare i grafici delle attività della tua API, vai ad Endpoints > Servizi. La visualizzazione dei dati relativi alle richieste nei grafici può richiedere alcuni minuti.

    Vai alla pagina Servizi endpoint

  • Esamina i log delle richieste per la tua API nella pagina Cloud Logging.

    Vai alla pagina Esplora log

Passaggi successivi