Skip to content

Commit dd00610

Browse files
kquinn1204kquinn1204
committed
Adding some more content
1 parent 74c8ad8 commit dd00610

File tree

1 file changed

+142
-45
lines changed

1 file changed

+142
-45
lines changed

‎content/learn/quickstart.adoc‎

Lines changed: 142 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -11,79 +11,176 @@ include::modules/comm-attributes.adoc[]
1111

1212
== Patterns quick start overview
1313

14-
This validated pattern quickstart offers a streamlined guide to deploying predefined, reliable configurations and applications in OpenShift Container Platform, ensuring they meet established standards. It provides step-by-step instructions on setup, prerequisites, and configuration, enabling administrators to deploy tested, supportable patterns quickly. These patterns simplify complex deployments by applying reusable configurations suited to various infrastructure and application needs, allowing users to efficiently deploy, manage, and scale applications with GitOps. This approach also reduces the risks and time associated with custom configurations.
14+
This validated pattern quickstart offers a streamlined guide to deploying predefined, reliable configurations and applications, ensuring they meet established standards. It provides step-by-step instructions on setup, prerequisites, and configuration, enabling administrators to deploy tested, supportable patterns quickly. These patterns simplify complex deployments by applying reusable configurations suited to various infrastructure and application needs, allowing users to efficiently deploy, manage, and scale applications with GitOps. This approach also reduces the risks and time associated with custom configurations.
1515

16-
There are two ways to deploy validated patterns using the OpenShift-based Validated Patterns framework or the Ansible GitOps Framework (AGOF). The OpenShift-based validated patterns framework is the most common method for deploying applications and infrastructure on the OpenShift Container Platform. It offers a set of predefined configurations and patterns that follow best practices and are validated by Red Hat.
16+
There are two ways to deploy validated patterns: through the OpenShift-based Validated Patterns framework or the Ansible GitOps Framework (AGOF). The OpenShift-based validated patterns framework is the most common method for deploying applications and infrastructure on the OpenShift Container Platform. It offers a set of predefined configurations and patterns that follow best practices and are validated by Red Hat.
1717

18-
Each pattern can be deployed using the command line. The only requirement is to have `git` and `podman` installed. See the <<installation_prerequisites>> for more information.
18+
== Getting Started with Validated Patterns
1919

20-
Patterns deployment requires several tools including Helm to install. However, the validated patterns framework removes the need to install and maintain these tools. The `pattern.sh` script uses a container which includes the necessary tools. The use of that container is why you need to install `podman`.
20+
This guide steps you through the process of deploying your first validated pattern on an OpenShift cluster. By the end of this guide, you'll have a working instance of the Multicloud GitOps pattern, which serves as an excellent foundation for exploring other patterns.
2121

22-
Check the `values-\*.yaml` for changes that are needed before deployment. After changing the `values-*.yaml` files where needed and pushing them to your git repository, you can run `./pattern.sh make install` from your local repository directory and that will deploy the datacenter/hub cluster for a pattern. Edge clusters are deployed by joining/importing them into ACM on the hub.
22+
=== What You'll Learn
2323

24-
Alternatively to the `./pattern.sh make install` method, you can use the https://operatorhub.io/operator/patterns-operator[validated pattern operator] available in the OpenShift console.
24+
. Setting up prerequisites for validated patterns
25+
. Installing and configuring the Validated Patterns Operator
26+
. Deploying the Multicloud GitOps pattern
27+
. Managing secrets and configurations
2528

26-
For information on using the Validated Patterns Operator, see link:/infrastructure/using-validated-pattern-operator/[Using the Validated Pattern Operator].
29+
== Prerequisites
2730

28-
Follow any other post-install instructions for the pattern on that pattern’s Getting started page.
31+
Before beginning, ensure you have the following:
2932

33+
=== OpenShift Cluster Requirements
3034

31-
== Prerequisite installation instructions [[installation_prerequisites]]
35+
* A running OpenShift 4.12 or later
36+
* Cluster-admin privileges
37+
* At least 8 CPU cores available
38+
* Minimum 16GB RAM available
3239

33-
== Tested Operating systems
34-
The following instructions have been tested on the following operating systems:
40+
=== Storage Requirements
3541

36-
* Red Hat Enterprise Linux 8 and 9
37-
* CentOS 8 and 9
38-
* Fedora 36 and onwards
39-
* Debian Bookworm
40-
* Ubuntu 22.04
41-
* Mac OSX Big Sur and onwards
42+
* A default storage class configured for dynamic provisioning
43+
* At least 10GB of available storage
4244

43-
=== Red Hat Enterprise Linux 8 and 9
44-
Make sure that you have both the `appstream` and the `baseos` repositories configured.
45-
For example on RHEL 8 you will get the following:
45+
=== Network Requirements
4646

47-
[source,terminal]
47+
.For connected environments:
48+
* Access to public container registries
49+
* Access to GitHub repositories
50+
51+
.For disconnected environments:
52+
* Local registry with mirrored operator catalogs
53+
* Local Git repository with pattern manifests
54+
* Proper network policies configured
55+
56+
== Getting Started with Multicloud GitOps
57+
58+
=== What is Multicloud GitOps?
59+
60+
Multicloud GitOps is a foundational pattern that demonstrates GitOps principles for managing applications across multiple clusters. It provides:
61+
62+
* A GitOps framework using ArgoCD
63+
* Infrastructure-as-Code practices
64+
* Multi-cluster management capabilities
65+
* Template for secure secret management
66+
67+
=== Why Start with this Pattern?
68+
69+
The Multicloud GitOps pattern is recommended as your first pattern because:
70+
71+
. It establishes core GitOps practices
72+
. Provides a minimal but complete implementation
73+
. Serves as a foundation for other patterns
74+
. Demonstrates key validated patterns concepts
75+
76+
[NOTE]
77+
====
78+
Other patterns build upon these concepts, making this an ideal starting point for your validated patterns journey.
79+
====
80+
81+
== Installing the Validated Patterns Operator
82+
83+
. Navigate to the OpenShift OperatorHub
84+
. Search for "Validated Patterns Operator"
85+
. Click "Install"
86+
. Select installation mode:
87+
+
88+
[source,yaml]
4889
----
49-
sudo dnf repolist
50-
Updating Subscription Management repositories.
51-
repo id repo name
52-
rhel-8-for-x86_64-appstream-rpms Red Hat Enterprise Linux 8 for x86_64 - AppStream (RPMs)
53-
rhel-8-for-x86_64-baseos-rpms Red Hat Enterprise Linux 8 for x86_64 - BaseOS (RPMs)
90+
Installation Mode: All namespaces
91+
Installed Namespace: openshift-operators
92+
Update Channel: stable
93+
Approval Strategy: Automatic
5494
----
5595

56-
Install `podman` and `git`:
96+
== Installing the Multicloud GitOps Pattern
97+
98+
=== Creating the Pattern Custom Resource
5799

58-
[source,terminal]
100+
. Create a new YAML file named `pattern-cr.yaml`:
101+
+
102+
[source,yaml]
59103
----
60-
sudo dnf install -y podman git
104+
apiVersion: ran.openshift.io/v1beta1
105+
kind: Pattern
106+
metadata:
107+
name: multicloud-gitops
108+
namespace: patterns
109+
spec:
110+
version: latest
111+
gitSpec:
112+
targetRepo: https://github.com/validatedpatterns/multicloud-gitops
113+
targetBranch: main
61114
----
62115

63-
=== Fedora
64-
Install `podman` and `git`:
116+
. Apply the Custom Resource:
117+
+
118+
[source,bash]
119+
----
120+
oc apply -f pattern-cr.yaml
121+
----
122+
123+
=== Verifying the Installation
124+
125+
Monitor the deployment:
65126

66-
[source,terminal]
127+
[source,bash]
67128
----
68-
sudo dnf install -y podman git
129+
oc get pods -n patterns
130+
oc get applications -n openshift-gitops
69131
----
70132

71-
=== Debian and derivatives
72-
Install `podman` and `git`:
133+
== Configuring Secrets
73134

74-
[source,terminal]
135+
Secret management in validated patterns follows GitOps best practices while maintaining security. Here's how to configure your secrets:
136+
137+
=== Using Vault for Secret Management
138+
139+
. Access the Vault instance deployed by the pattern
140+
. Initialize Vault and obtain root tokens
141+
. Configure secret engines:
142+
+
143+
[source,bash]
75144
----
76-
sudo apt-get install -y podman git
145+
vault secrets enable -path=secret kv-v2
77146
----
78147

79-
=== Mac OSX
80-
Install `podman` and `git`:
148+
=== Storing Pattern Secrets
149+
150+
. Create a new secret:
151+
+
152+
[source,bash]
153+
----
154+
vault kv put secret/pattern-name/credentials \
155+
username="admin" \
156+
password="secure-password"
157+
----
81158

82-
[source,terminal]
159+
. Reference secrets in your GitOps configurations:
160+
+
161+
[source,yaml]
83162
----
84-
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
85-
brew install podman git
86-
# Containers on MacOSX run in a VM which is managed by "podman machine" commands
87-
podman machine init -v ${HOME}:${HOME} -v /private/tmp/:/private/tmp
88-
podman machine start
163+
apiVersion: v1
164+
kind: Secret
165+
metadata:
166+
name: pattern-secret
167+
stringData:
168+
credentials: ${vault:secret/data/pattern-name/credentials}
89169
----
170+
171+
[TIP]
172+
====
173+
For more detailed information about secret management, refer to the comprehensive guide at https://validatedpatterns.io/learn/
174+
====
175+
176+
== Next Steps
177+
178+
* Explore the deployed components in your OpenShift console
179+
* Review the GitOps repositories created by the pattern
180+
* Try modifying the configuration to understand the GitOps workflow
181+
* Consider exploring other validated patterns that build on this foundation
182+
183+
[IMPORTANT]
184+
====
185+
Remember to consult the official documentation at validatedpatterns.io for detailed information about specific features and advanced configurations.
186+
====

0 commit comments

Comments
 (0)