Estándar de Nombramiento

Estándar de nombramiento de los diferentes tipos de elementos que se pueden desplegar en el cluster.

Namespaces
Deploy
Service

Namespace

Los namespace en k8s, nos permite agrupar los elementos desplegados en el cluster de manera lógica, facilitando la gestión de los recursos (cpu y/o memoria) y la gestión de metricas de solicitudes, latencia y red. Es por ello, que los componentes de que hacen parte de un microservicio deben ser agrupados en un namespace.

Los equipos de trabajo deben solicitar Arquitectura Empresarial la creación de los namespaces, puesto que es necesario configurar en estos, los permisos de acceso al ACR (Azure Container Register).

Importante: La palabras compuestas deben ser separadas por "-" y todo deber ser escrito en minúscula.

Nombramiento correcto

traffic-control
middleware-rndc
invoicing

Nombramiento incorrecto

fuelsensor

Deploy

El estándar de nombramiento de los elementos desplegados en cluster de k8s deben seguir la siguiente estructura.

deploy - [microservicio]-[componente]-[elemento].

middleware-rndc-gateway
middleware-rndc-geofencingmanager
middleware-rndc-remittanceentry

Cuando el componente corresponde a un servicio REST, este debe ser llamado como api

alarm-manager-api

Y si es un sitio web, debe ser llamado ui

new-web-portal-ui

Por último, si el componente corresponde a un demonio o una tarea en background, su nombramiento corresponde a la tarea que realiza.

middleware-rndc-monitoring

Si el despliegue corresponde a una aplicación, su estructura deber ser:

deploy - [cliente]-[microservicio]-[componente]-[elemento].

esu-integration-events-filter
esu-integration-events-notifier
esu-integration-services-status-notifier

Nota: Si la aplicación es utilizada por más de un cliente, el valor [cliente] debe ser modificado por [app]

app-kml-api
app-drivers-api

Importante La palabras compuestas deben ser separadas por "-", independiente si hace parte del microservicio, componente o elemento y todo deber ser escrito en minúscula.

A continuación se describe un conjunto de nombramientos incorrectos.

integrationeventsecopetrolprocessor
kmlconsumerkafka
bckactivationservices
fuelconsolidatetank
rpttmrmigratorrt

Service