|
2 | 2 | menu: |
3 | 3 | learn: |
4 | 4 | parent: About Validated Patterns |
5 | | -title: Validated Pattern tiers |
| 5 | +title: Validated Pattern tiers in depth |
6 | 6 | weight: 11 |
7 | 7 | aliases: /about-validated-patterns/about-patterns-tiers-types/ |
8 | 8 | --- |
9 | 9 |
|
10 | 10 | :toc: |
11 | 11 |
|
12 | | -:_content-type: ASSEMBLY |
| 12 | +:_mod-docs-content-type: ASSEMBLY |
13 | 13 | include::modules/comm-attributes.adoc[] |
14 | 14 |
|
15 | | -[id="pattern-tiers"] |
16 | | -== {solution-name-upstream} tiers |
| 15 | +[id="pattern-tiers-depth"] |
| 16 | += Validated Pattern tiers in-depth |
17 | 17 |
|
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 | +Patterns are categorized into distinct tiers: *Sandbox*, *Tested*, and *Maintained*. |
19 | 19 |
|
20 | | -[cols=".^1,.^2,5"] |
| 20 | +The different tiers of Validated Patterns are designed to facilitate ongoing maintenance, support, and testing efforts for a pattern. |
| 21 | +The tiering system emphasizes the requirements a pattern meets, rather than focusing on who does the maintenance. |
| 22 | + |
| 23 | +The following table describes each pattern tier and a short description of what the tier means in practice. |
| 24 | + |
| 25 | +[cols=".^1,.^2,5a"] |
21 | 26 | |=== |
22 | 27 | |Icon|Pattern tier|Description |
23 | 28 |
|
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. |
| 29 | +|image:pattern-tier-sandbox.png[Sandbox tier] |
| 30 | +|xref:#sandbox-tier[{sandbox-tier-first}] |
| 31 | +|A Sandbox pattern is: |
27 | 32 |
|
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. |
| 33 | +* A starting point for extending existing patterns, rather than creating new ones from scratch. |
| 34 | +* Capable of being deployed onto a freshly installed {ocp} cluster without prior modification or tuning. |
| 35 | +* Designed to be useful without relying on private or closed source sample applications. |
29 | 36 |
|
30 | 37 |
|
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). |
| 38 | +|image:pattern-tier-tested.png[Tested tier] |
| 39 | +|xref:#tested-tier[{tested-tier-first}] |
| 40 | +|A Tested pattern is: |
34 | 41 |
|
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. |
| 42 | +* A solution that undergoes a manual or automated test plan, which passes at least once for each new {ocp} minor version. |
| 43 | +* Subject to implementation review by the patterns team to ensure its flexibility across various platforms, environments, and relevant industries. |
36 | 44 |
|
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. |
| 45 | +|image:pattern-tier-maintained.png[Maintained tier] |
| 46 | +|xref:#maintained-tier[{maintained-tier-first}] |
| 47 | +|A Maintained pattern is: |
40 | 48 |
|
41 | | -The patterns in this tier might have a formal release process with patch releases. They might have continuous integration (CI) automation testing. |
| 49 | +* Rigorously tested through an automated CI pipeline to ensure functionality across {ocp} versions, catching issues such as API deprecations quickly. |
| 50 | +* Considered a "lifecycle" of a reference architecture, not just a point-in-time snapshot, ensuring it remains current and functional. |
| 51 | +* Built upon real-world solution architectures demonstrating business value. |
| 52 | +* Continuously validated to ensure all integrated components work seamlessly together as good or better after upgrades. |
42 | 53 |
|
43 | 54 | |=== |
| 55 | + |
| 56 | +[id="sandbox-tier"] |
| 57 | +== Sandbox tier |
| 58 | + |
| 59 | +The Sandbox tier serves as the entry point for onboarding new Validated Patterns. |
| 60 | +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. |
| 61 | +The primary goal for patterns here is to get started with the Validated Patterns framework and establish foundational documentation. |
| 62 | + |
| 63 | +Following are the main characteristics and requirements for patterns to be in the sandbox tier: |
| 64 | + |
| 65 | +* *Deployability*: The pattern must be deployable onto a newly installed {ocp} cluster without requiring any modification. |
| 66 | +* *Documentation*: The pattern must include a top-level README document highlighting the problem this pattern solves, along with an architecture diagram. |
| 67 | +* *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. |
| 68 | +* *Open contribution*: The pattern should encourage contributions and should be open to collaboration from the community. |
| 69 | + |
| 70 | +[NOTE] |
| 71 | +==== |
| 72 | +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. |
| 73 | +For example, the `status` shows, `In development`, or `Finished but waiting for documentation`, or `Testing` and other similar statuses. |
| 74 | +==== |
| 75 | + |
| 76 | +Following are some examples of the patterns in the sandbox tier: |
| 77 | + |
| 78 | +* link:/amd-rag-chat-qna[OPEA Chat QnA accelerated with AMD Instinct] |
| 79 | +* link:/virtualization-starter-kit[Virtualization Starter Kit] |
| 80 | +* link:/federated-edge-observability[Federated Edge Observability] |
| 81 | + |
| 82 | +[role="_additional-resources"] |
| 83 | +.Additional resources |
| 84 | + |
| 85 | +* For more information about creating a new pattern, see xref:https://validatedpatterns.io/contribute/creating-a-pattern/[Creating a pattern]. |
| 86 | +* For more information about nominating your pattern for the Sandbox tier, see xref:https://validatedpatterns.io/contribute/sandbox/#nominating-a-pattern-for-sandbox-tier[Nominating a pattern for the sandbox tier] |
| 87 | + |
| 88 | +[id="tested-tier"] |
| 89 | +== Tested tier |
| 90 | + |
| 91 | +The Tested tier provides additional assurance that a pattern is functional, reliable, and the pattern creators have put in effort to meet additional criteria. |
| 92 | + |
| 93 | +A pattern categorized under the tested tier indicates that the pattern has been tested within the last quarter on at least the most recent long life version of {rh-ocp}. |
| 94 | +You can view the specifics about the testing, including whether it is manual or automated, on the Status Page. |
| 95 | + |
| 96 | +Following are the main characteristics and requirements for patterns to be in the tested tier: |
| 97 | + |
| 98 | +* *Business use case and demo**: Must have a defined business use case with a demonstration. |
| 99 | +* *Architecture and guides*: Must include a standardized architecture diagram and a written guide for demonstrating the pattern. |
| 100 | +* *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. |
| 101 | +* *{ocp} version testing*: Must nominate and test against at least one currently supported {ocp} release. |
| 102 | +* *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. |
| 103 | +* *Focus*: Primarily focuses on functionality rather than performance. |
| 104 | + |
| 105 | +Following are some examples of the patterns in the tested tier: |
| 106 | + |
| 107 | +* link:/rag-llm-gitops[AI Generation with LLM and RAG] |
| 108 | +* link:/travelops[TravelOps] |
| 109 | +* link:/retail[Retail] |
| 110 | + |
| 111 | +[id="maintained-tier"] |
| 112 | +== Maintained tier |
| 113 | + |
| 114 | +The Maintained tier represents the highest level of validation for a pattern. |
| 115 | +The Validated Patterns team prioritizes these patterns for continuous testing to ensure they remain functional across {ocp} updates and API changes. |
| 116 | + |
| 117 | +Patterns in this tier are functional on the following versions of {ocp}: |
| 118 | + |
| 119 | +* Latest version |
| 120 | +* One earlier version |
| 121 | +* Latest long-life version |
| 122 | + |
| 123 | +Additionally, they undergo rigorous testing including continuous integration (CI) automation testing. |
| 124 | + |
| 125 | +Following are the main characteristics and requirements for patterns to be in the maintained tier: |
| 126 | + |
| 127 | +* *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. |
| 128 | +* *Broad compatibility*: Must be tested on a sliding set of {ocp} releases, which includes the latest version, at least one earlier version, and the latest long-life version. |
| 129 | +* *Timely fixes*: Must fix any breakage in a timely manner. |
| 130 | +* *Product review*: Their architectures must be reviewed by representatives of each consumed Red{nbsp}Hat product to ensure consistency with product roadmaps. |
| 131 | +* *Support policy documentation*: Must document their support policy. |
| 132 | +* *No tech preview features*: Must not rely on functionality in tech-preview or hidden behind feature gates. |
| 133 | + |
| 134 | +Following are some examples of the patterns in the maintained tier: |
| 135 | + |
| 136 | +* link:/ansible-edge-gitops[Ansible Edge GitOps] |
| 137 | +* link:/multicloud-gitops[Multicloud GitOps] |
| 138 | +* link:/industrial-edge[Industrial Edge] |
0 commit comments