Deployment di un proxy API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza documentazione di Apigee Edge.

Non puoi richiamare un proxy API finché non è stato eseguito il deployment. Dopo aver creato un nuovo proxy API o apportato una modifica a uno esistente, puoi eseguirlo nel tuo cluster.

Quando crei una nuova revisione di un proxy API senza modificarne il percorso di base, e poi esegui il deployment in un ambiente in cui è già stato eseguito il deployment, la revisione precedente viene annullata e al suo posto viene eseguita la nuova revisione.

Esegui il deployment di un proxy API

Esegui il deployment di una revisione del proxy API come descritto nelle sezioni seguenti.

Nuovo editor proxy

Per eseguire il deployment di un proxy API nella UI di Apigee:

  1. Se utilizzi l'interfaccia utente di Apigee nella console Cloud: seleziona Sviluppo proxy > Proxy API.

    Se utilizzi la UI di Apigee classica: seleziona Sviluppa > Proxy API e, nel riquadro Proxy, seleziona l'ambiente per il proxy.

  2. Fai clic sul proxy API di cui vuoi eseguire il deployment. Nella UI viene visualizzata la Panoramica. pagina:

    Dettagli del proxy API, tra cui lo stato di implementazione per ambiente, i dettagli dell'endpoint proxy e i dettagli dell'endpoint di destinazione.

  3. Per eseguire il deployment delle modifiche, Fai clic su Esegui il deployment per visualizzare la finestra di dialogo Esegui il deployment:

    Endpoint di destinazione selezionati in Proxy Explorer.

  4. Inserisci quanto segue:
    • Revisione: il numero di revisione del proxy che vuoi implementare.
    • Ambiente: l'ambiente in cui vuoi eseguire il deployment del proxy.
    • (Facoltativo) Account di servizio: un account di servizio per il proxy.
  5. Fai clic su Esegui il deployment.

La UI avvia il processo di deployment della revisione selezionata.

Quando il proxy viene disegnato, la colonna Stato nella sezione Deployment mostra un'icona verde per indicare che è stata implementata la revisione 1 del proxy.

Icona dello stato del proxy implementato

Editor proxy classico

Per eseguire il deployment di un proxy API nella UI di Apigee:

  1. Accedi all'UI di Apigee.
  2. Seleziona Sviluppa > Proxy API.

    L'interfaccia utente mostra un elenco di proxy API e il relativo stato di deployment:

    Viene visualizzato un elenco di proxy API che include il nome, lo stato, il traffico nelle ultime 24 ore, l'autore e l'ora dell'ultima modifica.

  3. Dall'elenco a discesa Ambiente, seleziona l'ambiente in cui vuoi per eseguire il deployment del proxy API.

  4. Fai clic sul proxy API di cui vuoi eseguire il deployment.

    Nell'interfaccia utente viene visualizzata la scheda Panoramica dei proxy API. Questa vista include Deployment, Endpoint del proxy e Destinazione Sezioni Endpoint:

    dettagli del proxy API, tra cui lo stato del deployment per ambiente, i dettagli dell'endpoint proxy e quelli di destinazione.

    Se si tratta di un nuovo proxy API che non hai mai disegnato (o di un proxy API che hai disdisegnato), la colonna Revisione mostra Non disegnato.

  5. Nella colonna Revisione, espandi il selettore del menu a discesa.

    Se si tratta di un nuovo proxy API che non è mai stato di cui non è mai stato eseguito il deployment, nell'elenco a discesa vengono visualizzati solo 1 e Esegui il rollback:

    Esegui il deployment della prima revisione del proxy.

    Per i proxy API con più revisioni, l'elenco a discesa mostra tutte le revisioni e Annulla deployment.

    Sezione Deployment dei dettagli del proxy API con il menu a discesa selezionato per l'ambiente di test.

  6. Seleziona dall'elenco a discesa la revisione di cui vuoi eseguire il deployment.

    L'interfaccia utente ti chiede di confermare il deployment:

    Sezione Deployment dei dettagli del proxy API con la revisione 3 selezionata per l'ambiente di produzione.

  7. Fai clic su Esegui il deployment.

    L'interfaccia utente avvia il processo di implementazione della revisione selezionata.

    Posiziona il cursore sul link Dettagli nella Stato per visualizzare lo stato del deployment. Se è già stato eseguito il deployment di una o più revisioni, puoi monitorare lo stato dell'annullamento del deployment, come mostrato nella figura seguente. Per ulteriori informazioni, consulta la sezione Deployment senza tempi di riposo.

    Conferma del deployment di my-new-proxy nell'ambiente di test

    Al termine del deployment, i dettagli dello Stato indicano che il deployment della revisione è stato completato:

    Stato del deployment che mostra la revisione 18 implementata al 75% e la revisione 17 al 25%

    Tieni presente che il deployment non è un processo istantaneo. Il modello di deployment coerente in un secondo momento di Apigee prevede che un nuovo deployment venga implementato nel cluster in un breve periodo di tempo e non immediatamente. Per ulteriori informazioni, vedi Informazioni sul deployment.

    Per informazioni sul significato degli indicatori di stato e su come controllarli, vedi consulta la sezione Visualizzare lo stato del deployment.

    Stato di deployment che mostra l'implementazione completa della revisione 18

In alternativa, puoi eseguire il deployment della revisione corrente che stai modificando nella scheda Sviluppa. In questo modo, Apigee crea una nuova revisione per te.

  1. Fai clic sull'elenco a discesa Esegui il deployment in: env_name.

    Menu a discesa Deployment che consente di eseguire il deployment della revisione corrente o annullarne il deployment in ciascun ambiente

    La UI mostra un elenco di ambienti. Nella colonna Revisione, l'interfaccia utente elenca la revisione attualmente di cui è stato eseguito il deployment (o "‐‐" se nessuna).

  2. Fai clic su Esegui il deployment revision per eseguire il deployment della revisione modificata più di recente.

    La UI ti chiede di confermare il deployment.

  3. Fai clic su Esegui il deployment.

    L'interfaccia utente avvia il processo di implementazione della revisione selezionata.

API Apigee

Le sezioni seguenti forniscono esempi di utilizzo dell'API Apigee per eseguire il deployment delle revisioni del proxy API ed elencare i deployment per la tua organizzazione.

Vedi anche Visualizzare lo stato del deployment.

Crea un report sulle modifiche del deployment prima di eseguire il deployment

Deployment di un proxy in più ambienti nello stesso gruppo di ambiente possono portare a un comportamento indefinito. Per determinare se questo accade, puoi generare un report utilizzando il metodo generateDeployChangeReport come segue:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/deployments:generateDeployChangeReport" \
-X POST \
-H "Authorization: Bearer $TOKEN"

Viene restituito un report sulle modifiche al deployment che ti avvisa se un percorso di base nel proxy di cui vuoi eseguire il deployment non riceverà traffico a causa di un deployment esistente che sta già utilizzando quel percorso di base.

Deployment di una revisione del proxy API utilizzando l'API

Per eseguire il deployment di una revisione del proxy API, utilizza la seguente chiamata API:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste all'API Apigee.

Di seguito è riportato un esempio dell'output della risposta. In questo esempio, la revisione 1 del proxy API helloworld è stata eseguita correttamente nell'ambiente test:

{
  "environment": "test",
  "apiProxy": "helloworld",
  "revision": "1",
  "deployStartTime": "1559149080457"
}

Per saperne di più, consulta Eseguire il deployment dell'API di revisione del proxy API.

Elenco dei deployment utilizzando l'API

Per elencare tutti i deployment di proxy API e flussi condivisi per la tua organizzazione, inserisci la seguente chiamata API:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/deployments" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio di risposta. In questo esempio, sono presenti tre proxy API di cui è stato eseguito il deployment di helloworld, di cui è stato eseguito il deployment nella sezione precedente.

{
  "deployments": [
    {
      "environment": "test",
      "apiProxy": "helloworld",
      "revision": "1",
      "deployStartTime": "1559149080457"
    },
    {
      "environment": "test",
      "apiProxy": "weather",
      "revision": "1",
      "deployStartTime": "1558620435217"
    },
    {
      "environment": "test",
      "apiProxy": "testproxy",
      "revision": "2",
      "deployStartTime": "1558635113086"
    }
  ]
}

gcloud

Le sezioni seguenti forniscono esempi di utilizzo dei comandi dell'interfaccia a riga di comando gcloud apigee per eseguire il deployment delle revisioni del proxy API ed elencare i deployment per l'organizzazione.

Consulta anche Visualizzare lo stato del deployment.

Per ulteriori informazioni e per una descrizione delle variabili di ambiente utilizzate negli esempi, consulta Introduzione a gcloud con Apigee.

Deployment di una revisione del proxy API utilizzando gcloud CLI

Per eseguire il deployment di una revisione del proxy API, utilizza il seguente comando gcloud: 

gcloud apigee apis deploy $REV --api=$API --environment=$ENV

Di seguito è riportato un esempio dell'output di risposta. In questo esempio, la revisione 1 del proxy API helloworld il deployment è stato eseguito correttamente nell'ambiente test:

Using Apigee organization 'my-org'
apiProxy: helloworld
deployStartTime: '1598032332802'
environment: test
revision: '1'

Per maggiori informazioni, consulta Eseguire il deployment dell'interfaccia a riga di comando della revisione del proxy API.

Elenco dei deployment con gcloud CLI

Per elencare tutti i deployment di proxy API e flussi condivisi per la tua organizzazione, utilizza il seguente comando gcloud: 

gcloud apigee deployments list

Di seguito è riportato un esempio di risposta. In questo esempio, sono presenti tre proxy API di cui è stato eseguito il deployment di helloworld, di cui è stato eseguito il deployment nella sezione precedente.

Using Apigee organization `my-org`
 - apiProxy: helloworld
   deployStartTime: 1598032332802
   environment: test
   revision: 1
 - apiProxy: weather
   deployStartTime: 1558620435217
   environment: test
   revision: 1
 - apiProxy: testproxy
   deployStartTime: 1558635113086
   environment: test
   revision: 2

Per maggiori informazioni, consulta Elenco dei deployment dell'interfaccia a riga di comando.

Risoluzione dei problemi

Se non riesci a eseguire il deployment del proxy API, controlla se potrebbe essere applicabile uno dei seguenti scenari comuni.

Restrizioni di denominazione per i gruppi di ambienti

Se il nome del gruppo di ambienti non è conforme alle limitazioni di denominazione, il proxy non verrà disegnato. In alcuni casi, è possibile creare un gruppo di ambienti a cui aggiungere ambienti senza dover rispettare queste restrizioni. Tuttavia, questo impedirà il deployment del proxy.

Per una descrizione delle linee guida e delle limitazioni per i nomi, consulta Creare gruppi di ambienti.

Ambiente creato con un nome ambiente utilizzato in precedenza

Se crei un ambiente con lo stesso nome di un ambiente eliminato in precedenza, il proxy non verrà disegnato. Ad esempio, se hai creato un ambiente denominato prod-1 dopo aver creato ed eliminato un ambiente prod-1, dovrai rimuoverlo. Per risolvere il problema, puoi procedere nel seguente modo:

  1. Scollega l'ambiente prod-1 dal gruppo di ambienti utilizzando l' API.
  2. Elimina l'ambiente prod-1 utilizzando l'API.
  3. Crea un nuovo ambiente. Ad esempio, prod-2.
  4. Collega il nuovo ambiente prod-2 al gruppo di ambienti utilizzando l' API.