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 configurable delayed termination instructions #1171

Merged
merged 5 commits into from
Oct 23, 2023

Conversation

ciarams87
Copy link
Member

Proposed changes

Problem:
As a cluster admin
I would like to be able to upgrade NGF with zero downtime for my clients
So that there is no interruption in client traffic while the upgrade is occurring

Solution:

  • Add zero downtime upgrade using delayed termination configuration documentation in the installation doc and the Helm README
  • Provide a note on WebSockets and long lived connections along with this documentation.

Please focus on (optional): This is dependant on #1155 being merged first

I also added TOCs to the updated files.

Closes #1154

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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 20, 2023
deploy/helm-chart/README.md Outdated Show resolved Hide resolved
deploy/helm-chart/README.md Outdated Show resolved Hide resolved
deploy/helm-chart/README.md Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
deploy/helm-chart/README.md Show resolved Hide resolved
@ciarams87 ciarams87 marked this pull request as ready for review October 23, 2023 13:56
@ciarams87 ciarams87 requested a review from a team as a code owner October 23, 2023 13:56
@ciarams87 ciarams87 changed the title DRAFT: Add configurable delayed termination instructions Add configurable delayed termination instructions Oct 23, 2023
deploy/helm-chart/README.md Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Show resolved Hide resolved
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.

👍

deploy/helm-chart/README.md Outdated Show resolved Hide resolved
deploy/helm-chart/README.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
Copy link
Contributor

@bjee19 bjee19 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 enabled auto-merge (squash) October 23, 2023 16:21
@ciarams87 ciarams87 merged commit bb95dea into nginxinc:main Oct 23, 2023
22 checks passed
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
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Explain how to upgrade NGF with zero downtime
4 participants