Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 2 KB

design_template.md

File metadata and controls

62 lines (47 loc) · 2 KB

1. Introduction

Purpose of this document

2. Problem statement

Provide registered blueprint URL for this feature

Blueprint must provide a brief description of the problem being solved

3. Proposed solution

Describe the proposed solution

4. Alternatives considered

Describe pros and cons of alternatives considered

5. API schema changes

Describe api schema changes and impact to REST APIs

6. UI changes

Describe any UI change applicable to this feature

Modifications to existing UI work flow with appropriate justifications

7. Notification impact

Describe any log, UVE, alarm changes

Describe all new elements added as part of this feature

8. Provisioning changes

Describe how this feature will be automatically provisioned

Describe all applicable envs like Kubernetes, RHOSP, JuJu, openshift, etc.

Describe any change to notifications provided to client systems

9. Implementation

Describe changes in all affected components such as controller, agent, etc.

Describe all data model schema changes applicable to this feature

Describe changes to key data structures

Describe synchronous/asynchronous nature of any API calls being made if any

Describe the impact on the feature during process restart if any

Describe all logs and debug messages associated with this feature

Describe all high availability considerations

10. Performance and scaling impact

API and control plane

Scaling and performance for API and control plane

Scaling and performance for API and forwarding

11. Upgrade

Describe upgrade impact of the feature, including ISSU

Schema migration/transition

12. Deprecations

If this feature deprecates any older feature or API then list it here

13. Dependencies

Describe dependent features or components

Describe any new infrastructure component required

14. Testing

Unit tests

Dev tests

System tests

15. Documentation Impact

16. References