Deployment di un proxy API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Non puoi richiamare un proxy API finché non è stato eseguito il deployment. Dopo aver creato un nuovo proxy API o aver modificato uno esistente, puoi eseguirne il deployment nel cluster.

Quando crei una nuova revisione di un proxy API senza modificarne il percorso di base e poi ne esegui il deployment in un ambiente in cui ne è già stato eseguito il deployment, viene annullato il deployment della revisione precedente e al suo posto viene eseguito il deployment della 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 nell'interfaccia utente di Apigee:

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

    Se utilizzi l'interfaccia utente di Apigee classica: seleziona Sviluppo > Proxy API e, nel riquadro proxy, seleziona l'ambiente per il proxy.

  2. Fai clic sul proxy API di cui vuoi eseguire il deployment. L'interfaccia utente visualizza la pagina Panoramica:

    Dettagli del proxy API, tra cui lo stato del deployment 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 Explorer proxy.

  4. Inserisci i seguenti valori:
    • Revisione: il numero di revisione del proxy di cui vuoi eseguire il deployment.
    • Ambiente: l'ambiente in cui vuoi eseguire il deployment del proxy.
    • Account di servizio (facoltativo): un account di servizio per il proxy.
  5. Fai clic su Esegui il deployment.

La UI avvia il processo di deployment della revisione selezionata.

Una volta eseguito il deployment del proxy, nella colonna Stato nella sezione Deployment viene visualizzata un'icona verde a indicare che è stato eseguito il deployment della revisione 1 del proxy.

Icona di stato del proxy implementato

Editor proxy classico

Per eseguire il deployment di un proxy API nell'interfaccia utente di Apigee:

  1. Accedi all'interfaccia utente di Apigee.
  2. Seleziona Sviluppo > Proxy API.

    La UI mostra un elenco di proxy API e il relativo stato di deployment:

    Viene visualizzato un elenco di proxy API che include nome, stato, traffico di 24 ore, autore e data/ora dell'ultima modifica.

  3. Nell'elenco a discesa Ambiente, seleziona l'ambiente in cui vuoi 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 proxy API. Questa visualizzazione include le sezioni Deployment, Endpoint del proxy ed Endpoint di destinazione:

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

    Se si tratta di un nuovo proxy API di cui non hai mai eseguito il deployment (o di un proxy API di cui hai annullato il deployment), nella colonna Revisione vedrai Deployment non eseguito.

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

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

    Esegui il deployment della prima revisione del proxy.

    Per i proxy API con più revisioni, l'elenco a discesa mostra tutte le revisioni tra cui puoi scegliere, nonché 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.

    La UI richiede 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.

    La UI avvia il processo di deployment della revisione selezionata.

    Posiziona il cursore sul link Dettagli nella colonna 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 Implementazione senza tempi di inattività.

    esegui il deployment di my-new-proxy per testare la conferma dell'ambiente

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

    Stato di distribuzione che mostra il deployment della revisione 18 il 75% e la revisione 17 del 25%

    Tieni presente che il deployment non è un processo istantaneo. Il modello di deployment a coerenza finale di Apigee comporta l'implementazione di un nuovo deployment nel cluster in un breve periodo di tempo, non immediatamente. Per maggiori informazioni, consulta Informazioni sul deployment.

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

    Stato di deployment che mostra il deployment completo della revisione 18

In alternativa, puoi eseguire il deployment della revisione corrente che stai modificando nella scheda Sviluppo. Quando esegui questa operazione, 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 ogni 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 richiede di confermare il deployment.

  3. Fai clic su Esegui il deployment.

    La UI avvia il processo di deployment della revisione selezionata.

API Apigee

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

Vedi anche Visualizzazione dello stato del deployment.

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

Il deployment di un proxy in più ambienti nello stesso gruppo di ambienti può portare a un comportamento indefinito. Per determinare se ciò si verificherà, 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"

Questo restituisce 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 utilizza già 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 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 Impostazione delle variabili di ambiente per le richieste API Apigee.

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

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

Per maggiori informazioni, consulta la pagina relativa al deployment dell'API proxy API di revisione.

Elenco dei deployment mediante 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 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 Impostazione delle variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio della risposta. In questo esempio, è stato eseguito il deployment di tre proxy API, tra cui 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 sull'utilizzo dei comandi dell'interfaccia a riga di comando gcloud apigee per eseguire il deployment delle revisioni dei proxy API ed elencare i deployment per la tua organizzazione.

Vedi anche Visualizzazione dello stato del deployment.

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

Deployment di una revisione del proxy API mediante 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, è stato eseguito il deployment della revisione 1 del proxy API helloworld 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 mediante 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 della risposta. In questo esempio, è stato eseguito il deployment di tre proxy API, tra cui 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 Elenca l'interfaccia a riga di comando dei deployment.

Risoluzione dei problemi

Se non riesci a eseguire il deployment del proxy API, verifica se può verificarsi uno dei seguenti scenari comuni.

Limitazioni di denominazione per i gruppi di ambienti

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

Per una descrizione delle limitazioni e delle linee guida per la denominazione, consulta Creazione di gruppi di ambienti.

Ambiente creato con un nome di ambiente utilizzato in precedenza

Se crei un ambiente con lo stesso nome di un ambiente eliminato in precedenza, il deployment del proxy non verrà eseguito. Ad esempio, se hai creato un ambiente denominato prod-1 dopo aver precedentemente 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 tuo gruppo di ambienti utilizzando l' API.
  2. Elimina l'ambiente prod-1 utilizzando l'API.
  3. Creare un nuovo ambiente. Ad esempio, prod-2.
  4. Collega il nuovo ambiente prod-2 al tuo gruppo di ambienti utilizzando l' API.