Skip to content

Commit b39d984

Browse files
committed
Some changes based on the discussion with SME and CS
1 parent 4853d4b commit b39d984

File tree

5 files changed

+24
-27
lines changed

5 files changed

+24
-27
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ aliases: /learn/about-pattern-tiers-types
1212
:_content-type: ASSEMBLY
1313
include::modules/comm-attributes.adoc[]
1414

15-
[id="pattern-type"]
16-
== About the {solution-name-upstream} tiers
15+
[id="pattern-tiers"]
16+
== {solution-name-upstream} tiers
1717

1818
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.
1919

@@ -27,8 +27,8 @@ The patterns in this tier might be in a work-in-progress state; and they might h
2727

2828

2929
|link:/requirements/tested/[{tested-tier-first}]
30-
|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).
31-
//Additional work such as?
30+
|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).
31+
3232
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.
3333

3434
|link:/requirements/maintained/[{maintained-tier-first}]

content/learn/implementation.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ These are optional or desirable features, but their absence does not hinder the
3333
. Patterns must be useful without all content stored in private Git repositories.
3434
. Patterns must include a list of names and versions of all the products and projects that the pattern consumes.
3535
. Patterns must be useful without any sample applications that are private or that lack public sources.
36-
//AI:why application was styled that way
37-
Patterns must *not* become useless due to bit rot or opaque incompatibilities in closed source applications.
36+
37+
. Patterns must *not* become useless due to bit rot or opaque incompatibilities in closed source applications.
3838
. Patterns must *not* store sensitive data elements, including but not limited to, passwords in Git repositories.
3939
. Patterns must be possible to deploy on any installer-provisioned infrastructure OpenShift cluster (BYO).
40-
//AI:why Patterns and Managed clusters is styled that way
41-
We distinguish between the provisioning and configuration requirements of the initial cluster (`Patterns`) and of clusters or machines that are managed by the initial cluster (see `Managed clusters`).
40+
+
41+
We distinguish between the provisioning and configuration requirements of the initial cluster (`Patterns`) and of clusters or machines that are managed by the initial cluster (`Managed clusters`).
4242
. Patterns must use a standardized https://github.com/validatedpatterns/common/tree/main/clustergroup[clustergroup] Helm chart as the initial {rh-gitops} application that describes all namespaces, subscriptions, and any other GitOps applications which contain the configuration elements that make up the solution.
4343
. Managed clusters must operate on the premise of `eventual consistency` (automatic retries, and an expectation of idempotence), which is one of the essential benefits of the GitOps model.
4444
. Imperative elements must be implemented as idempotent code stored in Git repository.
@@ -78,6 +78,6 @@ For example, Bucket Notification is a capability in the {med-pattern} that could
7878
. Patterns can consume Operators from established partners (for example, Hashicorp Vault, and Seldon)
7979
. Patterns can include managed clusters.
8080
. Patterns can include details or automation for provisioning managed clusters, or rely on the admin to pre-provision them out-of-band.
81-
//AI:why initial hub clusters was styled that way.
82-
. Patterns can also choose to model multi-cluster solutions as an uncoordinated collection of `initial hub clusters`
81+
82+
. Patterns can also choose to model multi-cluster solutions as an uncoordinated collection of initial hub clusters.
8383
. Imperative elements can interact with cluster state or external influences.

content/learn/maintained.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,23 @@ include::modules/comm-attributes.adoc[]
1818

1919
A pattern categorized under the {maintained} tier implies that the pattern was known to be 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 sufficiently motivated subject matter expert (SME).
2020

21-
[id="nominating-a-community-pattern-to-become-validated"]
22-
== Nominating a maintained pattern for promotion to a validated pattern
21+
[id="nominating-a-pattern-for-maintained-tier"]
22+
== Nominating a pattern for the {maintained} tier
2323

24-
If your {maintained} pattern qualifies or meets the criteria for promotion to a {validated} pattern, submit your nomination to mailto:validatedpatterns@googlegroups.com[validatedpatterns@googlegroups.com].
24+
If your pattern qualifies or meets the criteria for {maintained} tier, submit your nomination to mailto:validatedpatterns@googlegroups.com[validatedpatterns@googlegroups.com].
2525

2626
[NOTE]
2727
====
2828
Each {maintained} pattern represents an ongoing maintenance, support, and testing effort. Finite team capacity means that it is not possible for the team to take on this responsibility for all {solution-name-upstream}.
2929
====
30-
//NOte sure about the following bits - needs discussion
30+
3131
For this reason we have designed the tiers and our processes to facilitate this to occur outside of the team by any sufficiently motivated party, including other parts of Red Hat, partners, and even customers.
3232

3333
In limited cases, the {solution-name-upstream} team may consider taking on that work, however, it is recommended that you contact the team at least 4 weeks prior to the end of a given quarter for the necessary work to be considered as part of the following quarter's planning process.
3434

3535

3636
[id="requirements-maintained-tier"]
37-
== Requirements
37+
== Requirements for the {maintained} tier
3838

3939
The {maintained} patterns have deliverable and requirements in addition to those
4040
specified for the link:/requirements/tested/[Tested tier].
@@ -54,12 +54,12 @@ A {maintained} pattern must continue to meet the following criteria to remain in
5454
* A {maintained} pattern must fix breakage in timely manner.
5555
* A {maintained} pattern must document their support policy.
5656
+
57-
//Needs review by legal?
57+
5858
The individual products used in a {solution-name-upstream} are backed by the full {redhat} support experience conditional on the customer's subscription to those products, and the individual products`s support policy.
5959
+
6060
Additional components in a {solution-name-upstream} that are not supported by {redhat}; for example, Hashicorp Vault, and Seldon Core, require a customer to obtain support from that vendor directly.
6161
+
62-
//very motivated? will we or won't we?
62+
6363
The {solution-name-upstream} team is will try to address any problems in the {validated-patterns-op}, and in the common Helm charts, but cannot not offer any SLAs at this time.
6464
+
6565
//TODO: Create an aDoc version of our support statement slide

content/learn/sandbox.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ include::modules/comm-attributes.adoc[]
1818

1919
A pattern categorized under the {sandbox} tier provides you with an entry point to onboard to the {solution-name-upstream}. The minimum requirement to qualify for the {sandbox} tier is that you must start with the patterns framework and include minimal documentation.
2020

21-
[id="onboarding-existing-implementations"]
22-
== Onboarding existing implementations
21+
[id="nominating-a-pattern-for-sandbox-tier"]
22+
== Nominating a pattern for the {sandbox} tier
2323

2424
//TODO: A short note on the value of converting existing implementations
2525

@@ -33,7 +33,6 @@ In both scenarios the originating team can choose where to host the primary repo
3333

3434
[id="requirements-sandbox-tier"]
3535
== Requirements for the {sandbox} tier
36-
// should this be sandbox tier?
3736
Consider these requirements for all {sandbox} tier.
3837

3938
[id="must-sandbox-tier"]

content/learn/tested.adoc

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ include::modules/comm-attributes.adoc[]
1717

1818
The {tested} tier provides you with additional collateral and reassurance that the pattern was known to be recently working on at least one recent version of {rh-ocp}. Inclusion in this tier requires some additional work for the pattern's owner - which might be a partner or a sufficiently motivated subject matter expert (SME).
1919

20-
[id="nominating-a-community-pattern-to-become-maintained"]
21-
== Nominating a tested pattern for promotion to a maintained pattern
20+
[id="nominating-a-pattern-for-tested-tier"]
21+
== Nominating a a pattern for the {tested} tier
2222

23-
If your {tested} pattern qualifies or meets the criteria for promotion to a {validated} pattern, submit your nomination to mailto:validatedpatterns@googlegroups.com[validatedpatterns@googlegroups.com].
23+
If your pattern qualifies or meets the criteria for {tested} tier, submit your nomination to mailto:validatedpatterns@googlegroups.com[validatedpatterns@googlegroups.com].
2424

2525
[NOTE]
2626
====
@@ -45,11 +45,9 @@ A {tested} pattern must continue to meet the following criteria to remain in the
4545
* A {tested} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements]
4646
* A {tested} pattern must be meaningful without specialized hardware, including flavors of architectures not explicitly supported.
4747
+
48-
Qualification is a {solution-name-upstream} TOC decision with input from the pattern owner.
49-
//AI: What's TOC?
48+
Qualification is a {solution-name-upstream} Technical Oversight Committee (TOC) decision with input from the pattern owner.
5049
* A {tested} pattern must have their implementation reviewed by the patterns team to ensure that it is sufficiently flexible to function across a variety of platforms, customer environments, and any relevant verticals.
51-
* A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the PAC tooling
52-
//AI: What's PAC
50+
* A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the standard {solution-name-upstream} tooling
5351
* A {tested} pattern must include a written guide for others to follow when demonstrating the pattern
5452
* A {tested} pattern must include a test plan covering all features or attributes being highlighted by the demonstration guide. Negative flow tests (such as resiliency or data retention in the presence of network outages) are also limited to scenarios covered by the demonstration guide.
5553
+

0 commit comments

Comments
 (0)