Ako by mali byť komponenty a služby v OpenShift dokumentované a opísané?

V OpenShifte sa komponentami a službami sa običajno dokumentuje s pomočjo anotacij in metapodatkov v YAML manifestih, kot tudi v zunanji dokumentaciji (npr. README ali Wiki). Pomembno je opisati:

• Namen komponente ali storitve
• Vhodne parametre (spremenljivke okolja, konfiguracije)
• Odvisnosti od drugih storitev
• Vrata in protokoli
• Politike skaliranja in posodobitev

Prav tako je koristno uporabljati specifikacije OpenAPI za opis API-jev storitev in Helm charts z dobro strukturiranimi values.yaml in README za parametrizacijo in namestitev.

Primer anotacije v Deployment:

metadata:
  name: my-service
  annotations:
    description: "Storitev za obdelavo naročil"
    owner: "team@example.com"