nginx-gateway-fabric icon indicating copy to clipboard operation
nginx-gateway-fabric copied to clipboard

Add Helm Chart examples and create deployment files from them

Open lucacome opened this issue 1 year ago • 1 comments
trafficstars

As a user of NGF I want an easy way to deploy common NGF use cases using Helm So that I do not have to learn exactly what to tweak in the Helm chart to achieve my use case.

Acceptance

  • Users have an easy way to configure and deploy for these use cases:
    • Deploying for AWS
    • NGINX Plus
    • Enable experimental flag for NGF
  • Each example file is assumed to be deployed mutually exclusively with the other use cases
  • An example file is created for each use case that provides a way to deploy the Kubernetes objects needed
  • Manifest files for the above use cases are generated using the new example files

Original Issue

Add Helm Chart values files in the examples directory for the most common use cases:

  1. Deploying for AWS
  2. NGINX Plus
  3. Enable experimental flag for NGF
examples/helm-chart
├── README.md
├── aws-nlb
│   └── values.yaml
├── something-something
│   └── values.yaml
...
└── read-only-fs
    └── values.yaml

we can then create deployment files generating them from the Helm Chart to have a single source of truth, resulting in something like:

deploy/
├── README.md
├── aws-nlb
│   └── deploy.yaml
├── something-something
│   └── deploy.yaml
...
└── read-only-fs
    └── deploy.yaml

These manifest files will have everything that's needed for the deployment in a single file, Service, Service Account, Namespace, Deployment, etc.

lucacome avatar Apr 17 '24 02:04 lucacome

During refinement, determine if we need/want the second part of this ticket.

mpstefan avatar Apr 22 '24 16:04 mpstefan