search

sassoftware / viya4-deployment

This project contains Ansible code that creates a baseline in an existing Kubernetes environment for use with the SAS Viya Platform, generates the manifest for an order, and then can also deploy that order into the Kubernetes environment specified.
Apache License 2.0
70 stars 64 forks source link

improve doc around "Customize Deployment Overlays" folder structure #304

Closed bullcity42 closed 8 months ago

bullcity42 commented 1 year ago

The section "Customize Deployment Overlays" at https://github.com/sassoftware/viya4-deployment/blob/main/README.md can be improved to make it more clear what to name the folders under site-config, for example "generators" or "transformers" as the case may be:

<base_dir>            <- parent directory
  /<cluster>          <- folder per cluster
    /<namespace>      <- folder per namespace
      /site-config    <- location for all customizations
        ...           **<- folders containing user defined customizations**

For example, I had to put sas-backup-agent-parameters.yaml and sas-backup-job-parameters.yaml under "site-config/generators" and not "site-config". Then I ran viya4 deployment again and see this newly added to kustomization.yaml:

generators:
## vdm defined generators (pre)
  - site-config/vdm/generators/sas-license.yaml
  - site-config/vdm/generators/sas-shared-config.yaml
  - site-config/vdm/generators/sas-consul-config-secret.yaml
  - site-config/vdm/generators/ingress-input.yaml
  - site-config/vdm/generators/sas-image-pull-secrets.yaml
  - site-config/vdm/generators/mirror.yaml
  - site-config/vdm/generators/openldap-bootstrap-config.yaml
  - site-config/vdm/generators/customer-provided-ca-certificates.yaml
  - site-config/vdm/generators/customer-provided-ingress-certificate.yaml
  - site-config/vdm/generators/customer-provided-merge-sas-certframe-configmap.yaml
## user defined generators
  - site-config/generators/sas-backup-agent-parameters.yaml
  - site-config/generators/sas-backup-job-parameters.yaml

Similarly, a colleague mentioned having to put cas-enable-external-services.yaml under "site-config/transformers" and not "site-config" for it to be added to kustomization.yaml.

Please consider updating "Customize Deployment Overlays" in the readme to expand on this topic, so folks know what names the directories should be under site-config and provide more examples. Might also be helpful to point to the kustomize doc here: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/ so if they don't already know, they can learn about "generators", "tranformers", "resources", etc.

riragh commented 9 months ago

As mentioned in the README section "Customize Deployment Overlays", user is expected to input a folder containing user-defined customizations. The folder name is user's choice. The files defined in the folder are identified based on their content. Hence, if the yaml are defined are correctly, then they will be read in the appropriate sections in kustomization.yaml. Hope this helps. Let me know if you still have questions around this.

riragh commented 8 months ago

No response received from user, closing this due to inactivity.