Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ All content files use YAML frontmatter between `---` delimiters. Fields vary by
title: Pattern Name
date: 2025-10-24
summary: Short description of the pattern
tier: sandbox # sandbox | tested | maintained
tier: sandbox # sandbox | tested | maintained | archived
rh_products:
- Red Hat OpenShift Container Platform
industries:
Expand Down
5 changes: 3 additions & 2 deletions archetypes/pattern/_index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ links:
bugs:
feedback: https://docs.google.com/forms/d/e/1FAIpQLScI76b6tD1WyPu2-d_9CCVDr3Fu5jYERthqLKJDUGwqBg7Vcg/viewform

# Set tier to one of sandbox, tested, or maintained. If empty, the default
# is sandbox
# Set tier to one of sandbox, tested, maintained, or archived. If empty, the
# default is sandbox. Use archived only when Validated Patterns maintainers
# have archived the pattern repository; archived is a terminal state.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# have archived the pattern repository; archived is a terminal state.
# have archived the pattern repository.

# tier: sandbox
#
# The following parameters are only used for maintained validated patterns.
Expand Down
2 changes: 2 additions & 0 deletions content/ci/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ menu:
---

These are the latest results of the Validated Patterns CI test runs.

This dashboard excludes patterns in the Archived tier because they are no longer under active development or continuous integration.
57 changes: 57 additions & 0 deletions content/contribute/archived.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
menu:
contribute:
parent: Contributing and managing patterns
title: Validated Patterns - Archived tier
weight: 56
aliases: /contribute/archived/
---

:toc:
:imagesdir: /images
:_content-type: ASSEMBLY
include::modules/comm-attributes.adoc[]

[id="about-archived-tier"]
= About the {archived-tier-first}

A pattern in the {archived} tier is no longer under active development.
Validated Patterns maintainers move a pattern to this tier when the pattern's source repository has been archived on GitHub.
Archived patterns remain documented for reference, but avoid using them for new deployments.

[IMPORTANT]
====
The {archived} tier is a terminal state.
Patterns do not move from {archived} back to {sandbox}, {tested}, or {maintained}.
====

[id="moving-a-pattern-to-archived-tier"]
== Moving a pattern to the {archived} tier

Only Validated Patterns maintainers decide when a pattern moves to the {archived} tier.
A pattern does not move to {archived} automatically.

Typical conditions before archiving include:

* The pattern repository has been archived on GitHub.
* No further development or maintenance is planned.

After a pattern is archived:

* The pattern page and related documentation remain available.
* Pattern cards use a desaturated style, and an Archived banner appears on the pattern documentation pages.
* The Install resource link on the pattern page is disabled.
* The pattern is hidden from the default patterns catalog view until you select the Archived filter.
* The pattern is not included in the homepage tier accordion.

[id="requirements-archived-tier"]
== Requirements for the {archived} tier

Must::

[id="must-archived-tier"]
=== Must

. The pattern repository must be archived on GitHub.
. The pattern frontmatter must set `tier: archived`.
. Keep pattern documentation published so existing users can find historical guidance.
64 changes: 61 additions & 3 deletions content/learn/about-pattern-tiers-types.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ include::modules/comm-attributes.adoc[]
= Validated Pattern tiers in-depth

[role="_abstract"]
Patterns are categorized into distinct tiers: *Sandbox*, *Tested*, and *Maintained*.
Patterns are categorized into distinct tiers: *Sandbox*, *Tested*, *Maintained*, and *Archived*.

The different tiers of Validated Patterns are designed to facilitate ongoing maintenance, support, and testing efforts for a pattern.
The tiering system emphasizes the requirements a pattern meets, rather than focusing on who does the maintenance.
Expand Down Expand Up @@ -56,6 +56,15 @@ The following table describes each pattern tier and a short description of what
* Continuously validated to ensure all integrated components work seamlessly together as good or better after upgrades.
* Includes only supported services and components.

|image:pattern-tier-archived.png[Archived tier]
|xref:#archived-tier[{archived-tier-first}]
|An Archived pattern is:

* No longer actively developed.
* Kept in the documentation site for reference, with an Archived notice on its pages.
* Hidden from the default patterns catalog until you select the Archived filter.
* Not recommended for new deployments.

|===

[id="sandbox-tier"]
Expand Down Expand Up @@ -138,102 +147,151 @@ Following are some examples of the patterns in the maintained tier:

* link:/ansible-edge-gitops[Ansible Edge GitOps]
* link:/multicloud-gitops[Multicloud GitOps]

[id="archived-tier"]
== Archived tier

The Archived tier is for patterns that Validated Patterns maintainers have retired from active development.
A pattern moves to this tier when its source repository has been archived on GitHub.
Archiving is a manual decision by Validated Patterns maintainers and is a terminal state. Patterns do not move from Archived back to another tier.

Documentation for archived patterns remains available for reference.
Pattern pages show an Archived banner, Install links are inactive, and pattern cards appear desaturated in the catalog when you enable the Archived filter.

Following are the main characteristics of patterns in the archived tier:

* *Repository status*: The pattern repository is archived on GitHub.
* *No active maintenance*: No further development, CI, or support expectations apply to the pattern.
* *Reference documentation*: Existing documentation remains published for historical reference.
* *Catalog visibility*: Archived patterns are hidden from the default patterns list until you select the Archived filter.

Following are some examples of the patterns in the archived tier:

* link:/medical-diagnosis[Medical Diagnosis]

[role="_additional-resources"]
.Additional resources

* For more information about the Archived tier process, see link:/contribute/archived/[Archived tier].

[id="feature-breakdown-by-tiers"]
== Feature breakdown by tiers

[cols="4,^1,^1,^1", options="header"]
[cols="4,^1,^1,^1,^1", options="header"]
|===
| Feature | Sandbox | Tested | Maintained
| Feature | Sandbox | Tested | Maintained | Archived

| *Deploys on fresh OpenShift without modification*
| ✓
| ✓
| ✓
| -

| *Useful without private/closed source apps*
| ✓
| ✓
| ✓
| -

| *Open contribution and collaboration*
| ✓
| ✓
| ✓
| -

| *Documented support policy*
| ✓
| ✓
| ✓
| -

| *README with problem statement*
| ✓
| ✓
| ✓
| ✓

| *Includes architecture diagram*
| ✓
| ✓
| ✓
| ✓

| *Business use case with demo*
| -
| ✓
| ✓
| -

| *Standardized architecture diagram and written guide*
| -
| ✓
| ✓
| -

| *Test plan passes at least once per quarter*
| -
| ✓
| ✓
| -

| *Tested on at least 1 supported OCP version*
| -
| ✓
| ✓
| -

| *Publicly visible test results (JSON)*
| -
| ✓
| ✓
| -

| *Implementation review*
| -
| ✓
| ✓
| -

| *Automated CI pipeline (every change or weekly)*
| -
| -
| ✓
| -

| *Tested on 2 latest EUS and active interim versions*
| -
| -
| ✓
| -

| *Tested on pre-release bits*
| -
| -
| ✓
| -

| *Timely fixes for breakage*
| -
| -
| ✓
| -

| *No Tech Preview or feature-gated features*
| -
| -
| ✓
| -

| *Includes only supported services and components*
| -
| -
| ✓
| -

| *Repository archived; docs kept for reference*
| -
| -
| -
| ✓
|===
3 changes: 1 addition & 2 deletions content/patterns/medical-diagnosis/_index.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Medical Diagnosis
date: 2021-01-19
tier: maintained
tier: archived
summary: This pattern is based on a demo implementation of an automated data pipeline for chest X-ray analysis previously developed by Red Hat.
rh_products:
- Red Hat OpenShift Container Platform
Expand All @@ -22,7 +22,6 @@ links:
arch: https://www.redhat.com/architect/portfolio/detail/6-enabling-medical-imaging-diagnostics-with-edge
bugs: https://github.com/validatedpatterns/medical-diagnosis/issues
feedback: https://docs.google.com/forms/d/e/1FAIpQLScI76b6tD1WyPu2-d_9CCVDr3Fu5jYERthqLKJDUGwqBg7Vcg/viewform
ci: medicaldiag
---
include::modules/comm-attributes.adoc[]
:_content-type: ASSEMBLY
Expand Down
6 changes: 6 additions & 0 deletions content/workshop/tiers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ a| * functional on all currently supported/extended update support (EUS) version
* must document their support policy
| link:/contribute/maintained/[Details]

|**Archived**
a| * pattern repository has been archived on GitHub
* the pattern is no longer under active development or maintenance
* documentation remains available for reference
| link:/contribute/archived/[Details]

|===

== Additional Resources
Expand Down
5 changes: 0 additions & 5 deletions layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,6 @@ <h3 class="pf-c-title pf-m-lg pf-u-mb-sm pf-u-color-danger-200">
→ MLOps fraud detection
</a>
</div>
<div class="pf-l-stack__item">
<a href="/patterns/medical-diagnosis/" target="_blank" class="pf-u-color-dark-100 pf-u-font-weight-bold" style="text-decoration: none;">
→ Medical diagnosis
</a>
</div>
</div>
</div>
</div>
Expand Down
23 changes: 23 additions & 0 deletions layouts/partials/archived-banner.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{{/*
Banner shown on all pages belonging to an archived pattern.
*/}}
{{ $tier := "" }}
{{ if isset .Params "tier" }}
{{ $tier = .Params.tier }}
{{ else if and .CurrentSection (isset .CurrentSection.Params "tier") }}
{{ $tier = .CurrentSection.Params.tier }}
{{ end }}
{{ if eq $tier "archived" }}
<div class="archived-pattern-banner" role="status">
<div class="archived-pattern-banner__inner">
<span class="pf-c-label pf-m-grey archived-pattern-banner__label">
<span class="pf-c-label__content">Archived</span>
</span>
<span class="archived-pattern-banner__text">
This pattern is archived. The source repository is no longer maintained,
and Validated Patterns maintainers do not recommend deploying it for new use cases.
Documentation remains available for reference.
</span>
</div>
</div>
{{ end }}
6 changes: 6 additions & 0 deletions layouts/partials/label-archived.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<span class="pf-c-label pf-m-grey">
<span class="pf-c-label__content">
<img src="/images/pattern-tier-archived.png" alt="Archived" width="16" height="16" class="custom-pattern-icon"/>
Archived
</span>
</span>
4 changes: 4 additions & 0 deletions layouts/partials/links.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@
<i class="fa-sharp fa-regular fa-download"></i>
</span>
</span>
{{ if eq (.Param "tier") "archived" }}
<span class="pf-u-color-200" aria-disabled="true" title="Install is unavailable for archived patterns">Install</span>
{{ else }}
<a href="{{ .Params.links.install }}" class="">Install</a>
{{ end }}
</li>
{{ end }}
{{ if (isset .Params.links "arch") }}
Expand Down
13 changes: 11 additions & 2 deletions layouts/partials/patterns-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,14 @@
{{ partial "page-toolbar.html" . }}
<div class="pf-u-display-flex">
{{ partial "toc.html" . }}
<div class="pf-c-content">
{{ $archivedTier := "" }}
{{ if isset .Params "tier" }}
{{ $archivedTier = .Params.tier }}
{{ else if and .CurrentSection (isset .CurrentSection.Params "tier") }}
{{ $archivedTier = .CurrentSection.Params.tier }}
{{ end }}
<div class="pf-c-content{{ if eq $archivedTier "archived" }} pattern-page-archived{{ end }}">
{{ partial "archived-banner.html" . }}
<div class="pf-c-panel">
<div class="pf-c-panel__main">
<div class="pf-c-panel__main-body">
Expand Down Expand Up @@ -82,12 +89,14 @@ <h1 class="pf-c-title pf-m-4xl pf-u-mt-0">{{ .Title }}</h1>
{{ partial "label-maintained.html" . }}
{{ else if (eq $validated "tested" ) }}
{{ partial "label-tested.html" . }}
{{ else if (eq $validated "archived" ) }}
{{ partial "label-archived.html" . }}
{{ else }}
{{ partial "label-sandbox.html" . }}
{{ end }}
</div>

{{ if (isset .Params "ci") }}
{{ if and (isset .Params "ci") (ne (.Param "tier") "archived") }}
<div class="pf-u-mb-md">
{{ partial "ci.html" . }}
</div>
Expand Down
3 changes: 2 additions & 1 deletion layouts/patterns/list.json.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@
{{- $tiers_list := slice -}}
{{- $tiers_list = $tiers_list | append (dict "Name" "maintained" "LinkTitle" "Maintained" "color" "green") }}
{{- $tiers_list = $tiers_list | append (dict "Name" "tested" "LinkTitle" "Tested" "color" "blue") }}
{{- $tiers_list = $tiers_list | append (dict "Name" "sandbox" "LinkTitle" "Sandbox" "color" "oragne") }}
{{- $tiers_list = $tiers_list | append (dict "Name" "sandbox" "LinkTitle" "Sandbox" "color" "orange") }}
{{- $tiers_list = $tiers_list | append (dict "Name" "archived" "LinkTitle" "Archived" "color" "grey") }}
{{- $tiers_filter_types := slice "OR" }}
{{- $tiers_dict := dict "filter_list" $tiers_list "filter_types" $tiers_filter_types }}

Expand Down
Loading