Document rationale for our solution

[j08lue]

Description

ESDS would like to understand VEDA’s auth architecture and underlying decisions for potential use on other projects. We need to clarify how to document these and for what use and prepare adequate documentation.

Continuation of

• Objective AU-4: Prepare documentation for ESDS #18

Preparatory tasks

• Determined the audience and what they want to use the documentation for
• Determined suitable format - for example MADR White Paper
• Collate existing Keycloak evaluation outcome docs for ESDS #27
• Introduction
• General approach for selecting auth solution
• Start drafting discussion
• Finish eval documentation
• VEDA case study data, excluding implementation
• VEDA case study data on implementation, testing and operation
• Finish conclusion and discussion
• Write abstract or executive summary
• Review paper draft

Possible topics to cover

1. Intro to VEDA - what does VEDA need Auth for? Both managers and engineers
2. General overview of use cases
3. Specific use cases
4. Possible future shortcomings of the solution

Acceptance criteria

• Documentation for ESDS completed, reviewed, and ready to share

[j08lue]

Target audience: Program managers who want to understand the solution VEDA decided on, the rationale for the decision (on a high level), and the scope of the solution.

Format: White Paper