En este instructivo, se muestra cómo compilar un servicio personalizado de Knative serving que transforma un parámetro de entrada de descripción de grafo en un diagrama en el formato de imagen PNG
. Usa Graphviz, que se instala como un paquete del sistema en el entorno del contenedor del servicio.
Graphviz se usa a través de utilidades de línea de comandos para entregar solicitudes.
Objetivos
- Escribir y compilar un contenedor personalizado con un Dockerfile
- Escribir, compilar e implementar un servicio de Knative serving
- Usar la utilidad Graphviz dot para generar diagramas
- Probar el servicio mediante la publicación de un diagrama de sintaxis DOT de la colección o de tu propia creación
Costos
En este documento, usarás los siguientes componentes facturables de Google Cloud:
Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios.
Antes de comenzar
- En este instructivo, se supone que tienes Knative serving instalado y configurado en tu clúster.
- Asegúrate de que el entorno de la línea de comandos esté configurado y que las herramientas estén actualizadas:
Recupera la muestra de código
A fin de recuperar la muestra de código para su uso, haz lo siguiente:
Clona el repositorio de la app de muestra en tu máquina local:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Go
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Ve al directorio que contiene el código de muestra de 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/
Visualiza la arquitectura
La arquitectura básica se ve de la siguiente manera:
.El usuario realiza una solicitud HTTP al servicio de Knative serving que ejecuta una utilidad de Graphviz para transformar la solicitud en una imagen. Esa imagen se entrega al usuario como la respuesta HTTP.
Comprende el código
Define la configuración del entorno con el Dockerfile
Tu Dockerfile
es específico al lenguaje y al entorno operativo base, como Ubuntu, que usará el servicio.
Este servicio requiere uno o más paquetes del sistema adicionales que no están disponibles de forma predeterminada.
Abre
Dockerfile
en un editor.Busca una declaración
Dockerfile
RUN
. Esta instrucción permite ejecutar comandos de shell arbitrarios para modificar el entorno. Si elDockerfile
tiene varias etapas, identificadas mediante la búsqueda de varias declaracionesFROM
, se encontrará en la última etapa.Los paquetes específicos necesarios y el mecanismo para instalarlos varían según el sistema operativo que se declare dentro del contenedor.
Para obtener instrucciones sobre el sistema operativo o la imagen base, haz clic en la pestaña correspondiente.
Debian y Ubuntu Alpine Alpine requiere un segundo paquete para la compatibilidad de fuentes.Para determinar el sistema operativo de la imagen de contenedor, verifica el nombre en la declaración
FROM
o en un README asociado con la imagen base. Por ejemplo, si extiendes desdenode
, puedes encontrar documentación y elDockerfile
superior en Docker Hub.Compila la imagen mediante
docker build
de forma local o Cloud Build para probar la personalización.
Administra las solicitudes entrantes
El servicio de muestra usa parámetros de la solicitud HTTP entrante para invocar una llamada del sistema que ejecuta el comando de utilidad dot
apropiado.
En el controlador HTTP que se muestra a continuación, se extrae un parámetro de entrada de descripción de grafo de la variable de la string de consulta dot
.
Las descripciones del grafo pueden incluir caracteres que deben estar codificados como URL para usarlos en una string de consulta.
Node.js
Python
Go
Java
Deberás diferenciar los errores internos del servidor y las entradas de usuario no válidas. En este servicio de ejemplo, se muestra un error interno del servidor para todos los errores de la línea de comandos de dot, a menos que el mensaje de error contenga la string syntax
, que indica un problema de entrada del usuario.
Genera un diagrama
La lógica central de la generación de diagramas usa la herramienta de línea de comandos de dot para procesar el parámetro de entrada de descripción de grafo en un diagrama en el formato de imagen PNG.
Node.js
Python
Go
Java
Diseña un servicio seguro
Las vulnerabilidades de la herramienta de dot
son vulnerabilidades potenciales del servicio web. Puedes mitigar esto mediante el uso de versiones actualizadas del paquete de graphviz
. Para ello, debes compilar la imagen del contenedor con regularidad.
Si extiendes la muestra actual para aceptar las entradas del usuario como parámetros de línea de comandos, debes protegerte contra los ataques de inyección de comandos. Estas son algunas de las formas de evitar los ataques de inyección:
- Asigna entradas a un diccionario de parámetros compatibles.
- Valida entradas coincidentes con un rango de valores seguros conocidos, quizás mediante expresiones regulares.
- Escapa entradas para garantizar que no se evalúe la sintaxis de shell.
Envía el código
Para enviar tu código, compílalo con Cloud Build, súbelo a Container Registry y realiza la implementación en Knative serving:
Ejecuta el siguiente comando para compilar el contenedor y publicar en Container Registry.
Node.js
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
En el que PROJECT_ID es el ID del proyecto de Google Cloud y
graphviz
es el nombre que deseas darle a tu servicio.Si la operación se completa de manera correcta, verás un mensaje de ÉXITO con el ID, la hora de creación y el nombre de la imagen. La imagen se almacena en Container Registry y puede volver a usarse si así se desea.
Python
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
En el que PROJECT_ID es el ID del proyecto de Google Cloud y
graphviz
es el nombre que deseas darle a tu servicio.Si la operación se completa de manera correcta, verás un mensaje de ÉXITO con el ID, la hora de creación y el nombre de la imagen. La imagen se almacena en Container Registry y puede volver a usarse si así se desea.
Go
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
En el que PROJECT_ID es el ID del proyecto de Google Cloud y
graphviz
es el nombre que deseas darle a tu servicio.Si la operación se completa de manera correcta, verás un mensaje de ÉXITO con el ID, la hora de creación y el nombre de la imagen. La imagen se almacena en Container Registry y puede volver a usarse si así se desea.
Java
En esta muestra, se usa Jib para compilar imágenes de Docker mediante herramientas de Java comunes. Jib optimiza las compilaciones de contenedores sin la necesidad de tener un Dockerfile o tener Docker instalado. Obtén más información sobre la compilación de contenedores de Java con Jib.Mediante Dockerfile, configura y compila una imagen base con los paquetes de sistema instalados a fin de anular la imagen base predeterminada de Jib:
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz-base
En el ejemplo anterior, PROJECT_ID es el ID del proyecto de Google Cloud.
Compila el contenedor final con Jib y publica en Container Registry:
mvn compile jib:build \ -Dimage=gcr.io/PROJECT_ID/graphviz \ -Djib.from.image=gcr.io/PROJECT_ID/graphviz-base
En el ejemplo anterior, PROJECT_ID es el ID del proyecto de Google Cloud.
Realiza la implementación con el siguiente comando:
gcloud run deploy graphviz-web --create-if-missing --image gcr.io/PROJECT_ID/graphviz
En el ejemplo anterior, PROJECT_ID es el ID de tu proyecto de Google Cloud,
graphviz
es el nombre del contenedor anterior ygraphviz-web
es el nombre del servicio.Espera hasta que finalice la implementación; esto puede tomar alrededor de medio minuto.
Si deseas implementar una actualización de código en el servicio, repite los pasos anteriores. Cada implementación en un servicio crea una revisión nueva y comienza a entregar tráfico de forma automática cuando está lista.
Realiza una prueba
Para probar el servicio, envía solicitudes HTTP POST
con descripciones de sintaxis DOT en la carga útil de la solicitud.
Envía una solicitud HTTP al servicio.
Puedes incorporar el diagrama en una página web:
-
A fin de obtener la IP externa para el balanceador de cargas, ejecuta el siguiente comando:
kubectl get svc istio-ingressgateway -n ASM-INGRESS-NAMESPACE
Reemplaza ASM-INGRESS-NAMESPACE por el espacio de nombres en el que se encuentra tu entrada de Cloud Service Mesh. Especifica
istio-system
si instalaste Cloud Service Mesh usando su configuración predeterminada.El resultado es similar al siguiente:
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
El valor EXTERNAL-IP es la dirección IP externa del balanceador de cargas.
Ejecuta un comando curl mediante esta dirección
EXTERNAL-IP
en la URL. No incluyas el protocolo (p. ej.:http://
) enSERVICE_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
-
Abre el archivo
diagram.png
resultante en cualquier aplicación que admita archivosPNG
, como Chrome.Se verá de la siguiente manera:
Puedes explorar una pequeña colección de descripciones de diagramas listas para usar.
- Copia el contenido del archivo
.dot
seleccionado. Pégalo en 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
Limpia
Puedes borrar los recursos que creaste para este instructivo a fin de evitar que se generen costos.
Borra los recursos del instructivo
Borra el servicio de Knative serving que implementaste en este instructivo:
gcloud run services delete SERVICE-NAME
En el ejemplo anterior, SERVICE-NAME es el nombre del servicio que elegiste.
También puedes borrar los servicios de Knative serving desde la consola de Google Cloud:
Quita las opciones de configuración predeterminadas de gcloud que agregaste durante la configuración del instructivo.
gcloud config unset run/platform gcloud config unset run/cluster gcloud config unset run/cluster_location
Quita la configuración del proyecto:
gcloud config unset project
Borra otros recursos de Google Cloud que creaste en este instructivo:
- Borra la imagen del contenedor llamada
gcr.io/<var>PROJECT_ID</var>/graphviz
de Container Registry. - Si creaste un clúster para este instructivo, bórralo.
- Borra la imagen del contenedor llamada
¿Qué sigue?
- Experimenta con tu app de graphviz:
- Agrega compatibilidad con otras utilidades de graphviz que aplican diferentes algoritmos a la generación de diagramas.
- Guarda diagramas en Cloud Storage. ¿Deseas guardar la imagen o la sintaxis de DOT?
- Implementa la protección contra el abuso de contenido con la API de Cloud Natural Language.
- Explora arquitecturas de referencia, diagramas y prácticas recomendadas sobre Google Cloud. Consulta nuestro Cloud Architecture Center.