Skip to content

Commit d88ea3b

Browse files
abhatt-rhabhatt-rh
authored
Merge pull request #352 from abhatt-rh/pr-319
New Validated Patterns tiers
2 parents cf6cdf5 + ebd92a7 commit d88ea3b

12 files changed

+1021
-223
lines changed

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ Gemfile.lock
1515
.vscode
1616
.idea
1717
.vale
18-
modules/.vale.ini
18+
modules/.vale.ini
19+
.vale.ini

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
menu:
3+
learn:
4+
parent: Workflow
5+
title: Validated Pattern tiers
6+
weight: 41
7+
---
8+
9+
:toc:
10+
11+
:_content-type: ASSEMBLY
12+
include::modules/comm-attributes.adoc[]
13+
14+
[id="pattern-tiers"]
15+
== {solution-name-upstream} tiers
16+
17+
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+
19+
|===
20+
|Pattern tier|Description
21+
22+
|link:/requirements/sandbox/[{sandbox-tier-first}]
23+
|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.
24+
25+
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.
26+
27+
28+
|link:/requirements/tested/[{tested-tier-first}]
29+
|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).
30+
31+
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.
32+
33+
|link:/requirements/maintained/[{maintained-tier-first}]
34+
|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.
35+
36+
The patterns in this tier might have a formal release process with patch releases. They might have continuous integration (CI) automation testing.
37+
38+
|===
39+

‎content/learn/community.adoc‎

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎content/learn/implementation.adoc‎

Lines changed: 55 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,73 +2,78 @@
22
menu:
33
learn:
44
parent: Workflow
5-
title: Implementation Requirements
6-
weight: 41
5+
title: Implementation requirements
6+
weight: 42
77
aliases: /requirements/implementation/
88
---
99

1010
:toc:
1111

12+
:_content-type: ASSEMBLY
13+
include::modules/comm-attributes.adoc[]
14+
1215
[id="technical-requirements"]
13-
== Technical Requirements
16+
== Technical requirements
1417

15-
Additional requirements specific to the implementation for all Community, and Validated patterns
18+
Consider these requirements specific to the implementation of all {solution-name-upstream} and their tiers.
1619

17-
[id="must"]
18-
=== Must
20+
The requirements are categorized as follows:
1921

20-
. Patterns *MUST* include one or more Git repositories, in a publicly accessible location, containing configuration elements that can be consumed by the OpenShift GitOps operator (ArgoCD) without supplying custom ArgoCD images.
21-
. Patterns *MUST* be useful without all content stored in private git repos
22-
. Patterns *MUST* include a list of names and versions of all the products and projects being consumed by the pattern
23-
. Patterns *MUST* be useful without any sample applications that are private or lack public sources.
24-
+
25-
Patterns must not become useless due to bit rot or opaque incompatibilities in closed source "`applications`".
22+
Must::
23+
These are nonnegotiable, core requirements that must be implemented.
24+
Should::
25+
These are important but not critical; their implementation enhances the pattern.
26+
Can::
27+
These are optional or desirable features, but their absence does not hinder the implementation of a pattern.
2628

27-
. Patterns *MUST NOT* store sensitive data elements, including but not limited to passwords, in Git
28-
. Patterns *MUST* be possible to deploy on any IPI-based OpenShift cluster (BYO)
29-
+
30-
We distinguish between the provisioning and configuration requirements of the initial cluster ("`Patterns`"), and of clusters/machines managed by the initial cluster (see "`Managed clusters`")
29+
[id="must-implementation-requirements"]
30+
=== Must
3131

32-
. Patterns *MUST* use a standardized https://github.com/validatedpatterns/common/tree/main/clustergroup[clustergroup] Helm chart, as the initial OpenShift GitOps application that describes all namespaces, subscriptions, and any other GitOps applications which contain the configuration elements that make up the solution.
33-
. 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.
34-
. Imperative elements *MUST* be implemented as idempotent code stored in Git
32+
. Patterns must include one or more Git repositories in a publicly accessible location, containing configuration elements that can be consumed by the {rh-gitops} Operator without supplying custom Argo CD images.
33+
. Patterns must be useful without all content stored in private Git repositories.
34+
. Patterns must include a list of names and versions of all the products and projects that the pattern consumes.
35+
. Patterns must be useful without any sample applications that are private or that lack public sources.
36+
. Patterns must *not* degrade due to lack of updates or opaque incompatibilities in closed source applications.
37+
. Patterns must *not* store sensitive data elements including, but not limited to, passwords in Git repositories.
38+
. Patterns must be possible to deploy on any installer-provisioned infrastructure OpenShift cluster (BYO).
39+
+
40+
{solution-name-upstream} 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`).
41+
. 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.
42+
. 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.
43+
. Imperative elements must be implemented as idempotent code stored in Git repository.
3544

36-
[id="should"]
45+
[id="should-implementation-requirements"]
3746
=== Should
3847

39-
. Patterns SHOULD include sample application(s) to demonstrate the business problem(s) addressed by the pattern.
40-
. Patterns SHOULD try to indicate which parts are foundational as opposed to being for demonstration purposes.
41-
. Patterns SHOULD use the VP operator to deploy patterns. However anything that creates the OpenShift GitOps subscription and initial clustergroup application could be acceptable.
42-
. Patterns SHOULD embody the "`open hybrid cloud model`" unless there is a compelling reason to limit the availability of functionality to a specific platform or topology.
43-
. Patterns SHOULD use industry standards and Red Hat products for all required tooling
48+
. Patterns should include sample applications to demonstrate the business problems addressed by the pattern.
49+
. Patterns should try to indicate which parts are foundational as opposed to being for demonstration purposes.
50+
. Patterns should use the {validated-patterns-op} to deploy patterns. However, anything that creates the {rh-gitops-short} subscription and initial clustergroup application could be acceptable.
51+
. Patterns should embody the link:https://www.redhat.com/en/products/open-hybrid-cloud[Open Hybrid Cloud model] unless there is a compelling reason to limit the availability of functionality to a specific platform or topology.
52+
. Patterns should use industry standards and {redhat} products for all required tooling.
4453
+
45-
Patterns prefer current best practices at the time of pattern development. Solutions that do not conform to best practices should expect to justify non-conformance and/or expend engineering effort to conform.
46-
47-
. Patterns SHOULD NOT make use of upstream/community operators and images except, depending on the market segment, where critical to the overall solution.
54+
Patterns require current best practices at the time of pattern development. Solutions that do not conform to best practices should expect to justify non-conformance or expend engineering effort to conform.
55+
. Patterns should *not* make use of upstream or community Operators and images except, depending on the market segment, where it is critical to the overall solution.
4856
+
49-
Such operators are forbidden to be deployed into an increasing number of customer environments, which limits reuse.
50-
Alternatives include productizing the operator, and building it in-cluster from trusted sources as part of the pattern.
51-
52-
. Patterns SHOULD be decomposed into modules that perform a specific function, so that they can be reused in other patterns.
57+
Such Operators are forbidden to be deployed into an increasing number of customer environments, which limits the pattern reuse. Alternatively, consider to productize the Operator, and build it in-cluster from trusted sources as part of the pattern.
58+
. Patterns should be decomposed into modules that perform a specific function, so that they can be reused in other patterns.
5359
+
54-
For example, Bucket Notification is a capability in the Medical Diagnosis pattern that could be used for other solutions.
55-
56-
. Patterns SHOULD use Ansible Automation Platform to drive the declarative provisioning and management of managed hosts (e.g. RHEL). See also "`Imperative elements`".
57-
. Patterns SHOULD use RHACM to manage policy and compliance on any managed clusters.
58-
. Patterns SHOULD use RHACM and a https://github.com/validatedpatterns/common/tree/main/acm[standardized acm chart] to deploy and configure OpenShift GitOps to managed clusters.
59-
. Managed clusters SHOULD be loosely coupled to their hub, and use OpenShift GitOps to consume applications and configuration directly from Git as opposed to having hard dependencies on a centralized cluster.
60-
. Managed clusters SHOULD use the "`pull`" deployment model for obtaining their configuration.
61-
. Imperative elements SHOULD be implemented as Ansible playbooks
62-
. Imperative elements SHOULD be driven declaratively -- by which we mean that the playbooks should be triggered by Jobs and/or CronJobs stored in Git and delivered by OpenShift GitOps.
60+
For example, Bucket Notification is a capability in the {med-pattern} that could be used for other solutions.
61+
. Patterns should use {rh-ansible} to drive the declarative provisioning and management of managed hosts, for example, {rhel-first}. See also `Imperative elements`.
62+
. Patterns should use {rh-rhacm-first} to manage policy and compliance on any managed clusters.
63+
. Patterns should use {rh-rhacm} and a https://github.com/validatedpatterns/common/tree/main/acm[standardized RHACM chart] to deploy and configure {rh-gitops-short} to managed clusters.
64+
. Managed clusters should be loosely coupled to their hub, and use {rh-gitops-short} to consume applications and configuration directly from Git as opposed to having hard dependencies on a centralized cluster.
65+
. Managed clusters should use the `pull` deployment model for obtaining their configuration.
66+
. Imperative elements should be implemented as Ansible playbooks.
67+
. Imperative elements should be driven declaratively implying that the playbooks should be triggered by Jobs or CronJobs stored in Git and delivered by {rh-gitops-short}.
6368

64-
[id="can"]
69+
[id="can-implementation-requirements"]
6570
=== Can
6671

67-
. Patterns CAN include additional configuration and/or demo elements located in one or more additional private git repos.
68-
. Patterns CAN include automation that deploys a known set of clusters and/or machines in a specific topology
69-
. Patterns CAN limit functionality/testing claims to specific platforms, topologies, and cluster/node sizes
70-
. Patterns CAN consume operators from established partners (e.g. Hashicorp Vault, and Seldon)
71-
. Patterns CAN include managed clusters
72-
. Patterns CAN include details or automation for provisioning managed clusters, or rely on the admin to pre-provision them out-of-band.
73-
. Patterns CAN also choose to model multi-cluster solutions as an uncoordinated collection of "`initial hub clusters`"
74-
. Imperative elements CAN interact with cluster state and/or external influences
72+
. Patterns can include additional configuration and/or demo elements located in one or more additional private Git repositories.
73+
. Patterns can include automation that deploys a known set of clusters and/or machines in a specific topology.
74+
. Patterns can limit functionality/testing claims to specific platforms, topologies, and cluster/node sizes.
75+
. Patterns can consume Operators from established partners (for example, Hashicorp Vault, and Seldon)
76+
. Patterns can include managed clusters.
77+
. Patterns can include details or automation for provisioning managed clusters, or rely on the admin to pre-provision them out-of-band.
78+
. Patterns can also choose to model multi-cluster solutions as an uncoordinated collection of initial hub clusters.
79+
. Imperative elements can interact with cluster state or external influences.

‎content/learn/maintained.adoc‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
menu:
3+
learn:
4+
parent: Workflow
5+
title: Validated Patterns - Maintained tier
6+
weight: 45
7+
aliases: /requirements/maintained/
8+
aliases: /requirements/validated/
9+
---
10+
11+
:toc:
12+
13+
:_content-type: ASSEMBLY
14+
include::modules/comm-attributes.adoc[]
15+
16+
[id="about-maintained-tier"]
17+
= About the {maintained-tier-first}
18+
19+
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).
20+
21+
[id="nominating-a-pattern-for-maintained-tier"]
22+
== Nominating a pattern for the {maintained} tier
23+
24+
If your pattern qualifies or meets the criteria for {maintained} tier, submit your nomination to mailto:validatedpatterns@googlegroups.com[validatedpatterns@googlegroups.com].
25+
26+
[NOTE]
27+
====
28+
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}.
29+
====
30+
31+
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.
32+
33+
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.
34+
35+
36+
[id="requirements-maintained-tier"]
37+
== Requirements for the {maintained} tier
38+
39+
The {maintained} patterns have deliverable and requirements in addition to those
40+
specified for the link:/requirements/tested/[Tested tier].
41+
42+
The requirements are categorized as follows:
43+
44+
Must::
45+
These are nonnegotiable, core requirements that must be implemented.
46+
Should::
47+
These are important but not critical; their implementation enhances the pattern.
48+
Can::
49+
These are optional or desirable features, but their absence does not hinder the implementation of a pattern.
50+
51+
[id="must-maintained-tier"]
52+
=== Must
53+
54+
A {maintained} pattern must continue to meet the following criteria to remain in {maintained} tier:
55+
56+
* A {maintained} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements].
57+
* A {maintained} pattern must only make use of components that are either supported, or easily substituted for supportable equivalents, for example, HashiCorp vault which has community and enterprise variants.
58+
* A {maintained} pattern must *not* rely on functionality in tech-preview, or hidden behind feature gates.
59+
* A {maintained} pattern must have their architectures reviewed by the Product Manager (PM), Technical Product Manager (TPM), or Technical Marketing Manager (TMM) of each {redhat} product they consume to ensure consistency with the product teams` intentions and roadmaps.
60+
* A {maintained} pattern must include a presentation slides oriented around the business problem being solved and intended for use by the field to sell and promote the solution.
61+
* A {maintained} pattern must include test plan automation that runs on every change to the pattern, or a schedule no less frequently than once per week.
62+
* A {maintained} pattern must be tested on all currently supported {rh-ocp} extended update support (EUS) releases.
63+
* A {maintained} pattern must fix breakage in timely manner.
64+
* A {maintained} pattern must document their support policy.
65+
+
66+
67+
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.
68+
+
69+
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.
70+
71+
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.
72+
73+
//TODO: Create an aDoc version of our support statement slide
74+
75+
[NOTE]
76+
====
77+
The {maintained} patterns *do not* imply an obligation of support for partner or community Operators by {redhat}.
78+
====
79+
80+
[id="can-maintained-tier"]
81+
=== Can
82+
83+
* If you are creating {solution-name-upstream}, you can provide your own SLA.

0 commit comments

Comments
 (0)