Skip to content

Commit 848e151

Browse files
authored
docs: update readme for top-level generators (PSKD-1380)
Generators documented for inclusion in the base kustomization.yaml need adjusted handling for this project. This change updates the README.md with the necessary details.
2 parents 4a59ffb + c23e6e9 commit 848e151

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,44 @@ For example:
184184

185185
The SAS Viya platform customizations that are managed by viya4-deployment are located under the [templates](https://github.com/sassoftware/viya4-deployment/tree/main/roles/vdm/templates) directory. These are purposely templatized and included there since they contain a set of customizations that are common or required for a functioning SAS Viya platform deployment. These particular files are configured via exposed variables that are documented within [CONFIG-VARS.md](docs/CONFIG-VARS.md) and do not need to be manually placed under `/site-config`.
186186

187+
#### Base kustomization.yaml ConfigMap and Secret Generators
188+
189+
In some scenarios, a README or the deployment documentation instructs you to add a `configMapGenerator` or `secretGenerator` entry to the base `kustomization.yaml` (also known as `$deploy/kustomization.yaml`). For example:
190+
191+
```yaml
192+
configMapGenerator:
193+
...
194+
- name: sas-risk-cirrus-core-parameters
195+
behavior: merge
196+
envs:
197+
- site-config/sas-risk-cirrus-rcc/configuration.env
198+
...
199+
```
200+
201+
In that scenario, copy the `configuration.env` file into the appropriate site-config subdirectory, and create a peer `-configmap.yaml` (or `-secret.yaml`) file:
202+
203+
```bash
204+
/deployments <- parent directory
205+
/demo-cluster <- folder per cluster
206+
/demo-ns <- folder per namespace
207+
/site-config <- location for all customizations
208+
/sas-risk-cirrus-rcc <- folder containing user defined customizations
209+
/configuration.env <- env file
210+
/sas-risk-cirrus-rcc-configmap.yaml <- individual generator file
211+
```
212+
213+
In the `-configmap.yaml` (or `-secret.yaml`) file, create a `ConfigMapGenerator` (or `SecretGenerator`) that corresponds with the documented `configMapGenerator` (or `secretGenerator`) entry:
214+
215+
```yaml
216+
apiVersion: builtin
217+
kind: ConfigMapGenerator
218+
metadata:
219+
name: sas-risk-cirrus-core-parameters
220+
behavior: merge
221+
envs:
222+
- site-config/sas-risk-cirrus-rcc/configuration.env
223+
```
224+
187225
#### OpenLDAP Customizations
188226
189227
The OpenLDAP setup that is described here is a temporary solution that enables you to add users and groups and to start using SAS Viya platform applications. The OpenLDAP server that is created using these instructions does not persist. It is created and destroyed within the SAS Viya platform namespace where it is created. To add users or groups that persist, follow the SAS documentation that describes how to [Configure an LDAP Identity Provider](https://documentation.sas.com/?cdcId=sasadmincdc&cdcVersion=default&docsetId=calids&docsetTarget=n1aw4xnkvwcddnn1mv8lxr2e4tu7.htm#p0spae4p1qoto3n1qpuzafcecxhh).

0 commit comments

Comments
 (0)