Deployment di un proxy API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Nota:per eseguire il deployment dei proxy API in ambienti abilitati per i deployment di archivi, consulta Deployment e gestione degli archivi in un ambiente Apigee.

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 eseguirne il deployment nel tuo cluster.

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

Nota:non puoi apportare modifiche incrementali a una revisione del proxy API e ridistribuire la stessa revisione ad Apigee. Per eseguire il deployment delle modifiche a un proxy API, devi salvarlo come nuova revisione ed eseguirne il deployment.

Esegui il deployment di un proxy API

Esegui il deployment di una revisione del proxy API come descritto per uno dei seguenti metodi.

Nota:Apigee sta introducendo una nuova versione dell'editor proxy, che semplificherà la gestione dei proxy.

Le istruzioni nelle prime due schede riportate di seguito spiegano come utilizzare il nuovo editor proxy o l'editor proxy classico.

UI Apigee nella console Cloud

Per eseguire il deployment di un proxy API:

1. Apri la UI di Apigee nella console Cloud
2. Seleziona Sviluppo di proxy > Proxy API.

3. Fai clic sul proxy API di cui vuoi eseguire il deployment. La UI mostra la pagina Panoramica:

   

4. Per eseguire il deployment delle modifiche, fai prima clic su Esegui il deployment per visualizzare la finestra di dialogo Esegui il deployment:

   

5. Inserisci i seguenti dati:
   • Revisione: il numero di revisione del proxy che vuoi implementare.
   • Ambiente: l'ambiente in cui vuoi eseguire il deployment del proxy.
   • (Facoltativo) Service account: un service account per il proxy.
6. Fai clic su Esegui il deployment.

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

Nota: potrebbero essere necessari alcuni minuti prima che Apigee esegua il deployment del nuovo proxy.

Quando il proxy viene sottoposto a deployment, la colonna Stato nella sezione Deployment mostra un'icona verde per indicare che è stato eseguito il deployment della revisione 1 del proxy.

Editor proxy classico

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

1. Accedi alla UI Apigee.
2. Seleziona Sviluppa > Proxy API.

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

   

3. Dall'elenco a discesa Environment (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.

   L'UI mostra la scheda Panoramica dei proxy API. Questa visualizzazione include le sezioni Deployment, Endpoint proxy e Endpoint di destinazione:

   

   Se si tratta di un nuovo proxy API che non hai mai eseguito il deployment (o di un proxy API di cui hai annullato il deployment), la colonna Revisione mostra Non eseguito il deployment.

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

   Se si tratta di un nuovo proxy API che non è mai stato eseguito il deployment prima, l'elenco a discesa mostra solo 1 e Annulla deployment:

   

   Per i proxy API con più revisioni, l'elenco a discesa mostra tutte le revisioni che puoi scegliere, nonché Annulla deployment.

   

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

   L'interfaccia utente ti chiede di confermare il deployment:

   

7. Fai clic su Esegui il deployment.

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

   Nota: potrebbero essere necessari alcuni minuti prima che Apigee esegua il deployment del nuovo proxy.

   Posiziona il cursore sopra il link Dettagli nella colonna Stato per visualizzare lo stato del deployment. Se sono già state implementate una o più revisioni, puoi monitorare lo stato del loro annullamento dell'implementazione, come mostrato nella figura seguente. Per ulteriori informazioni, consulta Deployment senza tempi di inattività.

   

   Al termine del deployment, i dettagli dello Stato indicano che la revisione è completamente implementata:

   

   Tieni presente che l'implementazione non è un processo istantaneo. Il modello di deployment eventualmente coerente di Apigee indica che un nuovo deployment verrà implementato nel cluster in un breve periodo di tempo e non immediatamente. Per ulteriori informazioni, consulta Informazioni sul deployment.

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

   

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

1. Fai clic sul menu a discesa Deployment su: env_name.

   

   La UI mostra un elenco di ambienti. Nella colonna Revisione, l'interfaccia utente elenca la revisione attualmente implementata (o "‑‑" se non presente).

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

   L'interfaccia utente ti chiede di confermare il deployment.

3. Fai clic su Esegui il deployment.

   L'interfaccia utente avvia il processo di deployment 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.

• Creare un report sulle modifiche al deployment prima del deployment
• Deployment di una revisione del proxy API utilizzando l'API
• Elenco dei deployment di un proxy API utilizzando l'API

Vedi anche Visualizzare lo stato del deployment.

Nota: Apigee limita il numero di richieste di deployment elaborate al secondo. Se tenti di inviare un numero elevato di richieste di deployment contemporaneamente, potresti visualizzare errori di deployment dovuti a errori di timeout.

Creare un report sulle modifiche al deployment prima del deployment

Il deployment di un proxy in più di un ambiente nello stesso gruppo di ambienti potrebbe causare un comportamento indefinito. Per determinare se ciò si verificherà, puoi generare un report utilizzando il metodo generateDeployChangeReport nel seguente modo:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/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 che 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 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 la sezione Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Punto chiave:se viene eseguito il deployment di una revisione del proxy API esistente, imposta il parametro di query override su true. In questo caso, Apigee esegue il deployment della nuova revisione completamente prima di annullare il deployment della revisione esistente, come descritto in Deployment senza tempi di inattività.

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

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

Per maggiori informazioni, consulta Deploy proxy API revision 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 la sezione Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Punto chiave: quando visualizzi un elenco di implementazioni, lo stato dell'implementazione non viene fornito. Per visualizzare lo stato del deployment per una singola revisione del proxy API, consulta Visualizzazione dello stato del deployment.

Di seguito è riportato un esempio di risposta. In questo esempio, sono stati implementati tre proxy API, incluso helloworld, che è stato implementato 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 CLI gcloud apigee per eseguire il deployment delle revisioni del proxy API ed elencare i deployment per la tua organizzazione.

• Deployment di una revisione del proxy API utilizzando gcloud CLI
• Elenco dei deployment di un proxy API utilizzando gcloud CLI

Vedi anche Visualizzare lo stato del deployment.

Per ulteriori informazioni e una descrizione delle variabili di ambiente utilizzate negli esempi, consulta Guida introduttiva all'utilizzo di 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

Punto chiave: se viene eseguito il deployment di una revisione del proxy API esistente, imposta il flag override su true. In questo caso, Apigee esegue il deployment della nuova revisione completamente prima di annullare il deployment della revisione esistente, come descritto in Deployment senza tempi di inattività.

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

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

Per saperne di più, vedi Eseguire il deployment della revisione del proxy API CLI.

Elenco dei deployment utilizzando 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

Punto chiave: quando visualizzi un elenco di implementazioni, non viene fornito lo stato dell'implementazione. Per visualizzare lo stato del deployment per un singolo proxy API, consulta Visualizzazione dello stato del deployment.

Di seguito è riportato un esempio di risposta. In questo esempio, sono stati implementati tre proxy API, incluso helloworld, che è stato implementato 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 ulteriori informazioni, consulta List deployments CLI.

Risoluzione dei problemi

Se non riesci a eseguire il deployment del proxy API, verifica se si applica uno dei seguenti scenari comuni.

Limitazioni di denominazione per i gruppi di ambienti

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

Consulta Creazione di gruppi di ambienti per una descrizione delle linee guida e delle limitazioni relative alla denominazione.

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à implementato. 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, segui questi passaggi:

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.

Nota:per risolvere i problemi di deployment, consulta la sezione Errori di deployment. Per problemi relativi alle norme, consulta la sezione Errori relativi alle norme.