Skip to content

Commit d958999

Browse files
authored
Merge pull request #72694 from rohennes/OCPBUGS-29309
Adding folder to directory structure for custom user CRs
2 parents a56191b + 4120c98 commit d958999

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

modules/ztp-preparing-the-ztp-git-repository-ver-ind.adoc

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,12 @@ This means that the version of {product-title} running on the hub cluster can be
1717
For each version, create the following resources:
1818
* `kustomization.yaml` file that explicitly includes the files in that directory
1919
* `source-crs` directory to contain reference CR configuration files from the `ztp-site-generate` container
20+
+
21+
If you want to work with user-provided CRs, you must create a separate directory for them.
2022

21-
. In the `/siteconfig` directory, create a subdirectory for each {product-title} version you want to make available. For each version, create at least one directory for reference CRs to be copied from the container. There is no restriction on the naming of directories or on the number of reference directories. If you want to work with user-provided CRs, you must create a separate directory for those.
23+
. In the `/siteconfig` directory, create a subdirectory for each {product-title} version you want to make available. For each version, create at least one directory for reference CRs to be copied from the container. There is no restriction on the naming of directories or on the number of reference directories. If you want to work with custom manifests, you must create a separate directory for them.
2224
+
23-
The following example describes a structure using user-provided CRs for different versions of {product-title}:
25+
The following example describes a structure using user-provided manifests and CRs for different versions of {product-title}:
2426
+
2527
[source,text]
2628
----
@@ -33,7 +35,9 @@ The following example describes a structure using user-provided CRs for differen
3335
│ │ ├── helix56-v413.yaml
3436
│ │ ├── kustomization.yaml <3>
3537
│ │ ├── ns.yaml
36-
│ │ └── source-crs/ <4>
38+
│ │ └── source-crs/ <4>
39+
│ │ └── reference-crs/ <5>
40+
│ │ └── custom-crs/ <6>
3741
│ └── version_4.14 <2>
3842
│ ├── common-ranGen.yaml
3943
│ ├── group-du-sno-ranGen.yaml
@@ -42,26 +46,30 @@ The following example describes a structure using user-provided CRs for differen
4246
│ ├── kustomization.yaml <3>
4347
│ ├── ns.yaml
4448
│ └── source-crs/ <4>
49+
│ └── reference-crs/ <5>
50+
│ └── custom-crs/ <6>
4551
└── siteconfig
4652
├── kustomization.yaml
4753
├── version_4.13
4854
│ ├── helix56-v413.yaml
4955
│ ├── kustomization.yaml
50-
│ ├── extra-manifest/ <5>
51-
│ └── custom-manifest/ <6>
56+
│ ├── extra-manifest/ <7>
57+
│ └── custom-manifest/ <8>
5258
└── version_4.14
5359
├── helix57-v414.yaml
5460
├── kustomization.yaml
55-
├── extra-manifest/ <5>
56-
└── custom-manifest/ <6>
61+
├── extra-manifest/ <7>
62+
└── custom-manifest/ <8>
5763

5864
----
59-
<1> Create a top-level `kustomization` yaml file.
65+
<1> Create a top-level `kustomization` YAML file.
6066
<2> Create the version-specific directories within the custom `/policygentemplates` directory.
6167
<3> Create a `kustomization.yaml` file for each version.
6268
<4> Create a `source-crs` directory for each version to contain reference CRs from the `ztp-site-generate` container.
63-
<5> Create a directory within the custom `/siteconfig` directory to contain extra manifests from the `ztp-site-generate` container.
64-
<6> Create a folder to hold user-provided CRs.
69+
<5> Create the `reference-crs` directory for policy CRs that are extracted from the ZTP container.
70+
<6> Optional: Create a `custom-crs` directory for user-provided CRs.
71+
<7> Create a directory within the custom `/siteconfig` directory to contain extra manifests from the `ztp-site-generate` container.
72+
<8> Create a folder to hold user-provided manifests.
6573
+
6674
[NOTE]
6775
====

0 commit comments

Comments
 (0)