-
Notifications
You must be signed in to change notification settings - Fork 64
New Validated Patterns tiers #352
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
e424402
Start renaming pattern tiers, create a tested tier
beekhof 70f7432
Refresh the tier requirements to facilitate external parties and esta…
beekhof aad4676
Minor formatting fixes
beekhof 67c8fe3
Fix links
beekhof ab10e86
Update for the renamed google group
beekhof e15eee7
Document the json test artefacts
beekhof 42f8bee
Validated Patterns tier naming updates - building on Andrew's PR319
abhatt-rh 21b0bb5
included coomon attr files and bringing in the overview file from my …
abhatt-rh 8e9b877
adjusted frontmatter weight for each file under the Workflow section
abhatt-rh 50d315a
attribute chnages reverting the must-should conundrum to original
abhatt-rh d8ee420
added definition for must,should,cam after reiterating abstract sever…
abhatt-rh ea63090
Cleanup, rewrite, unordered list, use attributes
abhatt-rh 4853d4b
more clean up of mixed up pattern names, language, added comments abo…
abhatt-rh b39d984
Some changes based on the discussion with SME and CS
abhatt-rh ebd92a7
Addressed Dan's feedback
abhatt-rh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,4 +15,5 @@ Gemfile.lock | |
| .vscode | ||
| .idea | ||
| .vale | ||
| modules/.vale.ini | ||
| modules/.vale.ini | ||
| .vale.ini | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| menu: | ||
| learn: | ||
| parent: Workflow | ||
| title: Validated Pattern tiers | ||
| weight: 41 | ||
| --- | ||
|
|
||
| :toc: | ||
|
|
||
| :_content-type: ASSEMBLY | ||
| include::modules/comm-attributes.adoc[] | ||
|
|
||
| [id="pattern-tiers"] | ||
| == {solution-name-upstream} tiers | ||
|
|
||
| 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. | ||
|
|
||
| |=== | ||
| |Pattern tier|Description | ||
|
|
||
| |link:/requirements/sandbox/[{sandbox-tier-first}] | ||
| |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. | ||
|
|
||
| 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. | ||
|
|
||
|
|
||
| |link:/requirements/tested/[{tested-tier-first}] | ||
| |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). | ||
|
|
||
| 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. | ||
|
|
||
| |link:/requirements/maintained/[{maintained-tier-first}] | ||
| |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. | ||
|
|
||
| The patterns in this tier might have a formal release process with patch releases. They might have continuous integration (CI) automation testing. | ||
|
|
||
| |=== | ||
|
|
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| menu: | ||
| learn: | ||
| parent: Workflow | ||
| title: Validated Patterns - Maintained tier | ||
| weight: 45 | ||
| aliases: /requirements/maintained/ | ||
| aliases: /requirements/validated/ | ||
| --- | ||
|
|
||
| :toc: | ||
|
|
||
| :_content-type: ASSEMBLY | ||
| include::modules/comm-attributes.adoc[] | ||
|
|
||
| [id="about-maintained-tier"] | ||
| = About the {maintained-tier-first} | ||
|
|
||
| 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). | ||
|
|
||
| [id="nominating-a-pattern-for-maintained-tier"] | ||
| == Nominating a pattern for the {maintained} tier | ||
|
|
||
| If your pattern qualifies or meets the criteria for {maintained} tier, submit your nomination to mailto:validatedpatterns@googlegroups.com[validatedpatterns@googlegroups.com]. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| 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}. | ||
| ==== | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
|
|
||
| [id="requirements-maintained-tier"] | ||
| == Requirements for the {maintained} tier | ||
|
|
||
| The {maintained} patterns have deliverable and requirements in addition to those | ||
| specified for the link:/requirements/tested/[Tested tier]. | ||
|
|
||
| The requirements are categorized as follows: | ||
|
|
||
| Must:: | ||
| These are nonnegotiable, core requirements that must be implemented. | ||
| Should:: | ||
| These are important but not critical; their implementation enhances the pattern. | ||
| Can:: | ||
| These are optional or desirable features, but their absence does not hinder the implementation of a pattern. | ||
|
|
||
| [id="must-maintained-tier"] | ||
| === Must | ||
|
|
||
| A {maintained} pattern must continue to meet the following criteria to remain in {maintained} tier: | ||
|
|
||
| * A {maintained} pattern must conform to the common technical link:/requirements/implementation/[implementation requirements]. | ||
| * 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. | ||
| * A {maintained} pattern must *not* rely on functionality in tech-preview, or hidden behind feature gates. | ||
| * 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. | ||
| * 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. | ||
| * 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. | ||
| * A {maintained} pattern must be tested on all currently supported {rh-ocp} extended update support (EUS) releases. | ||
| * A {maintained} pattern must fix breakage in timely manner. | ||
| * A {maintained} pattern must document their support policy. | ||
| + | ||
|
|
||
| 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. | ||
| + | ||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| //TODO: Create an aDoc version of our support statement slide | ||
abhatt-rh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [NOTE] | ||
| ==== | ||
| The {maintained} patterns *do not* imply an obligation of support for partner or community Operators by {redhat}. | ||
| ==== | ||
|
|
||
| [id="can-maintained-tier"] | ||
| === Can | ||
|
|
||
| * If you are creating {solution-name-upstream}, you can provide your own SLA. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this + necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, all the list continuation (+) here are required because they are a continuation on the support policy and statement.