mirror of
https://github.com/external-secrets/external-secrets.git
synced 2024-12-14 11:57:59 +00:00
1.6 KiB
1.6 KiB
---
title: My Shiny New Feature
version: v1alpha1
authors: you, me
creation-date: 2020-09-01
status: draft
---
My Shiny New Feature
Table of Contents
// autogen please
Summary
Please provide a summary of this proposal.
Motivation
What is the motivation of this proposal? Why is it useful and relevant?
Goals
What are the goals of this proposal, what's the problem we want to solve?
Non-Goals
What are explicit non-goals of this proposal?
Proposal
How does the proposal look like?
User Stories
How would users use this feature, what are their needs?
API
Please describe the API (CRD or other) and show some examples.
Behavior
How should the new CRD or feature behave? Are there edge cases?
Drawbacks
If we implement this feature, what are drawbacks and disadvantages of this approach?
Acceptance Criteria
What does it take to make this feature producation ready? Please take the time to think about:
- how would you rollout this feature and rollback if it causes harm?
- Test Roadmap: what kinds of tests do we want to ensure a good user experience?
- observability: Do users need to get insights into the inner workings of that feature?
- monitoring: How can users tell whether the feature is working as expected or not? can we provide dashboards, metrics, reasonable SLIs/SLOs or example alerts for this feature?
- troubleshooting: How would users want to troubleshoot this particular feature? Think about different failure modes of this feature.
Alternatives
What alternatives do we have and what are their pros and cons?