Skip to content

Commit 9144440

Browse files
committed
Updated content
- Adding initial content for `creating a pattern` - Updated shortcut list for vault and eso
1 parent 89b1f8d commit 9144440

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

documentation/modules/ROOT/pages/_attributes.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,7 @@
55
:rhacs: Red Hat Advanced Cluster Security for Kubernetes
66
:rhocp: Red Hat OpenShift Container Platform
77
:rh-gitops: Red Hat OpenShift GitOps
8+
:eso: External Secrets Operator
9+
:vault: HashiCorp Vault
810
:source-highlighter: highlightjs
911
:experimental:

documentation/modules/ROOT/pages/creatingPatterns.adoc

+62
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,74 @@ include::main@vp-workshop:ROOT:partial$topicHeader.adoc[]
77
* Pattern Requirements
88
* Creation Process
99
10+
[IMPORTANT]
11+
.Core Concepts
12+
====
13+
* **Creating is Extending** We never really create a new pattern from zero. Instead we extend our basic pattern using artifacts that we have developed along the way
14+
* **Artifacts** Artifacts can include Helm Charts, Kustomize manifests, or plain Kubernetes manifests
15+
* **Moving Artifacts into the Validated Patterns framework** Many artifacts require conversion to Helm chart templates and parameterizing certain values
16+
* **Helm** Helm is a kubernetes package manager that allows you to define, install and manage kubernetes applications as reusable packages called charts
17+
====
18+
1019
[#common]
1120
== Understanding common
1221

22+
What's the role of the **common** repository?
23+
* The core components that make up the Validated Patterns framework are contained in the common repository
24+
* Including:
25+
** OpenShift GitOps configurations
26+
** RHACM configuration and Global Policies
27+
*** Support for **clusterGroup** and **GitOps** policies
28+
** Validated Pattern build scripts and Makefiles
29+
** Secrets Management (Hashicorp Vault)
30+
** Operator CRDs and other assets
31+
** Various utility scripts
32+
33+
What's in common?
34+
35+
NOTE: The common repository is where all the common manifests for the Validated Patterns framework live
36+
37+
* **acm** - contains the helm charts, which contains policies and is used to configure the deployment of the {rhacm}
38+
* **clusterGroup** - contains the helm charts used to create namespaces, subscriptions, Argo Project and Applications described in values files. THis is the seed for all the patterns.
39+
* **operator-install** - contains the helm chart used by the Validated Patterns operator to create the openshift-gitops component, creating the initial ArgoCD applications for Validated Patterns.
40+
41+
[source,bash]
42+
----
43+
common
44+
├── acm
45+
├── ansible
46+
├── Changes.md
47+
├── clustergroup
48+
├── common -> .
49+
├── examples
50+
├── golang-external-secrets
51+
├── hashicorp-vault
52+
├── LICENSE
53+
├── Makefile
54+
├── letsencrypt
55+
├── operator-install
56+
├── README.md
57+
├── reference-output.yaml
58+
├── scripts
59+
├── super-linter.log
60+
├── tests
61+
└── values-global.yaml
62+
----
63+
64+
* **ansible** - this directory contains the ansible roles and modules that support the secrets management for a pattern
65+
* **hashicorp-vault** - contains the helm chart for {vault}
66+
* **scripts** - contains utility scripts used by the Validated Patterns Framework
67+
* **golang-external-secrets** - Helm chart for the {eso}
68+
69+
=== What's next for common?
70+
71+
* We are in the very early stages of moving the helm charts in common into a public Helm repository
72+
* Deploying our patterns with multi-source enabled which allows us to use multiple sources for values, which will help reduce the need to have all the charts in the repo
73+
* Continue to maintain Makefiles, Ansible scripts and other tools in this repo in support of deploying patterns
1374

1475
[#requirements]
1576
== Pattern Requirements
1677

78+
1779
[#Creation Process]
1880
== Creation Process

0 commit comments

Comments
 (0)