Documentación de la arquitectura del entorno
Como práctica recomendada, cree diagramas de arquitectura para sus apps. Estos diagramas se pueden utilizar como parte del trabajo de diseño inicial, la formación de nuevos miembros del equipo o la formación de miembros del equipo nuevos y existentes. Mantener actualizados diagramas como este ahorra tiempo cuando los problemas necesitan ser investigados rápidamente.
Al documentar la arquitectura de la app, puede asegurarse de que usted y su equipo comprenden de forma completa todos los componentes de la configuración de la arquitectura.
Puede crear un diagrama de arquitectura como parte de la planificación inicial del entorno o después de que el entorno esté activo y en ejecución. Revise los pasos siguientes para documentar el entorno. Los ejemplos proporcionados se basan en aplicaciones del mundo real.
Paso 1: Comprender la app y la arquitectura
La resolución de problemas de apps en clústeres de Red Hat OpenShift on IBM Cloud puede ser complicada, especialmente si el problema implica un flujo de red que abarca distintos clústeres, componentes, pods o servicios. La documentación de la arquitectura de la app puede ayudar a su equipo a comprender a fondo todos los componentes de la configuración.
Para una app con un flujo de red simple, la arquitectura se puede describir en texto. Para escenarios más complicados, un diagrama de arquitectura detallado es útil para que varios equipos implicados en la resolución de problemas puedan comprender el flujo. También es importante asegurarse de que la documentación de la arquitectura permanezca actualizada si la configuración cambia.
La resolución de problemas de apps en clústeres de Red Hat OpenShift on IBM Cloud puede ser difícil, especialmente si se cumplen una o varias de las condiciones siguientes.
- La app no se entiende bien o no tiene un buen registro.
- El problema es intermitente o no ocurre a menudo.
- El problema implica un flujo de red que abarca distintos clústeres, componentes, pods o servicios.
Los siguientes diagramas de arquitectura de ejemplo se toman de escenarios del mundo real. Puede utilizar estos ejemplos como guía al crear sus propios diagramas de arquitectura.
Ejemplo 1: Una app básica que se ejecuta en un único clúster de OpenShift
En este ejemplo, toda la app se ejecuta dentro de un único clúster de OpenShift. Es una app simple donde un único pod de cliente realiza una solicitud a un servicio en clúster, que a continuación se conecta a una instancia de etcd manejada por tres pods.
Client Application Service Etcd Instance
|------> [Etcd Pod 1]
|---> [Application Pod 1] ---|
| |
[Client pod] ---| |------> [Etcd Pod 2]
| |
|---> [Application Pod 2] ---|
|------> [Etcd Pod 3]
Ejemplo 2: una arquitectura de varios clústeres con un equilibrador de carga global y un servicio Cloudant
En el diagrama siguiente, la conexión se inicia mediante uno de los tres pods de cliente en un clúster de la región eu-de. Los pods de cliente se conectan a un equilibrador de carga global (GLB) que, a continuación, equilibra
la carga de la conexión con uno de los dos equilibradores de carga de aplicación (ALB) de VPC públicos en eu-de y eu-gb.
Cada uno de estos ALB de la VPC forma parte de un clúster independiente en sus regiones. Estos ALB direccionan el tráfico a los pods del direccionador OpenShift, que luego reenvía dicho tráfico a los pods de fondo del clúster. Estos pods de fondo se conectan a una base de datos Cloudant para manejar la solicitud.
Tenga en cuenta que algunas de estas conexiones se realizan a través de la red pública. Algunos están en una red privada en la misma VPC y algunos utilizan la red privada en IBM Cloud entre los componentes de una VPC y un servicio en IBM Cloud.
Ejemplo 3: Un cliente de VSI que contacta con un equilibrador de carga de red de VPC con un programa de fondo de servicio externo
En el ejemplo siguiente, el cliente es una VSI clásica en IBM Cloud. La VSI se conecta a través de la red privada a un equilibrador de carga de red (NLB) de VPC privado creado para un clúster de VPC. Este NLB equilibra el tráfico a uno de los tres nodos trabajadores de VPC a través del NodePort para el servicio de equilibrador de carga del clúster. A continuación, el servicio de equilibrador de carga de clúster envía el tráfico a uno de los pods de app que se conectan a un servicio de nube externo fuera de IBM Cloud a través de la red pública.
Paso 2: Elija una herramienta
Puede utilizar cualquiera de las herramientas siguientes para crear el diagrama de arquitectura.
- IBM Herramientas de diseño
- Draw.io
- Mural
- Sirenita
- Ilustrador de Adobe
- PowerPoint
- Keynote
Hay muchas herramientas de creación de diagramas disponibles. Elija la herramienta que mejor le funcione.
Paso 3: Crear el diagrama
Puede utilizar uno de los ejemplos mencionados anteriormente como referencia, o crear un diagrama desde cero.
Para obtener más información y arquitecturas de referencia, consulte IBM Architectures.