You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a user of NGF
I want all the NGF documentation to be updated to reflect the new architecture
So that I understand how the architecture impacts my use of NGF as I consume documentation content.
Acceptance
Update all examples where we are accessing containers
How to guides, how to send traffic
Architecture doc
To reflect new architecture
Can we get a redraw of our diagram? Marketing help?
Update the pod readiness section
Document control plane scaling risks
if nginx instances connect to a non-leader control plane pod, status of config apply won't be seen because only the leader can write statuses to Gateway resources
Mention TLS certificates for control plane -> agent communication in install docs
by default, we use self-signed certs that are not rotated
recommend users integrate cert-manager for deploying these certificates in a production environment
New "Deploy data plane" installation doc
can briefly discuss how to create a Gateway to provision nginx
mention that we support multiple gateways
mention how to configure labels/annotations on the provisioned resources
mention how NginxProxy contains fields for configuring the resources
further links to Data plane config doc, API reference, and how to guides
NginxProxy is created by default, this should be mentioned (data plane doc should talk about editing the default NginxProxy at the GatewayClass level)
Enhance data plane doc (or create new doc) discussing setting Deployment fields in NginxProxy, and the implications of this (deployment will be restarted)
Cover enhancements to the NginxProxy resource
Gateway compatibility doc
GatewayInfrastructure (Labels you want to apply)
GatewayParametersRef??
Include somewhere to talk about how to apply labels to the data plane pods that are provisioned.
Allow user the ability to configure the NodePorts we provision
Getting started doc needs to be changed to use new Service type
We are going to provision the NodePorts for the user. We need to change the guide to ensure kind stills works.
Add doc for how to upgrade from 1.6 to 2.0
Add header note to all docs for pre-2.0 users to access their docs in the Github repo (since we don't have versioned docs published)
Any helm values that changed are updated properly
Any where in the docs where we reference Helm charts
Installation, etc
The text was updated successfully, but these errors were encountered:
As a user of NGF
I want all the NGF documentation to be updated to reflect the new architecture
So that I understand how the architecture impacts my use of NGF as I consume documentation content.
Acceptance
Update all examples where we are accessing containers
Architecture doc
Document control plane scaling risks
Mention TLS certificates for control plane -> agent communication in install docs
New "Deploy data plane" installation doc
NginxProxy is created by default, this should be mentioned (data plane doc should talk about editing the default NginxProxy at the GatewayClass level)
Enhance data plane doc (or create new doc) discussing setting Deployment fields in NginxProxy, and the implications of this (deployment will be restarted)
Gateway compatibility doc
Allow user the ability to configure the NodePorts we provision
Add doc for how to upgrade from 1.6 to 2.0
Add header note to all docs for pre-2.0 users to access their docs in the Github repo (since we don't have versioned docs published)
Any helm values that changed are updated properly
The text was updated successfully, but these errors were encountered: