Skip to content

Commit 9346560

Browse files
authored
Merge pull request #50704 from aireilly/td-938
TELCODOCS-938 - Add note clarifying namespace requirements for PolicyGenTemplate CRs
2 parents 5f21e9b + 47dc154 commit 9346560

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

modules/ztp-creating-the-policygentemplate-cr.adoc

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,29 @@
88

99
Use this procedure to create the `PolicyGenTemplate` custom resource (CR) for your site in your local clone of the Git repository.
1010

11+
.Prerequisites
12+
13+
Ensure that policy namespaces meets the following requirements:
14+
15+
* Namespace names must be prefixed with `ztp`. For example:
16+
+
17+
[source,yaml]
18+
----
19+
apiVersion: v1
20+
kind: Namespace
21+
metadata:
22+
name: ztp-common
23+
----
24+
25+
* Namespaces must not match the namespace of a pre-existing cluster.
26+
1127
.Procedure
1228

1329
. Choose an appropriate example from `out/argocd/example/policygentemplates`. This directory demonstrates a three-level policy framework that represents a well-supported low-latency profile tuned for the needs of 5G Telco DU deployments:
1430
+
15-
* A single `common-ranGen.yaml` file that should apply to all types of sites.
16-
* A set of shared `group-du-*-ranGen.yaml` files, each of which should be common across a set of similar clusters.
17-
* An example `example-*-site.yaml` that can be copied and updated for each individual site.
31+
** A single `common-ranGen.yaml` file that applies to all types of sites.
32+
** A set of shared `group-du-*-ranGen.yaml` files that are common between similar clusters.
33+
** An example `example-*-site.yaml` file that you can copy and update for each individual site.
1834

1935
. Ensure that the labels defined in your `PolicyGenTemplate` `bindingRules` section correspond to the labels that are defined in the `SiteConfig` files of the clusters you are managing.
2036

@@ -26,6 +42,11 @@ Depending on the specific requirements of your clusters, you might need more tha
2642
====
2743

2844
. Define all the policy namespaces in a YAML file similar to the example `out/argocd/example/policygentemplates/ns.yaml` file.
45+
+
46+
[IMPORTANT]
47+
====
48+
Ensure that policy namespaces begin with `ztp` and are unique.
49+
====
2950

3051
. Add all the `PolicyGenTemplate` files and `ns.yaml` file to the `kustomization.yaml` file, similar to the example `out/argocd/example/policygentemplates/kustomization.yaml` file.
3152

0 commit comments

Comments
 (0)