Skip to content

Commit 2555f85

Browse files
miledxzsjbermankate-osborn
committed
Improve provisioner docs (nginx#741)
Problem: It is not obvious that it is necessary to re-build the NKG image to customize the static mode Deployment, which the provisioner uses. Solution: Make the docs clearer. --------- Co-authored-by: Saylor Berman <s.berman@f5.com> Co-authored-by: Kate Osborn <50597707+kate-osborn@users.noreply.github.com>
1 parent d3ae4dd commit 2555f85

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

conformance/provisioner/provisioner.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,14 @@ Global Flags:
1515
--gatewayclass string The name of the GatewayClass resource. Every NGINX Gateway must have a unique corresponding GatewayClass resource. (default "")
1616
```
1717

18-
Provisioner is not meant to be used in production yet (see this issue for more details
18+
> Note: Provisioner is not ready for production yet (see this issue for more details
1919
https://github.com/nginxinc/nginx-kubernetes-gateway/issues/634). However, it can be used in the Gateway API conformance
2020
tests, which expect a Gateway API implementation to provision an independent data plane per Gateway.
2121

22+
> Note: Provisioner uses [this manifest](/deploy/manifests/deployment.yaml) to create an NKG static mode Deployment.
23+
This manifest gets included into the NKG binary during the NKG build. To customize the Deployment, modify the manifest
24+
and **re-build** NKG.
25+
2226
How to deploy:
2327

2428
1. Follow the [installation](/docs/installation.md) instructions up until the Deploy the NGINX Kubernetes Gateway Step

0 commit comments

Comments
 (0)