Skip to content

Commit 429a51a

Browse files
committed
Updated docs for the LZT pattern
1 parent 5d43043 commit 429a51a

File tree

2 files changed

+71
-2
lines changed

2 files changed

+71
-2
lines changed

content/patterns/layered-zero-trust/_index.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ The pattern consists of the following key components:
9191
* link:https://external-secrets.io[External Secrets Operator (ESO)]
9292
** Synchronizes secrets stored in HashiCorp Vault with {ocp}.
9393

94+
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14[{rh-rhacm-first}]
95+
** Provides a management control plane in multi-cluster scenarios.
96+
9497
[id="sidecar-pattern"]
9598
==== Sidecar pattern
9699

@@ -119,6 +122,7 @@ The following technologies are used in this solution:
119122
* *Red{nbsp}Hat build of Keycloak*: Manages identity and access for users and services.
120123
* *{rh-gitops}*: A GitOps continuous delivery (CD) solution based on ArgoCD
121124
* *OpenShift Cert Manager*: Manages the lifecycle of certificates for secure communication.
125+
* *{rh-rhacm}*: Provides management capabilities in multi-cluster scenarios.
122126
* *External Secrets Operator*: Synchronizes secrets from external systems into the cluster.
123127
* *Compliance Operator*: Provides ability to scan and remediate cluster hardening based on profiles
124128
* *QTodo application*: Serves as a sample Quarkus-based application to show zero trust principles.

content/patterns/layered-zero-trust/lzt-getting-started.adoc

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Follow these instructions to configure and deploy the Layered Zero Trust pattern
2727

2828
* Fulfill the general link:https://validatedpatterns.io/learn/quickstart/#_prerequisites[prerequisites for Validated Patterns].
2929

30-
* Depending on the characteristics of your cluster, you might need additional hardware resources for the Advanced Cluster Management (ACM) component.
30+
* Depending on the characteristics of your cluster, you might need additional hardware resources for the {rh-rhacm-first} component.
3131
For a single-node cluster, you can start with 4 vCPUs, 16 GB of memory, and 120 GB of storage.
3232
+
33-
For more details about ACM sizing, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html-single/install/index#sizing-your-cluster[Sizing your cluster].
33+
For more details about {rh-rhacm} sizing, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html-single/install/index#sizing-your-cluster[Sizing your cluster].
3434

3535
* (Optional) The Helm binary, for instructions, see link:https://helm.sh/docs/intro/install/[Installing Helm].
3636

@@ -85,6 +85,11 @@ origin [email protected]:<your_username>/layered-zero-trust.git (push)
8585
upstream https://github.com/validatedpatterns/layered-zero-trust.git (fetch)
8686
upstream https://github.com/validatedpatterns/layered-zero-trust.git (push)
8787
----
88+
+
89+
[WARNING]
90+
====
91+
The Layered Zero Trust pattern's default deployment assumes that none of its components have been installed previously. Verify that your {ocp} environment does not already contain any of xref:/patterns/layered-zero-trust/index.html#architecture [the listed components] before proceeding.
92+
====
8893

8994
. Create a local copy of the secret values file that can safely include
9095
credentials. Run the following command:
@@ -177,3 +182,63 @@ The Layered Zero-Trust pattern installs the following two {ocp} GitOps instances
177182
. **Hub Argo CD**: Manages Cluster Argo CD instance and the individual components that belong to the pattern on the hub {ocp} instance.
178183

179184
If every Argo CD application reports a **Healthy** status, the pattern has been deployed successfully.
185+
186+
187+
[id="lzt-importing-existing-clusters"]
188+
== Importing existing clusters
189+
190+
The pattern supports importing pre-existing {ocp} clusters into the Hub cluster, converting them into *Managed Clusters*.
191+
192+
[WARNING]
193+
====
194+
Do not use the `ClusterPools` configuration settings for {rh-rhacm} chart provisioning. The `ClusterPools` technology is limited to cloud environments.
195+
196+
Instead, use the `acm-managed-clusters` chart to import your existing standalone clusters.
197+
====
198+
199+
.Procedure
200+
201+
. Copy the `kubeconfig` file of the cluster you want to import to your local system.
202+
203+
. In the `values-secret.yaml` file, define the `kubeconfig` secret by providing the local file system path to the `kubeconfig` file you copied in Step 1.
204+
+
205+
[source,yaml]
206+
----
207+
- name: kubeconfig-spoke
208+
vaultPrefixes:
209+
- hub
210+
fields:
211+
- name: content
212+
path: ~/.kube/kubeconfig-ztvp-spoke
213+
----
214+
215+
. In the `values-hub.yaml` file, add a new entry in the `clusterGroup.managedClusterGroups` key.
216+
+
217+
[source,yaml]
218+
----
219+
managedClusterGroups:
220+
exampleRegion:
221+
name: group-one
222+
acmlabels:
223+
- name: clusterGroup
224+
value: group-one
225+
helmOverrides:
226+
- name: clusterGroup.isHubCluster
227+
value: false
228+
----
229+
230+
. Also in the `values-hub.yaml` file, add your cluster definition in the `acmManagedClusters.clusters` key.
231+
+
232+
[source,yaml]
233+
----
234+
acmManagedClusters:
235+
clusters:
236+
- name: ztvp-spoke-1
237+
clusterGroup: group-one
238+
labels:
239+
cloud: auto-detect
240+
vendor: auto-detect
241+
kubeconfigVaultPath: secret/data/hub/kubeconfig-spoke
242+
----
243+
244+
. Deploy the pattern.

0 commit comments

Comments
 (0)