search

tmforum-oda / oda-ca-docs

ODA Component Accelerator Documents
6 stars 17 forks source link

component: Naming conventions for the microservices inside a component. #45

Open abbeydom opened 1 year ago

abbeydom commented 1 year ago

Description

The design guidelines does not specify the naming convention for the microservices inside a component. When components are deployed with the same release names, the microservices may conflict. Therefore, a naming convention for the microservices is proposed which should include the component name e.g.: e.g. metadata: name: {{.release.name}}-{{.component.name}}-{{.microservices.name}} i.e. r1-prodcatalogue-productcatalogapi

LesterThomas commented 1 year ago

I can see 4 possible options to solve this (I'm happy if people want to propose more to consider):

Use namespaces to avoid conflicts (this has previously been discounted as many organisations will already be using namespaces for other purposes). Add component name into the name for all resources (and validate with CTK - possibly with a warning instead of an error). We may get an issue with names being too long. Create a new shortname for each component and add this to the name for all resources. Possibly create a registry of short names to avoid components having conflicting shortnames. Mandate a unique reference is used as the release name when deploying with helm (possibly using shortname or full name of component in the release name).