Skip to content

Conversation

@ADubhlaoich
Copy link
Member

Proposed changes

This commit reworks the manifest installation document to instead become
a folder, with each individual page within covering exactly one use
case. The new structure guides a user completely from end to end on the
process necessary for installing NGINX Gateway Fabric NGINX Open Source
or NGINX Plus without using multiple documents.

It also includes general improvements to specification discoverability,
allowing readers to more easily find what parts of the Gateway API
specification are supported and what to expect from future releases.

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

vepatel and others added 16 commits September 30, 2025 16:38
…s, Configmap, VirtualServer (#1468)

* feat: Add client-body-buffer-size directive to NIC Ingress Annotations, Configmap, VirtualServer

* update descriptions based off pr changes
This commit reworks the manifest installation document to instead become
a folder, with each individual page within covering exactly one use
case. The new structure guides a user completely from end to end on the
process necessary for installing NGINX Gateway Fabric NGINX Open Source
or NGINX Plus without using multiple documents.

It also includes general improvements to specification discoverability,
allowing readers to more easily find what parts of the Gateway API
specification are supported and what to expect from future releases.
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric product/nic Issues related to NGINX Ingress Controller labels Dec 9, 2025
@github-actions
Copy link

github-actions bot commented Dec 9, 2025

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/1551/

@ADubhlaoich ADubhlaoich changed the title feat: Rework Manifest installation paths feat: Rework Manifest installation cases Dec 9, 2025
@ADubhlaoich
Copy link
Member Author

Pushed my latest changes.

Running into issues testing the NGINX Plus deployment: there's no problems in the actual installation process, but the pod never becomes ready due to a crash loop.

The nature of the deployment makes me assume it could be related to the license for the pod.

@ADubhlaoich
Copy link
Member Author

The Plus deployment case now works as expected: I'd been trying to create consistency with Gateway Fabric and Ingress Controller processes.

The latter installs everything (including secrets) to the default namespace, whereas NGINX Gateway Fabric confines it all to its own namespace.

@ADubhlaoich ADubhlaoich linked an issue Dec 10, 2025 that may be closed by this pull request
@ADubhlaoich
Copy link
Member Author

After conferring with the rest of the documentation team, I will be preparing whole documents for the experimental use case, which will be applied to other deployments as part of a design pattern.

I have yet to test the nuances of the cert-manager installation, and will do so after the content work.

@ADubhlaoich
Copy link
Member Author

ADubhlaoich commented Dec 22, 2025

Discovered a missing parameter from the old Manifest documentation when installing the API resources: adding it to the new use case resolves as expected.

Finished testing the open source experimental deployment: tearing down my test deployment and trying the plus experimental deployment use case now.

@ADubhlaoich
Copy link
Member Author

Found an incorrect URL for the NGINX Plus experimental deployment: works as expected!

All that's left is testing the Let's Encrypt certificate documentation to see if it works with a "default" contemporary cert-manager installation, though one of the requirements for testing is... challenging.

@ADubhlaoich ADubhlaoich requested a review from mjang January 15, 2026 11:43
@ADubhlaoich ADubhlaoich requested a review from sjberman January 22, 2026 10:17
Comment on lines +76 to +80
```text
NAME TYPE DATA AGE
nplus-license Opaque 1 31s
nginx-plus-registry-secret kubernetes.io/dockerconfigjson 1 22s
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```text
NAME TYPE DATA AGE
nplus-license Opaque 1 31s
nginx-plus-registry-secret kubernetes.io/dockerconfigjson 1 22s
```
```text
NAME TYPE DATA AGE
nplus-license Opaque 1 31s
nginx-plus-registry-secret kubernetes.io/dockerconfigjson 1 22s

Comment on lines +76 to +80
```text
NAME TYPE DATA AGE
nplus-license Opaque 1 31s
nginx-plus-registry-secret kubernetes.io/dockerconfigjson 1 22s
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```text
NAME TYPE DATA AGE
nplus-license Opaque 1 31s
nginx-plus-registry-secret kubernetes.io/dockerconfigjson 1 22s
```
```text
NAME TYPE DATA AGE
nplus-license Opaque 1 31s
nginx-plus-registry-secret kubernetes.io/dockerconfigjson 1 22s

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 product/ngf Issues related to NGINX Gateway Fabric product/nic Issues related to NGINX Ingress Controller

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Audit]: Install NGF with Manifests

9 participants