Uploaded image for project: 'OpenShift Over the Air'
  1. OpenShift Over the Air
  2. OTA-590

[App-SRE checkpoint] No architecture document for Cincinnati

XMLWordPrintable

    • 5
    • False
    • False
    • OTA 219

      During a recent service checkpoint done by App-SRE, it appears the Cincinnati service does not have an architecture document linked under it's app.yml file in app-interface: https://gitlab.cee.redhat.com/service/app-interface/-/blob/f443921844c86c91e824251da8768b029161418a/data/services/cincinnati/app.yml#L15

      An architecture document should be written to show how the service functions, what it's dependencies are, etc... It does not need to go very deep into the details but it should allow anyone with no prior experience with the service to understand what the service does, what are its components and how they relate to each other, what services depends on it, what services it depends on

      More details in the AppSRE contract here: https://gitlab.cee.redhat.com/app-sre/contract/-/blob/master/content/service/metadata.md

            pratikam Pratik Mahajan
            jchevret Jean-Francois Chevrette
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: