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

Add Helm Chart examples #2292

Merged
merged 2 commits into from
Aug 2, 2024
Merged

Add Helm Chart examples #2292

merged 2 commits into from
Aug 2, 2024

Conversation

lucacome
Copy link
Member

@lucacome lucacome commented Jul 26, 2024

Proposed changes

Problem: We don't have an easy way to deploy NGF for common use cases

Solution: Create an examples directory with common use cases for deploying Helm. As an added bonus we can generate manifests automatically from the examples.

Closes #1834

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

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

NONE

@lucacome lucacome requested a review from a team as a code owner July 26, 2024 02:27
@lucacome lucacome marked this pull request as draft July 26, 2024 02:27
@github-actions github-actions bot added documentation Improvements or additions to documentation chore Pull requests for routine tasks helm-chart Relates to helm chart labels Jul 26, 2024
Copy link

codecov bot commented Jul 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.74%. Comparing base (ff5faa9) to head (6e37b93).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2292   +/-   ##
=======================================
  Coverage   87.74%   87.74%           
=======================================
  Files          96       96           
  Lines        6813     6813           
  Branches       50       50           
=======================================
  Hits         5978     5978           
  Misses        778      778           
  Partials       57       57           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lucacome lucacome force-pushed the chore/examples branch 3 times, most recently from 2f3cbf3 to 86cefe2 Compare July 31, 2024 00:51
@lucacome lucacome marked this pull request as ready for review July 31, 2024 00:53
@lucacome lucacome requested a review from a team as a code owner July 31, 2024 00:53
@lucacome lucacome force-pushed the chore/examples branch 2 times, most recently from 1e0c00e to a249a6b Compare July 31, 2024 20:26
deploy/README.md Show resolved Hide resolved
deploy/openshift/deploy.yaml Show resolved Hide resolved
examples/helm/README.md Outdated Show resolved Hide resolved
examples/helm/README.md Outdated Show resolved Hide resolved
examples/helm/README.md Outdated Show resolved Hide resolved
hack/generate-manifests.sh Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
.gitignore Show resolved Hide resolved
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

Documentation changes LGTM.

@lucacome lucacome merged commit 13ea272 into nginxinc:main Aug 2, 2024
44 checks passed
@lucacome lucacome deleted the chore/examples branch August 2, 2024 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks documentation Improvements or additions to documentation helm-chart Relates to helm chart
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add Helm Chart examples and create deployment files from them
4 participants