ADR-00000 Template#

Authors:

Status#

<Draft, Proposed, Reviewing, Accepted, Rejected, Superseded>

Problem Statement#

<Why does this ADR exist? What decision are you trying to reach?>

Goals#

  • <Clearly list the goals which this work will try to achieve.>

  • <The goals should be achievable, not visionary statements.>

Non-goals#

  • <If any of the goals might be interpreted too broadly, here’s where you limit their scope.>

Current Architecture#

  • <If something is already solving the problem (even partially), here’s where you mention it.>

Proposed Architecture#

  • <Present a high level overview of the proposed solution.>

  • <Make it concise and simple; put diagrams; be concrete, avoid using vague generalizations.>

Challenges#

  • <Call out any challenges here, e.g. upskilling needed, specific resources needed, very aggressive timelines if known, etc.>

Alternatives Considered#

  • <Were any other approaches to solving the issue considered? If yes, describe them here.>

  • <Focus on the differences in outcomes (both positive and negative) between the proposed architecture and the alternatives.>

Dependencies#

  • <Does this proposal depend on other things also being in place? List them.>

Stakeholders#

  • <Who needs to sign off on this proposal for it to be implementable?>

    • <Since SIG-SRE ADRs impact how the SIG operates, the default set of stakeholders would consist of relevant SIG-SRE members (plus external stakeholders, if any).>

Consequences if Not Completed#

  • <What happens if this proposal is not accepted and implemented?>

  • <Start with immediate consequences, don’t base your argument on what you think might happen 5 years from now.