Skip to content

Commit d9a90da

Browse files
authored
Merge pull request #272 from validatedpatterns/contribute-review-1
Contribute review 1
2 parents a7aad53 + 34568be commit d9a90da

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

content/contribute/creating-a-pattern.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ The validated patterns community has relied on existing architectures that have
1111

1212
The validated patterns framework is much more of a best practice of structuring the various configuration assets and integrating with GitOps and DevOps tools.
1313

14-
Therefore the question really is: how do I move my successful architecture solution into a sustainable GitOps/DevOps framework? And that is what we are going to do in this section.
14+
Therefore the question really is: how do I move my successful architecture solution into a sustainable GitOps/DevOps framework? And that is what we are going to address this section.
1515

16-
So how do you take a current application workload and move it to the Validated Pattern framework? One of the first things that you should do is look at your current implementation of your workload and identify the kubernetes manifests that are involved in order to run the workloads.
16+
So how do you take a current application workload and move it to the Validated Pattern framework? One of the first things that you should do is look at the current implementation of your workload and identify the kubernetes manifests that are involved in order to run the workloads.
1717

1818
## Prerequisites
1919

@@ -28,7 +28,7 @@ The validated patterns framework is much more of a best practice of structuring
2828
Therefore the question really is: How do I move my successful architecture solution into a sustainable GitOps/DevOps framework? And that is what we are going to do in this section.
2929

3030
## Requirements for creating a new pattern
31-
* The patterns framework requires some artifacts like OpenShift GitOps (ArgoCD) in order to provide the GitOps automation. All existing patterns use OpenShift GitOps as a starting point. The [multicloud-gitops pattern](/patterns/multicloud-gitops) is the most fundamental of patterns and therefore it is recommended to use it as a base pattern. I.e Create a new pattern based on it.
31+
* The patterns framework requires some artifacts like OpenShift GitOps (ArgoCD) in order to provide the GitOps automation. All existing patterns use OpenShift GitOps as a starting point. The [multicloud-gitops pattern](/patterns/multicloud-gitops) is the most fundamental of patterns and therefore it is recommended to use it as a base pattern; i.e create a new pattern based on it.
3232
* Create a new branch on your new pattern to perform the initial changes.
3333
* Deploy the initial new pattern pattern to the cluster.
3434

@@ -41,9 +41,9 @@ One of the first things that you should do is look at your current implementatio
4141
There are 4 values files that make up any Validated Pattern. The values files are:
4242

4343
* values-<main-hub>.yaml (e.g. values-datacenter.yaml)
44-
* values-<edge>.yaml (e.g. values-edge-site.yaml or values-factory.yaml)
45-
* values-global.yaml
46-
* values-secrets.yaml
44+
* values-<edge>.yaml (e.g. values-edge-site.yaml, values-factory.yaml, values-development.yaml, etc.)
45+
* values-global.yaml (used to override global values across clusters)
46+
* values-secrets.yaml (NEVER commit this to github, gitlab etc. This file should be in a safe directory on your laptop)
4747

4848
## Operators into framework
4949

@@ -128,7 +128,7 @@ applications:
128128
name: helm-with-kustomize
129129
```
130130
131-
In the above example `acm` (ACM) is part of the main `datacenter` deployment, as is `cool-app`. However, `central-kafka` is part of `backend-storage`.
131+
In the above example `acm` (ACM) is part of the main `datacenter` deployment, as is `cool-app`. However, `central-kafka` is part of `backend-storage`. All these deployment are on the same datacenter cluster.
132132

133133
The `path:` tag tells OpenShift GitOps where to find the Helm charts needed to deploy this application (refer back to the [charts directory description](https://validatedpatterns.io/building-vps/structure/#the-charts-directory) for more details). OpenShift GitOps will continuously monitor for changes to artifacts in that location for updates to apply.
134134

content/contribute/extending-a-pattern.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,25 @@ aliases: /extending-a-pattern/
88
# Extending an existing pattern
99

1010
## Introduction to extending a pattern using a fork
11-
Extending an existing pattern usually means adding a new product and/or configuration to the existing pattern. This usually requires four steps:
11+
Extending an existing pattern refers to adding a new product and/or configuration to an existing pattern. For example a pattern might be a great fit for a solution but requires the addition of an observability tool, e.g. Prometheus, Grafana, or Elastic. Extending an existing pattern is not very difficult. The advantage is that it automates the integration of this extra product into pattern.
12+
13+
Extending usually requires four steps:
1214
1. Adding any required namespace for the product
1315
1. Adding a subscription to install and operator
1416
1. Adding one or more ArgoCD applications to manage the post-install configuration of the product
1517
1. Adding the Helm chart needed to implement the post-install configuration identified in step 3.
1618

17-
Sometimes there is no operator in operator hub for the product and it requires installing the product using a Helm chart.
19+
Sometimes there is no operator in [OperatorHub](https://catalog.redhat.com/software/search?deployed_as=Operator) for the product and it requires installation using a Helm chart.
1820

19-
This additions need to be made to the appropriate `values-<cluster grouping>.yaml` file in the top level pattern directory. If the component is on a hub cluster that would be `values-hub.yaml`. If it's on a production cluster that would be in `values-production.yaml`. Look at the pattern architecture and decide where you need to add the product.
21+
These additions need to be made to the appropriate `values-<cluster grouping>.yaml` file in the top level pattern directory. If the component is on a hub cluster the file would be `values-hub.yaml`. If it's on a production cluster that would be in `values-production.yaml`. Look at the pattern architecture and decide where you need to add the product.
2022

2123
In the example below AMQ Streams (Kafka) is chosen as a product to add to a pattern.
2224

2325
## Before starting, fork and clone first
2426

2527
1. Visit the github page for the pattern that you wish to extend. E.g. [multicloud-gitops](https://github.com/hybrid-cloud-patterns/multicloud-gitops). Select “Fork” in the top right corner.
2628

27-
1. On the create a new fork page. You can choose what owner repository you want and the name of the fork. Most times you will fork into your personal repo and leave the name the same. When you have made the appropriate changes press the "Create fork" button.
29+
1. On the create a new fork page, you can choose what owner repository you want and the name of the fork. Most times you will fork into your personal repo and leave the name the same. When you have made the appropriate changes press the "Create fork" button.
2830

2931
1. You will need to clone from the new fork onto you laptop/desktop so that you can do the extension work effectively. So on the new fork’s main page elect the green “Code” button and copy the git repo’s ssh address.
3032

0 commit comments

Comments
 (0)