Service checklist

For things EBRAINS operates for users: web applications, APIs and data services. The ladder runs from code through a shared test deployment to production, monitoring and real users.

Service types: data_service, microservice_api, web_app · Rubric: EBRAINS default, version x4

How to read it: a level is reached when all of its conditions are met, and levels are climbed in order. Waived conditions are not required yet and are always shown as waived. A condition can be marked not applicable for a service (a status page cannot monitor itself); it then drops out of the level.

TRL 1 · Project initiation

• Basic principles known and high-level objectives defined
  Met when any of:
  • Service description recorded
  • Owner contact recorded
• Use case definitions, target users and supporting references
  Met when any of:
  • Use case recorded
  • Intended users recorded
  • Research backing recorded
  • Related publications recorded
  • Ethical aspects recorded

TRL 2 · Conceptualisation

• Practical applications of the service identified; proof of concept planned
  Met when any of:
  • Intended users recorded
  • Use case recorded
  • Repository accessible
  • Web app URL recorded

TRL 3 · Proof of concept implementation

• Separate elements of the service exist and are validated
  Met when any of:
  • Repository accessible
  • Primary repository URL recorded
  • Web app URL recorded

TRL 4 · Prototype component

• Key service elements integrated and functionally validated (initial version)
  Met when any of:
  • Continuous integration more than 0
  • Containerised
  • Test types recorded
  • Deployed environments recorded
  • Deployment environment: dev, staging or production

TRL 5 · Prototype integration

• End-to-end service integrated and interfaced with existing systems in a test environment
  Met when any of:
  • Deployment environment: dev, staging or production
  • Deployed environments recorded
  • Web app accessible

TRL 6 · Pilot-scale prototype to real-world integration

• Integrated service tested in an environment representing the actual one
  Met when any of:
  • Deployment environment: staging or production
  • Deployed environments include production
  • Deployed environments include staging
• System monitoring points identified
  Met when any of:
  • Health endpoint: anything but none
  • Uptime monitoring: yes
  • API monitoring: anything but none
  • Analytics (Matomo) recorded
• Initial service documentation and initial user documentation available
  Met when any of:
  • README quality: basic, good or comprehensive
  • Knowledge Graph documentation URL recorded
  • Documentation strategy recorded
  • API documentation: readme_only, openapi_v2 or openapi_v3

TRL 7 · Operational integration

• Validated with all key functionality in a relevant real-world environment
  Met when any of:
  • Deployment environment: production
  • Deployed environments include production
• System monitoring points implemented
  Met when any of:
  • Uptime monitoring: yes
  • API monitoring: anything but none
  • Analytics (Matomo) recorded
  • Uptime percentage (30 days) more than 0
• SLA monitored
  Waived — EBRAINS runs no SLA programme yet; nothing observable to check.
• No expected service changes; final design virtually complete
  Waived — No reliable EBRAINS signal for design completeness; a catalogue may map it to semantic or API versioning.

TRL 8 · Deployment

• Tested in a real-world environment with a small number of real users
  Met when any of:
  • Analytics (Matomo) recorded
  • IAM active users more than 0
  • Users count more than 0
• SLA enforced
  Waived — EBRAINS runs no SLA programme yet; nothing observable to check.
• Fully integrated with all operational systems
  Met when any of:
  • Auth integration: hbp_keycloak or ebrains_keycloak
  • Knowledge graph integration more than 0
  • EBRAINS ecosystem integration recorded
  • Health endpoint: anything but none
  • Containerised
• User documentation, training documentation and follow-up documentation completed
  Met when any of:
  • Knowledge Graph documentation URL recorded
  • README quality: good or comprehensive
  • API documentation: openapi_v2 or openapi_v3
  • KG learning resources count at least 1

TRL 9 · Production

• Tested in a real-world environment with a target number of real users
  Met when: User base at scale (gap-tolerant per service type).
• Service engineering and follow-up support in place
  Met when any of:
  • Support channels recorded
  • Issue tracking recorded
• Thoroughly depurated and operating over the full range of expected conditions
  Met when any of:
  • Uptime percentage (30 days) at least 99
  • Uptime monitoring: yes

Generated from the rubric Ready evaluates. Organisations can assess their own catalogues against their own rubric in Ready; those results are labelled as such and are not the EBRAINS default.