Questo tutorial mostra come creare un servizio Knative serving personalizzato in grado di trasformare un parametro di input per la descrizione del grafico in un diagramma nel formato immagine PNG
. Utilizza Graphviz installato come pacchetto di sistema nell'ambiente container del servizio.
Graphviz viene utilizzato tramite le utilità a riga di comando per gestire le richieste.
Obiettivi
- Scrivi e crea un container personalizzato con un Dockerfile
- Scrivi, crea ed esegui il deployment di un servizio Knative serving
- Usa l'utilità Graphviz. per generare diagrammi
- Testa il servizio pubblicando un diagramma della sintassi DOT dalla raccolta o da una tua creazione
Costi
In questo documento, utilizzi i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi.
Prima di iniziare
- Questo tutorial presuppone che Knative serving sia installato e configurato sul tuo cluster.
- Assicurati che il tuo ambiente a riga di comando sia configurato e che gli strumenti siano aggiornati:
Recupero dell'esempio di codice in corso
Per recuperare l'esempio di codice da utilizzare:
Clona il repository dell'app di esempio nella tua macchina locale:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Go
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Passa alla directory che contiene il codice di esempio Knative serving:
Node.js
cd nodejs-docs-samples/run/system-package/
Python
cd python-docs-samples/run/system-package/
Go
cd golang-samples/run/system_package/
Java
cd java-docs-samples/run/system-package/
Visualizzazione dell'architettura
L'architettura di base è simile alla seguente:
L'utente invia una richiesta HTTP al servizio Knative serving che esegue un'utilità Graphviz per trasformare la richiesta in un'immagine. L'immagine viene consegnata all'utente come risposta HTTP.
Nozioni di base sul codice
Definisci la configurazione del tuo ambiente con l'Dockerfile
Dockerfile
è specifico per la lingua e l'ambiente operativo di base, ad esempio Ubuntu, che verrà utilizzato dal servizio.
Questo servizio richiede uno o più pacchetti di sistema aggiuntivi non disponibili per impostazione predefinita.
Apri
Dockerfile
in un editor.Cerca un estratto conto
Dockerfile
RUN
. Questa istruzione consente di eseguire comandi shell arbitrari per modificare l'ambiente. SeDockerfile
ha più fasi, identificate trovando più istruzioniFROM
, si troverà nell'ultima fase.I pacchetti specifici richiesti e il meccanismo per installarli variano in base al sistema operativo dichiarato all'interno del container.
Per ricevere istruzioni per il tuo sistema operativo o l'immagine di base, fai clic sulla scheda appropriata.
Debian/Ubuntu Alpine Alpine richiede un secondo pacchetto per il supporto dei caratteri.Per determinare il sistema operativo dell'immagine container, controlla il nome nell'istruzione
FROM
o in un file README associato all'immagine di base. Ad esempio, se estendinode
, puoi trovare la documentazione e l'elemento padreDockerfile
in Docker Hub.Testa la personalizzazione creando l'immagine utilizzando
docker build
in locale o Cloud Build.
Gestione delle richieste in entrata
Il servizio di esempio utilizza i parametri della richiesta HTTP in entrata per richiamare una chiamata di sistema che esegue il comando appropriato dell'utilità dot
.
Nel gestore HTTP in basso, un parametro di input per la descrizione del grafico viene estratto dalla variabile stringa di query dot
.
Le descrizioni dei grafici possono includere caratteri che devono essere codificati nell'URL per essere utilizzati in una stringa di query.
Node.js
Python
Go
Java
Dovrai distinguere tra errori interni del server e input dell'utente non validi. Questo servizio di esempio restituisce un errore interno del server per tutti gli errori della riga di comando dot, a meno che il messaggio di errore non contenga la stringa syntax
, che indica un problema relativo input utente dell'utente.
Generare un diagramma
La logica di base per la generazione dei diagrammi utilizza lo strumento a riga di comando dot per elaborare il parametro di input della descrizione del grafico in un diagramma nel formato dell'immagine PNG.
Node.js
Python
Go
Java
Progettazione di un servizio sicuro
Eventuali vulnerabilità nello strumento dot
sono potenziali vulnerabilità del
servizio web. Puoi mitigare questo problema utilizzando versioni aggiornate del pacchetto graphviz
mediante la creazione regolare dell'immagine container.
Se estendi l'esempio corrente in modo da accettare l'input utente come parametri della riga di comando, dovresti proteggerti dagli attacchi di comando iniezione. Ecco alcuni modi per prevenire gli attacchi di injection:
- Mappatura degli input a un dizionario di parametri supportati
- La convalida degli input corrisponde a un intervallo di valori di sicurezza nota, magari usando espressioni regolari
- Sequenza di escape degli input per garantire che la sintassi della shell non venga valutata
Spedizione del codice
Per distribuire il codice, crea con Cloud Build, caricalo su Container Registry ed esegui il deployment su Knative serving:
Esegui questo comando per creare il container e pubblicarlo su Container Registry.
Node.js
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
dove PROJECT_ID è l'ID progetto Google Cloud e
graphviz
è il nome che vuoi assegnare al servizio.Se l'operazione riesce, vedrai un messaggio SUCCESS contenente l'ID, l'ora di creazione e il nome dell'immagine. L'immagine è archiviata in Container Registry e può essere riutilizzata, se necessario.
Python
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
dove PROJECT_ID è l'ID progetto Google Cloud e
graphviz
è il nome che vuoi assegnare al servizio.Se l'operazione riesce, vedrai un messaggio SUCCESS contenente l'ID, l'ora di creazione e il nome dell'immagine. L'immagine è archiviata in Container Registry e può essere riutilizzata, se necessario.
Go
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
dove PROJECT_ID è l'ID progetto Google Cloud e
graphviz
è il nome che vuoi assegnare al servizio.Se l'operazione riesce, vedrai un messaggio SUCCESS contenente l'ID, l'ora di creazione e il nome dell'immagine. L'immagine è archiviata in Container Registry e può essere riutilizzata, se necessario.
Java
Questo esempio utilizza Jib per creare immagini Docker utilizzando strumenti Java comuni. Jib ottimizza le build di container senza bisogno di un Dockerfile o senza dover installare Docker. Scopri di più sulla creazione di container Java con Jib.Utilizzando il Dockerfile, configura e crea un'immagine di base con i pacchetti di sistema installati per eseguire l'override dell'immagine di base predefinita di Jib:
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz-base
Dove PROJECT_ID è l'ID progetto Google Cloud.
Crea il tuo container finale con Jib e pubblicalo su Container Registry:
mvn compile jib:build \ -Dimage=gcr.io/PROJECT_ID/graphviz \ -Djib.from.image=gcr.io/PROJECT_ID/graphviz-base
Dove PROJECT_ID è l'ID progetto Google Cloud.
Esegui il deployment utilizzando il comando seguente:
gcloud run deploy graphviz-web --create-if-missing --image gcr.io/PROJECT_ID/graphviz
Dove PROJECT_ID è il tuo ID progetto Google Cloud, mentre
graphviz
è il nome del container indicato sopra egraphviz-web
è il nome del servizio.Attendi il completamento del deployment: l'operazione può richiedere circa mezzo minuto.
Se vuoi eseguire il deployment di un aggiornamento del codice nel servizio, ripeti i passaggi precedenti. Ogni deployment in un servizio crea una nuova revisione e inizia automaticamente a gestire il traffico quando è pronto.
Fai una prova
Prova il tuo servizio inviando richieste POST
HTTP con descrizioni della sintassi DOT nel payload delle richieste.
Invia una richiesta HTTP al tuo servizio.
Puoi incorporare il diagramma in una pagina web:
-
Per ottenere l'IP esterno per il bilanciatore del carico, esegui questo comando:
kubectl get svc istio-ingressgateway -n ASM-INGRESS-NAMESPACE
Sostituisci ASM-INGRESS-NAMESPACE con lo spazio dei nomi in cui si trova il traffico in entrata di Cloud Service Mesh. Specifica
istio-system
se hai installato Cloud Service Mesh utilizzando la configurazione predefinita.L'output risultante è simile al seguente:
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) istio-ingressgateway LoadBalancer XX.XX.XXX.XX pending 80:32380/TCP,443:32390/TCP,32400:32400/TCP
dove il valore EXTERNAL-IP è il tuo indirizzo IP esterno del Load Balancer.
Esegui un comando curl utilizzando questo indirizzo
EXTERNAL-IP
nell'URL. Non includere il protocollo (ad es.http://
) aSERVICE_DOMAIN
.curl -G -H "Host: SERVICE_DOMAIN" http://EXTERNAL-IP/diagram.png \ --data-urlencode "dot=digraph Run { rankdir=LR Code -> Build -> Deploy -> Run }" \ > diagram.png
-
Apri il file
diagram.png
risultante in qualsiasi applicazione che supporti i filePNG
, ad esempio Chrome.Dovrebbe avere il seguente aspetto:
Puoi esplorare una piccola raccolta di descrizioni dei diagrammi già pronte.
- Copia i contenuti del file
.dot
selezionato Incollalo in un comando
curl
:curl -G -H "Host: SERVICE_DOMAIN" http://EXTERNAL-IP/diagram.png \ --data-urlencode "dot=digraph Run { rankdir=LR Code -> Build -> Deploy -> Run }" \ > diagram.png
Esegui la pulizia
Puoi eliminare le risorse create per questo tutorial per evitare costi.
Eliminazione delle risorse del tutorial in corso...
Elimina il servizio Knative serving di cui hai eseguito il deployment in questo tutorial:
gcloud run services delete SERVICE-NAME
Dove SERVICE-NAME è il nome del servizio che hai scelto.
Puoi anche eliminare i servizi Knative serving dalla console Google Cloud:
Rimuovi le configurazioni predefinite di gcloud che hai aggiunto durante la configurazione del tutorial:
gcloud config unset run/platform gcloud config unset run/cluster gcloud config unset run/cluster_location
Rimuovi la configurazione del progetto:
gcloud config unset project
Elimina altre risorse Google Cloud create in questo tutorial:
- Elimina l'immagine container denominata
gcr.io/<var>PROJECT_ID</var>/graphviz
da Container Registry. - Se hai creato un cluster per questo tutorial, elimina il cluster.
- Elimina l'immagine container denominata
Passaggi successivi
- Sperimenta con l'app Graphviz:
- È stato aggiunto il supporto per altre utilità di Graphviz che applicano algoritmi diversi alla generazione dei diagrammi.
- Salva i diagrammi in Cloud Storage. Vuoi salvare l'immagine o la sintassi DOT?
- Implementa la protezione dall'abuso dei contenuti con l'API Cloud Natural Language.
- Esplora le architetture di riferimento, i diagrammi e le best practice su Google Cloud. Visita il nostro Cloud Architecture Center.