Skip to content

Commit d5ab20a

Browse files
gaurav-nelsongaurav-nelson
committed
WIP:Do not merge
1 parent ea2810f commit d5ab20a

File tree

1 file changed

+215
-18
lines changed

1 file changed

+215
-18
lines changed

‎content/learn/about-pattern-tiers-types.adoc‎

Lines changed: 215 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,239 @@
22
menu:
33
learn:
44
parent: About Validated Patterns
5-
title: Validated Pattern tiers
5+
title: Validated Pattern tiers in depth
66
weight: 11
77
aliases: /about-validated-patterns/about-patterns-tiers-types/
88
---
99

1010
:toc:
1111

12-
:_content-type: ASSEMBLY
12+
:_mod-docs-content-type: ASSEMBLY
1313
include::modules/comm-attributes.adoc[]
1414

15-
[id="pattern-tiers"]
16-
== {solution-name-upstream} tiers
15+
[id="pattern-tiers-depth"]
16+
= Validated Pattern tiers in-depth
1717

18-
The different tiers of {solution-name-upstream} are designed to facilitate ongoing maintenance, support, and testing effort for a pattern. To contribute to a pattern that suits your solution or to learn about onboarding your own pattern, understand the following pattern tiers.
18+
[role="_abstract"]
19+
Patterns are categorized into distinct tiers: *Sandbox*, *Tested*, and *Maintained*.
1920

20-
[cols=".^1,.^2,5"]
21+
The different tiers of Validated Patterns are designed to facilitate ongoing maintenance, support, and testing efforts for a pattern.
22+
The tiering system emphasizes the requirements a pattern meets, rather than focusing on who does the maintenance.
23+
24+
The following table describes each pattern tier and a short description of what the tier means in practice.
25+
26+
[cols=".^1,.^2,5a"]
2127
|===
2228
|Icon|Pattern tier|Description
2329

24-
|image:pattern-tier-sandbox.png[]
25-
|link:/contribute/sandbox/[{sandbox-tier-first}]
26-
|A pattern categorized under the {sandbox} tier provides you with an entry point to onboard to {solution-name-upstream}. The minimum requirement to qualify for the {sandbox} tier is to start with the patterns framework and include minimal documentation.
30+
|image:pattern-tier-sandbox.png[Sandbox tier]
31+
|xref:#sandbox-tier[{sandbox-tier-first}]
32+
|A Sandbox pattern is:
33+
34+
* A starting point for extending existing patterns, rather than creating new ones from scratch.
35+
* Capable of being deployed onto a freshly installed {ocp} cluster without prior modification or tuning.
36+
* Designed to be useful without relying on private or closed source sample applications.
37+
38+
39+
|image:pattern-tier-tested.png[Tested tier]
40+
|xref:#tested-tier[{tested-tier-first}]
41+
|A Tested pattern is:
42+
43+
* A solution that undergoes a manual or automated test plan, which passes at least once for each new {ocp} minor version.
44+
* Tested on generally available (GA) releases.
45+
* Subject to implementation review by the patterns team to ensure its flexibility across various platforms, environments, and relevant industries.
46+
* Publicly visible link:/ci[CI status], providing transparency about the pattern's current state.
47+
48+
|image:pattern-tier-maintained.png[Maintained tier]
49+
|xref:#maintained-tier[{maintained-tier-first}]
50+
|A Maintained pattern is:
51+
52+
* Rigorously tested through an automated CI pipeline to ensure functionality across {ocp} versions, catching issues such as API deprecations quickly.
53+
* Tested on multiple GA releases as well as pre-release bits to ensure compatibility ahead of time.
54+
* Considered a "lifecycle" of a reference architecture, not just a point-in-time snapshot, ensuring it remains current and functional.
55+
* Built upon real-world solution architectures demonstrating business value.
56+
* Continuously validated to ensure all integrated components work seamlessly together as good or better after upgrades.
57+
* Includes only supported services and components.
58+
59+
|===
60+
61+
[id="sandbox-tier"]
62+
== Sandbox tier 
63+
64+
The Sandbox tier serves as the entry point for onboarding new Validated Patterns.
65+
Patterns in this tier are typically in a work-in-progress state and might have only been manually tested on a limited set of platforms.
66+
The primary goal for patterns here is to get started with the Validated Patterns framework and establish foundational documentation.
67+
68+
Following are the main characteristics and requirements for patterns to be in the sandbox tier:
69+
70+
* *Deployability*: The pattern must be deployable onto a newly installed {ocp} cluster without requiring any modification.
71+
* *Documentation*: The pattern must include a top-level README document highlighting the problem this pattern solves, along with an architecture diagram.
72+
* *Support policy*: The pattern must explicitly document the support policy for the pattern. For patterns in the sandbox tier, it is often community-based best-effort support.
73+
* *Open contribution*: The pattern should encourage contributions and should be open to collaboration from the community.
74+
75+
[NOTE]
76+
====
77+
For patterns in the process of being created, the site indicates the current state of development in the sandbox tier including the link to the source repository for the pattern.
78+
For example, the `status` shows, `In development`, or `Finished but waiting for documentation`, or `Testing` and other similar statuses.
79+
====
80+
81+
Following are some examples of the patterns in the sandbox tier:
82+
83+
* link:/amd-rag-chat-qna[OPEA Chat QnA accelerated with AMD Instinct]
84+
* link:/virtualization-starter-kit[Virtualization Starter Kit]
85+
* link:/federated-edge-observability[Federated Edge Observability]
86+
87+
[role="_additional-resources"]
88+
.Additional resources
89+
90+
* For more information about creating a new pattern, see link:/contribute/creating-a-pattern[Creating a pattern].
91+
* For more information about nominating your pattern for the Sandbox tier, see link:/contribute/sandbox/#nominating-a-pattern-for-sandbox-tier[Nominating a pattern for the sandbox tier]
92+
93+
[id="tested-tier"]
94+
== Tested tier
95+
96+
The Tested tier provides additional assurance that a pattern is functional, reliable, and the pattern creators have put in effort to meet additional criteria.
97+
98+
A pattern categorized under the tested tier indicates that the pattern has been tested within the last quarter on at least the most recent Extended Update Support (EUS) version of {rh-ocp}.
99+
You can view the specifics about the testing, including whether it is manual or automated, on the Status Page.
100+
101+
Following are the main characteristics and requirements for patterns to be in the tested tier:
102+
103+
* *Business use case and demo**: Must have a defined business use case with a demonstration.
104+
* *Architecture and guides*: Must include a standardized architecture diagram and a written guide for demonstrating the pattern.
105+
* *Test plan*: Must include a test plan covering all highlighted features, defining how to validate successful deployment and operational functionality. The test plan must pass at least once per quarter.
106+
* *{ocp} version testing*: Must nominate and test against at least one currently supported {ocp} release.
107+
* *Transparency*: Must create a publicly available JSON file that records the result of the latest test for each combination of pattern, platform, and {ocp} version.
108+
* *Focus*: Primarily focuses on functionality rather than performance.
109+
110+
Following are some examples of the patterns in the tested tier:
111+
112+
* link:/rag-llm-gitops[AI Generation with LLM and RAG]
113+
* link:/travelops[TravelOps]
114+
* link:/retail[Retail]
115+
116+
[id="maintained-tier"]
117+
== Maintained tier
118+
119+
The Maintained tier represents the highest level of validation for a pattern.
120+
The Validated Patterns team prioritizes these patterns for continuous testing to ensure they remain functional across {ocp} updates and API changes.
121+
122+
Patterns in this tier are functional on the currently supported stable versions of {ocp}. This includes the two latest Extended Update Support (EUS) releases and the active standard minor version between them.
123+
For example, 4.18 (EUS), 4.19, and 4.20 (EUS).
124+
125+
Additionally, Validated Patterns in this tier undergo rigorous continuous integration (CI) testing. Testing environments are tailored to individual pattern requirements, using platforms such as Google Cloud, AWS, Microsoft Azure, and bare metal. The specific testing environment is listed in the testing results on the pattern page and the link:/ci[CI status] page.
126+
127+
Following are the main characteristics and requirements for patterns to be in the maintained tier:
128+
129+
* *Comprehensive testing*: Must include test plan automation that runs on every change to the pattern, or on a schedule no less frequently than once per week. This should be included in the Git repository to allow for others to use these same tests in other environments.
130+
* *Broad compatibility*: Must be tested on a sliding set of {ocp} releases, specifically the two latest Extended Update Support (EUS) releases and the active standard minor version between them. For example, 4.18 (EUS), 4.19, and 4.20 (EUS). List any hardware or cloud environment requirements.
131+
132+
* *Timely fixes*: Must fix any breakage in a timely manner.
133+
* *Product review*: Their architectures must be reviewed by representatives of each consumed Red{nbsp}Hat product to ensure consistency with product roadmaps.
134+
* *Support policy documentation*: Must document their support policy.
135+
* *No Technology Preview features*: Do not rely on Technology Preview functionality or features that are hidden behind feature gates. Ensure that all services, features, and capabilities are supportable. This support does not need to come from Red{nbsp}Hat, but a support path must exist.
136+
137+
Following are some examples of the patterns in the maintained tier:
138+
139+
* link:/ansible-edge-gitops[Ansible Edge GitOps]
140+
* link:/multicloud-gitops[Multicloud GitOps]
141+
* link:/industrial-edge[Industrial Edge]
142+
* link:/medical-diagnosis[Medical Diagnosis]
143+
144+
[id="feature-breakdown-by-tiers"]
145+
== Feature breakdown by tiers
146+
147+
[cols="4,^1,^1,^1", options="header"]
148+
|===
149+
| Feature | Sandbox | Tested | Maintained
150+
151+
| *Deploys on fresh OpenShift without modification*
152+
| ✓
153+
| ✓
154+
| ✓
155+
156+
| *Useful without private/closed source apps*
157+
| ✓
158+
| ✓
159+
| ✓
160+
161+
| *Open contribution and collaboration*
162+
| ✓
163+
| ✓
164+
| ✓
165+
166+
| *Documented support policy*
167+
| ✓
168+
| ✓
169+
| ✓
170+
171+
| *README with problem statement*
172+
| ✓
173+
| ✓
174+
| ✓
175+
176+
| *Includes architecture diagram*
177+
| ✓
178+
| ✓
179+
| ✓
180+
181+
| *Business use case with demo*
182+
| -
183+
| ✓
184+
| ✓
185+
186+
| *Standardized architecture diagram and written guide*
187+
| -
188+
| ✓
189+
| ✓
190+
191+
| *Test plan passes at least once per quarter*
192+
| -
193+
| ✓
194+
| ✓
195+
196+
| *Tested on at least 1 supported OCP version*
197+
| -
198+
| ✓
199+
| ✓
200+
201+
| *Publicly visible test results (JSON)*
202+
| -
203+
| ✓
204+
| ✓
27205

28-
The patterns in this tier might be in a work-in-progress state; and they might have been manually tested on a limited set of platforms.
206+
| *Implementation review*
207+
| -
208+
| ✓
209+
| ✓
29210

211+
| *Automated CI pipeline (every change or weekly)*
212+
| -
213+
| -
214+
| ✓
30215

31-
|image:pattern-tier-tested.png[]
32-
|link:/contribute/tested/[{tested-tier-first}]
33-
|A pattern categorized under the {tested} tier implies that the pattern might have been recently working on at least one recent version of {rh-ocp}. Qualifying for this tier might require additional work for the pattern’s owner, who might be a partner or a motivated subject matter expert (SME).
216+
| *Tested on 2 latest EUS and active interim versions*
217+
| -
218+
| -
219+
| ✓
34220

35-
The patterns in this tier might have a defined business problem with a demonstration. The patterns might have a manual or automated test plan, which passes at least once for each new {rh-ocp} minor version.
221+
| *Tested on pre-release bits*
222+
| -
223+
| -
224+
| ✓
36225

37-
|image:pattern-tier-maintained.png[]
38-
|link:/contribute/maintained/[{maintained-tier-first}]
39-
|A pattern categorized under the {maintained} tier implies that the pattern might have been functional on all currently supported extended update support (EUS) versions of {rh-ocp}. Qualifying for this tier might require additional work for the pattern’s owner who might be a partner or a motivated SME.
226+
| *Timely fixes for breakage*
227+
| -
228+
| -
229+
| ✓
40230

41-
The patterns in this tier might have a formal release process with patch releases. They might have continuous integration (CI) automation testing.
231+
| *No Tech Preview or feature-gated features*
232+
| -
233+
| -
234+
| ✓
42235

236+
| *Includes only supported services and components*
237+
| -
238+
| -
239+
| ✓
43240
|===

0 commit comments

Comments
 (0)