Operational and SysOps needs - Work in Progress (WIP)

Based on the SysOps SIG meeting on 20210827 

1. Improve operational documentation
   1. Consistent and project wide method for documenting
      • Ports
      • Data connections (postgres, elasticsearch, kafka, object store)
      • Environmental/runtime variables
      • Configuration entries
      • Upgrade instructions
   2. General operational documentation
2. Allow OKAPI to discover services
3. Allow for a simpler basic install
   • Reduce the scope of FOLIO core
     • have 3 Apps maximum
   • Allow for a simpler addition of Apps
   • Simplify complex dependency graph
   • Enforce Domain Boundaries that define an App; reduce dependencies
4. Simplify Folio bootstrap process
   • Service Discovery
   • Importing of Module Descriptors
   • Enabling Modules for Tenants
   • Superuser provision
   • configuration process
5. Document (or update existing) technical philosophy. For example:
   • We prefer Containers
   • We strive for continuous release and deployment; to follow recommendations for 12 factor applications
   • How we try to balance "Small Core" and "Complete Product"
   • How we handle Domain Boundaries (where APIs overlap, interact, and potentially duplicate) and improve contracts between modules
6. Clear and consistent Semantic Versioning across the entire project
   • All modules and okapi have the same Major version number when APIs are compatible.
7. Improve logging across the platform
   • A very small number of well documented patterns (we understand that Vertx, Springboot, and edge modules may need different patterns)
8. Improve stance for agnostic hosting (we have cloud, on-premises, and local deployments; single server, multi server, and kubernetes deployments)