Skip to content

Commit 8d4e7fd

Browse files
authored
Merge pull request #63 from rochaporto/processrefarchs
Add process for reference architectures
2 parents 89d9dc1 + b51078f commit 8d4e7fd

File tree

2 files changed

+73
-0
lines changed

2 files changed

+73
-0
lines changed
55.1 KB
Loading

process/reference-architectures.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Reference Architecture Submission Process
2+
3+
This document summarizes the process for the submission, review, and publication of new reference architectures in the CNCF. It describes the expected workflow and the different stakeholders involved in each step.
4+
5+
![Reference Architecture Workflow Diagram](reference-architectures-workflow.png)
6+
<p align="center">
7+
( <a href="https://docs.google.com/drawings/d/1VkNwpQS_IxZKSl49B-RXzo1Zh2mofQ-MFRyoYhnDkus/edit?usp=sharing">original diagram</a> )
8+
</p>
9+
10+
## Workflow Steps
11+
12+
### 1. Proposed
13+
14+
*Who: Individual End Users, Groups of End Users, Community Groups*
15+
16+
New reference architectures should be submitted via [this github template (coming soon)]() by individual end users, groups of end users from a specific domain or end user group, or community groups.
17+
18+
The information to be included in the proposal is in the template, and includes at a minimum:
19+
* The contact for the reference architecture;
20+
* The end user(s) organization(s) backing the submission and its content;
21+
* The CNCF projects being used by the stack;
22+
* (optional) The domain or industry of the reference architecture;
23+
24+
### 2a. Accepted
25+
26+
*Who: Acceptance should be done by the TAB members*
27+
28+
Each submission should be reviewed by the TAB and accepted before the detailed work starts. The purpose of this step is to validate its relevance to the community and clarify any open items, potential overlaps with existing documents, etc.
29+
30+
Once accepted, work should start in expanding the content of the reference architecture.
31+
32+
### 2b. Rejected
33+
34+
*Who: Rejection should be done by the TAB members*
35+
36+
After a review by the assigned TAB member and consultation with the complete TAB a proposal can be rejected.
37+
38+
Rejection can happen due to different reasons, such as a proposal being out of scope for cloud native architectures, excessive reliance on proprietary products, etc.
39+
40+
### 3a. Reviewed
41+
42+
*Who: One or more members of the TAB previously assigned to this reference architecture*
43+
44+
Review of reference architectures is expected to be an iterative process between the submitters and the reviewers assigned by the TAB - usually TAB members. This process aims at keeping the content consistent across different submissions as well as ensuring the key take-aways are properly highlighted.
45+
46+
### 3b. Feedback
47+
48+
*Who: TAB members assigned to this reference architecture*
49+
50+
Feedback should be provided for every reference architecture being rejected (see 2b above). Where appropriate, additional information regarding a potential later resubmission should also be included.
51+
52+
### 4. Validated
53+
54+
*Who: Technical Oversight Committee (TOC)*
55+
56+
Reference architectures often include extensive information regarding the usage of projects in the CNCF, including the end user perspective on the project maturity and production readiness. These might in some cases conflict with the project maturity levels as set by the TOC.
57+
58+
To prevent confusion and conflicting information, the TOC is consulted to validate the reference architecture. The TOC might, if appropriate, request the submitters add additional context information on the usage of a project and explanations on any conflicting views of the project maturity.
59+
60+
### 5. Published
61+
62+
*Who: Reference Architecture submitters, reviewers and CNCF staff*
63+
64+
Once validated the new reference architecture is published under [https://architecture.cncf.io/](https://architecture.cncf.io/). This is done by CNCF staff in coordination with the submitters and the reviewers, collecting additional information relevant for the announcement.
65+
66+
### 6. Announced
67+
68+
*Who: CNCF Staff and TAB*
69+
70+
After publication CNCF staff and TAB take care of the announcement of the new reference architecture via different mechanisms, at least:
71+
* As a news item in the monthly TAB public meeting
72+
* An email circulated to the end user mailing list
73+
* A message in the #enduser and #tab channels in the CNCF slack

0 commit comments

Comments
 (0)