Skip to content

Commit aa24094

Browse files
committed
Added content for pattern operator and wrapper script
- Created content pages for the patterns operator and wrapper scripts - Added images from the initial powerpoint presentation and worked into adoc.
1 parent b7355fc commit aa24094

File tree

5 files changed

+103
-0
lines changed

5 files changed

+103
-0
lines changed
Loading
Loading

documentation/modules/ROOT/nav.adoc

+3
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@
4242
*** xref:consumingPatterns.adoc#multiArgos[Multiple Argo's]
4343
*** xref:consumingPatterns-valuesFiles.adoc#values[Pattern Values Files]
4444
*** xref:consumingPatterns-valuesFiles.adoc#valuesSecret[Pattern Secret Values Template]
45+
*** xref:patternsOperator.adoc#features[About the Patterns Operator]
46+
*** xref:patternsWrapperScript.adoc#about[About the Patterns.sh wrapper]
47+
*** xref:patternsWrapperScript.adoc#help[Wrapper Help]
4548
*** xref:consumingPatterns.adoc#exercises[Exercises]
4649
** xref:creatingPatterns.adoc[Creating Validated Patterns]
4750
** xref:creatingPatterns.adoc#objectives[Topic Objectives]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
== Validated Patterns Operator
2+
include::_attributes.adoc[]
3+
4+
[#features]
5+
=== Validated Operator Features
6+
7+
* Available as a community operator in Operator Hub
8+
* Interrogates the cluster and uses information to personalize the pattern with argo/helm values
9+
* Allows you to pick a repository for the pattern and to select a branch version (e.g. `stable`)
10+
* Deploys OpenShift GitOps with the correct `values-hub`
11+
* Regardless of how you deploy the pattern, the operator is still in use
12+
13+
IMPORTANT: `make load-secrets` is required when deploying the operator via OpenShift Console.
14+
15+
image::vp-operator-community.png[Community Operator]
16+
17+
image::olm-vp-operator.png[OLM]
18+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
== Using the pattern.sh script
2+
include::_attributes.adoc[]
3+
4+
[#about]
5+
6+
[source,bash]
7+
----
8+
$ ./pattern.sh
9+
10+
1 Welcome to the Validate Pattern utility container
11+
111 It contains all the needed components to install a pattern.
12+
1 1
13+
111 111 Please run the following for more information:
14+
1 1
15+
111 111 ./pattern.sh make help
16+
1 1 1 1
17+
111 111 111 111
18+
19+
----
20+
21+
* Used to deploy the pattern from the command-line
22+
* Deploys the operator with a repository and branch from the local clone of the repo
23+
* Provides a way to invoke the container which has all of the pre-requisites software installed (e.g. python, ansible, make)
24+
* Improved User Experience when deploying Patterns from the command line
25+
* When installing a pattern use:
26+
27+
[source,bash]
28+
----
29+
./pattern.sh make install
30+
----
31+
* When loading secrets into your deployment
32+
[source,bash]
33+
----
34+
./pattern.sh make load-secrets
35+
----
36+
37+
IMPORTANT: pattern.sh uses your origin remote and current branch. To change the branch after a deployment, run `make install` in the new branch
38+
39+
[#help]
40+
== Help Menu
41+
42+
`pattern.sh` comes with a help menu, to use it:
43+
44+
[source,bash]
45+
----
46+
$ ./pattern.sh make help
47+
48+
Usage:
49+
make <target>
50+
51+
Pattern tasks
52+
install installs the pattern and loads the secrets
53+
post-install Post-install tasks
54+
55+
Pattern Common Tasks
56+
help This help message
57+
show show the starting template without installing it
58+
operator-deploy operator-upgrade runs helm install
59+
uninstall runs helm uninstall
60+
load-secrets loads the secrets into the backend determined by values-global setting
61+
legacy-load-secrets loads the secrets into vault (only)
62+
secrets-backend-vault Edits values files to use default Vault+ESO secrets config
63+
secrets-backend-kubernetes Edits values file to use Kubernetes+ESO secrets config
64+
secrets-backend-none Edits values files to remove secrets manager + ESO
65+
load-iib CI target to install Index Image Bundles
66+
67+
Validation Tasks
68+
validate-origin verify the git origin is available
69+
validate-cluster Do some cluster validations before installing
70+
validate-schema validates values files against schema in common/clustergroup
71+
validate-prereq verify pre-requisites
72+
argo-healthcheck Checks if all argo applications are synced
73+
74+
Test and Linters Tasks
75+
test run helm tests
76+
helmlint run helm lint
77+
kubeconform run helm kubeconform
78+
super-linter Runs super linter locally
79+
ansible-lint run ansible lint on ansible/ folder
80+
ansible-unittest run ansible unit test
81+
82+
----

0 commit comments

Comments
 (0)