Skip to content

Documentation: NGINX as data plane #562

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

Closed
ja20222 opened this issue Apr 5, 2023 · 1 comment
Closed

Documentation: NGINX as data plane #562

ja20222 opened this issue Apr 5, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@ja20222
Copy link

ja20222 commented Apr 5, 2023

NKG uses NGINX as a data plane. While the configuration aspect of the data plane is hidden behind the Gateway API resources, it is only one aspect - we also have the operational aspect as well as troubleshooting, debugging and monitoring ones.

We need to make sure our NKG users are prepared to deal with NGINX - understand how it behaves and misbehaves in the context of NKG, so that they can configure and manage NGINX with high performance and reliability.

A documentation guide will help to prepare the users. The guide will:

  • Explain the minimal NGINX knowledge NKG user and point to helpful resources for learning.
  • Explain how exactly NGINX is used (potentially linking to a separate architecture/how it works guide)
  • Explain how NGINX operates considering the architecture and configuration by the control plane (ex. pod resources, number of configuration reloads, etc.)
  • Explain NGINX high levels of the generated configuration and how trouble shoot it when things don’t work.
@pleshakov pleshakov added the documentation Improvements or additions to documentation label Apr 7, 2023
@pleshakov pleshakov added this to the v1.0.0 milestone Apr 7, 2023
@mpstefan mpstefan modified the milestones: v1.0.0, v0.6.0 Jun 2, 2023
@mpstefan
Copy link
Member

What is missing in this story should be covered by #551

@mpstefan mpstefan closed this as not planned Won't fix, can't repro, duplicate, stale Jul 17, 2023
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
None yet
Development

No branches or pull requests

3 participants