Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate manifests using Helm #911

Merged
merged 4 commits into from
Aug 2, 2023

Conversation

ciarams87
Copy link
Member

Proposed changes

Problem: As a potential user of NKG
I want the manifest files simplified in the deployment manifests folder in the NKG repo
So that when I install NKG using manifests, I am not hindered by the need to evaluate each manifest file to see what is relevant to deploy for my environment.

Additionally, now that we have Helm templates, we have multiple deployment manifests/ templates requiring maintenance. This carries the risk of one of the deployment methods becoming out-of-sync with the other.

Solution: Generate the deployment manifests from the Helm templates, simplifying maintenance, and reducing the required steps a user needs to undertake to deploy NKG using manifests. This also has the effect that labels and selectors are consistent across the Helm templates and the manifests.

This solution does not include the Service manifest in the main manifest yaml as this is environment specific. However, the Service manifests are also generated from the Helm templates.

Additionally, the static deployment manifest for the provisioner is also being generated, and has been moved to the conformance/provisioner folder with the provisioner yaml.

Testing: Manual installs using Helm and the new manifests, and ensuring the conformance tests can still run and pass

Closes #780

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@ciarams87 ciarams87 requested a review from a team as a code owner July 26, 2023 16:25
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 26, 2023
conformance/provisioner/static-deployment.yaml Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
conformance/README.md Outdated Show resolved Hide resolved
conformance/README.md Show resolved Hide resolved
conformance/README.md Outdated Show resolved Hide resolved
deploy/helm-chart/Chart.yaml Show resolved Hide resolved
deploy/helm-chart/README.md Outdated Show resolved Hide resolved
docs/developer/quickstart.md Outdated Show resolved Hide resolved
docs/developer/quickstart.md Show resolved Hide resolved
docs/release-process.md Outdated Show resolved Hide resolved
docs/uninstallation.md Outdated Show resolved Hide resolved
embedded.go Show resolved Hide resolved
conformance/README.md Show resolved Hide resolved
conformance/provisioner/static-deployment.yaml Outdated Show resolved Hide resolved
docs/developer/quickstart.md Outdated Show resolved Hide resolved
docs/installation.md Show resolved Hide resolved
docs/uninstallation.md Outdated Show resolved Hide resolved
docs/developer/quickstart.md Outdated Show resolved Hide resolved
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@ciarams87 ciarams87 requested a review from pleshakov July 27, 2023 17:45
docs/installation.md Outdated Show resolved Hide resolved
@ciarams87 ciarams87 merged commit 36daa1d into nginxinc:main Aug 2, 2023
@ciarams87 ciarams87 deleted the feat/simplify-manifests branch August 2, 2023 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Simplify Deployment Manifests
5 participants