You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|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.
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.
25
24
26
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.
27
26
28
27
29
28
|link:/requirements/tested/[{tested-tier-first}]
30
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).
31
30
32
-
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.
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.
|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.
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.
36
35
37
36
The patterns in this tier might have a formal release process with patch releases. They might have continuous integration (CI) automation testing.
Consider these requirements specific to the implementation of all {solution-name-upstream} and their respective tiers.
18
+
Consider these requirements specific to the implementation of all {solution-name-upstream} and their tiers.
19
19
20
20
The requirements are categorized as follows:
21
21
22
22
Must::
23
-
These are non-negotiable, core requirements that must be implemented.
23
+
These are nonnegotiable, core requirements that must be implemented.
24
24
Should::
25
25
These are important but not critical; their implementation enhances the pattern.
26
26
Can::
27
-
These are optional or desirable features, but their absence does not hinder the implementation of a pattern.
27
+
These are optional or desirable features, but their absence does not hinder the implementation of a pattern.
28
28
29
29
[id="must-implementation-requirements"]
30
30
=== Must
@@ -33,12 +33,11 @@ These are optional or desirable features, but their absence does not hinder the
33
33
. Patterns must be useful without all content stored in private Git repositories.
34
34
. Patterns must include a list of names and versions of all the products and projects that the pattern consumes.
35
35
. Patterns must be useful without any sample applications that are private or that lack public sources.
36
-
37
-
. Patterns must *not* become useless due to bit rot or opaque incompatibilities in closed source applications.
38
-
. Patterns must *not* store sensitive data elements, including but not limited to, passwords in Git repositories.
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.
39
38
. Patterns must be possible to deploy on any installer-provisioned infrastructure OpenShift cluster (BYO).
40
39
+
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`).
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`).
42
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.
43
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.
44
43
. Imperative elements must be implemented as idempotent code stored in Git repository.
@@ -52,15 +51,13 @@ We distinguish between the provisioning and configuration requirements of the in
52
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.
53
52
. Patterns should use industry standards and {redhat} products for all required tooling.
54
53
+
55
-
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 or expend engineering effort to conform.
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.
56
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.
57
56
+
58
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.
59
-
60
58
. Patterns should be decomposed into modules that perform a specific function, so that they can be reused in other patterns.
61
59
+
62
60
For example, Bucket Notification is a capability in the {med-pattern} that could be used for other solutions.
63
-
64
61
. Patterns should use {rh-ansible} to drive the declarative provisioning and management of managed hosts, for example, {rhel-first}. See also `Imperative elements`.
65
62
. Patterns should use {rh-rhacm-first} to manage policy and compliance on any managed clusters.
66
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.
@@ -78,6 +75,5 @@ For example, Bucket Notification is a capability in the {med-pattern} that could
78
75
. Patterns can consume Operators from established partners (for example, Hashicorp Vault, and Seldon)
79
76
. Patterns can include managed clusters.
80
77
. Patterns can include details or automation for provisioning managed clusters, or rely on the admin to pre-provision them out-of-band.
81
-
82
78
. Patterns can also choose to model multi-cluster solutions as an uncoordinated collection of initial hub clusters.
83
79
. Imperative elements can interact with cluster state or external influences.
Copy file name to clipboardExpand all lines: content/learn/maintained.adoc
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,13 +39,22 @@ In limited cases, the {solution-name-upstream} team may consider taking on that
39
39
The {maintained} patterns have deliverable and requirements in addition to those
40
40
specified for the link:/requirements/tested/[Tested tier].
41
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
+
42
51
[id="must-maintained-tier"]
43
52
=== Must
44
53
45
54
A {maintained} pattern must continue to meet the following criteria to remain in {maintained} tier:
46
55
47
56
* A {maintained} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements].
48
-
. 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.
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.
49
58
* A {maintained} pattern must *not* rely on functionality in tech-preview, or hidden behind feature gates.
50
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.
51
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.
@@ -58,10 +67,9 @@ A {maintained} pattern must continue to meet the following criteria to remain in
58
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.
59
68
+
60
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.
61
-
+
62
70
63
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.
64
-
+
72
+
65
73
//TODO: Create an aDoc version of our support statement slide
66
74
67
75
[NOTE]
@@ -72,4 +80,4 @@ The {maintained} patterns *do not* imply an obligation of support for partner or
72
80
[id="can-maintained-tier"]
73
81
=== Can
74
82
75
-
. If you are creating {solution-name-upstream}, you can provide your own SLA.
83
+
* If you are creating {solution-name-upstream}, you can provide your own SLA.
Copy file name to clipboardExpand all lines: content/learn/sandbox.adoc
+12-5Lines changed: 12 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,6 +35,15 @@ In both scenarios the originating team can choose where to host the primary repo
35
35
== Requirements for the {sandbox} tier
36
36
Consider these requirements for all {sandbox} tier.
37
37
38
+
The requirements are categorized as follows:
39
+
40
+
Must::
41
+
These are nonnegotiable, core requirements that must be implemented.
42
+
Should::
43
+
These are important but not critical; their implementation enhances the pattern.
44
+
Can::
45
+
These are optional or desirable features, but their absence does not hinder the implementation of a pattern.
46
+
38
47
[id="must-sandbox-tier"]
39
48
=== Must
40
49
A {sandbox} pattern must continue to meet the following criteria to remain in the {sandbox} tier:
@@ -44,11 +53,9 @@ A {sandbox} pattern must continue to meet the following criteria to remain in th
44
53
* A {sandbox} pattern must include a top-level README file that highlights the business problem and how the pattern solves it.
45
54
* A {sandbox} pattern must include an architecture drawing. The specific tool or format is flexible as long as the meaning is clear.
46
55
* A {sandbox} pattern must undergo an informal technical review by a community leader to ensure that it meets basic reuse standards.
47
-
* A {sandbox} pattern must undergo an informal architecture review by a community leader to ensure that the solution has the right components, and they are generally being used as intended.
56
+
* A {sandbox} pattern must undergo an informal architecture review by a community leader to ensure that the solution has the right components, and they are generally being used as intended. For example, not using a database as a message bus.
48
57
+
49
-
For example, not using a database as a message bus.
50
-
As community leaders, contributions from within {redhat} might be subject to a higher level of scrutiny.
51
-
While we strive to be inclusive, the community will have quality standards and generally using the framework does not automatically imply a solution is suitable for the community to endorse/publish.
58
+
As community leaders, contributions from within {redhat} might be subject to a higher level of scrutiny. While we strive to be inclusive, the community will have quality standards and generally using the framework does not automatically imply a solution is suitable for the community to endorse/publish.
52
59
* A {sandbox} pattern must document their support policy.
53
60
54
61
[NOTE]
@@ -60,6 +67,6 @@ The {solution-name-upstream} team commits to maintaining the framework, but will
60
67
[id="can-sandbox-tier"]
61
68
=== Can
62
69
63
-
* A {sandbox} pattern (including works-in-progress) can be hosted in the link:https://github.com/validatedpatterns-sandbox[https://github.com/validatedpatterns-sandbox] GitHub organization
70
+
* A {sandbox} pattern (including works-in-progress) can be hosted in the link:https://github.com/validatedpatterns-sandbox[https://github.com/validatedpatterns-sandbox] GitHub organization.
64
71
* A {sandbox} pattern can be listed on the link:https://validatedpatterns.io[https://validatedpatterns.io] site.
65
72
* A {sandbox} pattern meeting additional criteria can be nominated for promotion to the link:/learn/tested/[Tested tier].
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).
18
+
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).
19
19
20
20
[id="nominating-a-pattern-for-tested-tier"]
21
21
== Nominating a a pattern for the {tested} tier
@@ -33,36 +33,45 @@ In limited cases, the {solution-name-upstream} team may consider taking on that
33
33
34
34
35
35
[id="requirements-tested-tier"]
36
-
== Requirements
36
+
== Requirements for the {tested} tier
37
37
38
38
A {tested} patterns have deliverable and requirements in addition to those specified for the link:/requirements/sandbox/[Sandbox tier].
39
39
40
+
The requirements are categorized as follows:
41
+
42
+
Must::
43
+
These are nonnegotiable, core requirements that must be implemented.
44
+
Should::
45
+
These are important but not critical; their implementation enhances the pattern.
46
+
Can::
47
+
These are optional or desirable features, but their absence does not hinder the implementation of a pattern.
48
+
40
49
[id="must-tested-tier"]
41
50
=== Must
42
51
43
52
A {tested} pattern must continue to meet the following criteria to remain in the {tested} tier:
44
53
45
-
* A {tested} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements]
54
+
* A {tested} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements].
46
55
* A {tested} pattern must be meaningful without specialized hardware, including flavors of architectures not explicitly supported.
47
56
+
48
57
Qualification is a {solution-name-upstream} Technical Oversight Committee (TOC) decision with input from the pattern owner.
49
58
* 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.
50
-
* A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the standard {solution-name-upstream} tooling
51
-
* A {tested} pattern must include a written guide for others to follow when demonstrating the pattern
59
+
* A {tested} pattern must include a standardized architecture drawing, created with (or at least conforming to) the standard {solution-name-upstream} tooling.
60
+
* A {tested} pattern must include a written guide for others to follow when demonstrating the pattern.
52
61
* 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.
53
62
+
54
63
The test plan must define how to validate if the pattern has been successfully deployed and is functionally operational.
55
-
Example: https://docs.google.com/document/d/12KQhdzjVIsxRURTnWAckiEMB3_96oWBjtlTXi1q73cg/view[Validating an Industrial Edge Deployment]
56
-
+
64
+
Example: https://docs.google.com/document/d/12KQhdzjVIsxRURTnWAckiEMB3_96oWBjtlTXi1q73cg/view[Validating an Industrial Edge Deployment].
65
+
57
66
//TODO: Convert above link to adoc
58
67
59
68
* A {tested} pattern must nominate at least one currently supported {rh-ocp} release to test against.
60
69
* A {tested} pattern must ensure the test plan passes at least once per quarter.
61
-
* A {tested} pattern must create a publicly available JSON file (eg. in an AWS bucket) that records the result of the latest test for each combination of pattern, platform, and {rh-ocp} version. See link:/learn/test-artefacts/[testing artefacts]
70
+
* A {tested} pattern must create a publicly available JSON file (for example, in an AWS bucket) that records the result of the latest test for each combination of pattern, platform, and {rh-ocp} version. See link:/learn/test-artefacts/[testing artefacts].
62
71
63
72
[NOTE]
64
73
====
65
-
The {tested} pattern *do not* imply an obligation of support for partner or community operators by Red Hat or the pattern owner.
74
+
A {tested} pattern *does not* imply an obligation of support for partner or community operators by Red Hat or the pattern owner.
66
75
====
67
76
68
77
[id="should-tested-tier"]
@@ -79,4 +88,4 @@ Teams creating {tested} pattern can provide their own service level agreement (S
79
88
A technical document for Quality Engineering (QE) team that defines how to validate if the pattern has been successfully deployed and is functionally operational.
80
89
For example, see https://docs.google.com/document/d/12KQhdzjVIsxRURTnWAckiEMB3_96oWBjtlTXi1q73cg/view[Validating an Industrial Edge Deployment].
81
90
82
-
* A {tested} pattern meeting additional criteria can be nominated for promotion to the link:/learn/maintained/[Maintained tier].
91
+
A {tested} pattern meeting additional criteria can be nominated for promotion to the link:/learn/maintained/[Maintained tier].
0 commit comments