Skip to content

New "Deploy Data Plane" Installation Doc #3237

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.

Sign up for GitHub

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

Jump to bottom
Open
mpstefan opened this issue Mar 18, 2025 · 0 comments
Open

New "Deploy Data Plane" Installation Doc #3237

mpstefan opened this issue Mar 18, 2025 · 0 comments
Assignees
@bjee19
Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Milestone
v2.0.0

Comments

@mpstefan
Copy link
Member

mpstefan commented Mar 18, 2025 •
edited
Loading

As a user of NGF
I want a doc to explain to me how I can create and configure the data plane for NGF
So that I configure my data plane to fit my environment.

Acceptance

  • A "Deploy the Data Plane" doc is created under the "Install NGINX Gateway Fabric"
    • 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
      • Mention that updating some of these fields will trigger a restart
    • 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)
@mpstefan mpstefan converted this from a draft issue Mar 18, 2025
@mpstefan mpstefan added the documentation Improvements or additions to documentation label Mar 18, 2025
@mpstefan mpstefan added this to the v2.0.0 milestone Mar 18, 2025
@mpstefan mpstefan added refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week labels Apr 21, 2025
@bjee19 bjee19 moved this from 🆕 New to 🏗 In Progress in NGINX Gateway Fabric May 2, 2025
@bjee19 bjee19 self-assigned this May 2, 2025
@bjee19 bjee19 mentioned this issue May 6, 2025
Open
10 tasks
@bjee19 bjee19 moved this from 🏗 In Progress to 👀 In Review in NGINX Gateway Fabric May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bjee19 bjee19

Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Projects
NGINX Gateway Fabric
Status: 👀 In Review
Milestone
v2.0.0
Development

No branches or pull requests
2 participants
@mpstefan @bjee19