Pubblicazione di un'API dal nome di dominio

OpenAPI   |  gRPC

Questa pagina mostra come pubblicare un'API da un dominio personalizzato di tua proprietà, ad esempio example.com.

In alternativa all'utilizzo del tuo nome di dominio, puoi utilizzare un nome di dominio gestito da Google. Per ulteriori informazioni, consulta Utilizzare un dominio gestito da Google.

Prima di iniziare

• Se non hai ancora un nome di dominio da utilizzare per la tua API, ottienilo da un registrar di nomi di dominio.
• Verifica la proprietà del dominio.
• Assegna un nome al nome host dell'API con il nome del tuo dominio.
• Se utilizzi SSL con il tuo dominio, ottieni e carica il certificato SSL.
• Esegui il deployment dell'API e Extensible Service Proxy (ESP).

Configura il progetto API in modo che utilizzi il tuo nome di dominio

Segui le istruzioni riportate nella scheda appropriata.

Compute Engine

Il modo consigliato per pubblicare un'API dalle istanze Compute Engine è utilizzare un bilanciatore del carico in un gruppo di istanze. Devi prenotare un indirizzo IP esterno per il nome di dominio e utilizzarlo per il bilanciatore del carico.

Per pubblicare l'API da un nome di dominio:

1. Prenota almeno un indirizzo IP esterno statico nel tuo progetto:
   

   Vai alla pagina Indirizzi IP esterni

1. Assegna un nome qualsiasi all'indirizzo IP riservato
2. In Tipo, fai clic su Globale.
3. In Allegato a, fai clic su Nessuna. L'indirizzo IP verrà collegato a un bilanciatore del carico in un secondo momento.
2. Visita l'account del tuo provider di dominio e modifica le impostazioni del dominio. Devi creare un record A che contenga il nome dell'API, ad esempio myapi.example.com con l'indirizzo IP esterno nel relativo campo dati
3. Crea un gruppo di istanze che includa le istanze che eseguono l'API e Extensible Service Proxy (ESP):
   

   Vai alla pagina Crea un nuovo gruppo di istanze

1. Assegna un nome qualsiasi al gruppo e aggiungi una descrizione.
2. Nell'elenco Zona, fai clic sulla zona utilizzata dall'istanza API.
3. Nell'elenco Definizione istanza, fai clic su Seleziona istanze esistenti.
4. Nel campo Istanze VM, aggiungi l'istanza VM che esegue l'API.
5. Fai clic su Crea.
4. Crea e configura un bilanciatore del carico HTTP(S):
   

   Vai alla pagina Crea un nuovo bilanciatore del carico HTTP(S)

1. Fai clic su Definisci un servizio di backend > Crea o seleziona un servizio di backend.
   
2. Assegna un nome e una descrizione a questa configurazione del servizio di backend.
3. Nel campo Protocollo, seleziona il protocollo da supportare tramite il bilanciatore del carico, HTTP o HTTPS.
4. Nell'elenco Gruppo di istanze, fai clic sul gruppo di istanze.
5. Nel campo Numeri di porta, inserisci 8080.
6. Fai clic su Controllo di integrità per configurare i controlli di integrità:
• Inserisci un nome per la configurazione del controllo di integrità.
• Assegna la porta 8080.
• Per accettare i valori predefiniti rimanenti, fai clic su Salva.
7. Per il momento, accetta i valori predefiniti per il resto della configurazione. Puoi apportare modifiche in un secondo momento, ad esempio aggiungere porte.
8. Non è necessario impostare nulla nelle Regole host e percorso. Puoi inoltrare tutto all'API di backend utilizzando i filtri predefiniti Qualsiasi senza corrispondenza. Ciò significa che tutto il traffico in entrata nel bilanciatore del carico viene indirizzato all'API sulla porta 8080 (la porta predefinita) come definito nei passaggi precedenti.
9. Fai clic su Configurazione frontend.
   
• Nel campo Protocollo, seleziona il protocollo da supportare tramite il bilanciatore del carico, HTTP o HTTPS.
• Nell'elenco IP, fai clic sull'indirizzo IP esterno che hai creato in precedenza.
• Per il protocollo HTTPS, devi utilizzare SSL. Nell'elenco Certificato, fai clic sul certificato che ti interessa.
• Se vuoi supportare un altro protocollo, fai clic su Aggiungi IP e porta frontend, specifica il protocollo, lo stesso indirizzo IP esterno e una porta diversa.
10. Per creare il bilanciatore del carico completamente configurato, fai clic su Crea. Se il pulsante Crea non è abilitato, controlla i componenti appena configurati: accanto a ciascun componente di configurazione dovrebbe apparire un segno di spunta. Se manca il segno di spunta, significa che non hai completato la configurazione.
11. Dopo la propagazione delle modifiche DNS, le richieste vengono inviate all'API utilizzando il bilanciatore del carico.
Nota: se le richieste non arrivano al backend dell'API, controlla le regole firewall del progetto per assicurarti che le istanze possano accettare il traffico sulla porta ESP predefinita 8080. Per ulteriori informazioni, consulta Firewall.

GKE

Per pubblicare un'API su un dominio per Google Kubernetes Engine (GKE), devi esporre ESP come servizio utilizzando l'indirizzo IP esterno visualizzato per le impostazioni DNS del tuo dominio. Tieni presente che GKE esegue automaticamente il bilanciamento del carico per te.

Per esporre l'API come servizio:

1. Se non ne hai già uno, configura un servizio Kubernetes per i backend dell'API. Crea un file di configurazione del servizio, service.yaml, con contenuti simili ai seguenti:

               apiVersion: v1
               kind: Service
               metadata:
                 name: echo
               spec:
                 ports:
                 - port: 80
                   targetPort: 8081
                   protocol: TCP
                 selector:
                   app: echo-app
                 type: LoadBalancer
                 

• Modifica l'etichetta selector in modo che corrisponda alle etichette di backend (app: echo-app in questo esempio)
• Assicurati che targetPort corrisponda alla porta utilizzata da ESP configurata nei backend dell'API. L'ESP utilizza la porta 8081 per impostazione predefinita.
2. Esegui il deployment del servizio Kubernetes:
   

               kubectl apply -f service.yaml
               

3. Visualizza l'indirizzo IP esterno assegnato al servizio esposto:
   

               kubectl get services
               

   L'output mostra un indirizzo EXTERNAL-IP simile al seguente:
   

               NAME         CLUSTER-IP     EXTERNAL-IP      PORT(S)    AGE
               hello-node   10.X.XXX.202   10X.XXX.XX.123   8080/TCP   1m
         

   Nota: l'API impiega un po' di tempo per essere esposta come servizio e l'IP esterno non è visibile finché questa procedura non è completata. Pertanto, potresti dover eseguire kubectl get services più volte prima di visualizzare l'indirizzo IP.
4. Modifica l'indirizzo IP esterno generato da temporaneo a statico.
   

   Vai alla pagina Indirizzi IP esterni

1. Seleziona il tuo indirizzo IP esterno dall'elenco.
2. Nell'elenco Tipo, fai clic su Statico.
5. Visita l'account del tuo provider di dominio e modifica le impostazioni del dominio. Devi creare un record A che contenga il nome dell'API, ad esempio myapi.example.com, con l'indirizzo IP esterno nel relativo campo dati.

Passaggi successivi

• Pubblicazione di più API da un dominio