-
Notifications
You must be signed in to change notification settings - Fork 117
Add description for enabling experimental features #2546
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
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
4ce0535
WIP
bjee19 faf9fbd
WIP
bjee19 975cff2
WIP
bjee19 3828c44
Add link to Gateway API Compatibility document
bjee19 13b61e6
Add callout to specific resources being part of the experimental rele…
bjee19 002087e
Remove inaccurate note on gateway api compatibility guide and add bla…
bjee19 340310d
Add API Release Channel to gateway api compatibility document
bjee19 126f72d
Remove gateway api resources link
bjee19 b5150d5
Add api version and release channel to TCP and UPD routes
bjee19 9f1aba6
Move additional information to install gateway api resources includes…
bjee19 b58bc2c
Add review feedback from docs
bjee19 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
site/content/includes/installation/install-gateway-api-experimental-features.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
title: "Install NGINX Gateway Fabric with experimental features" | ||
docs: "DOCS-000" | ||
--- | ||
|
||
To use Gateway API experimental resources, the Gateway API resources from the experimental channel must be installed before deploying NGINX Gateway Fabric. Additionally, NGINX Gateway Fabric must have experimental features enabled. | ||
|
||
{{< caution >}}As noted in the [Gateway API documentation](https://gateway-api.sigs.k8s.io/guides/#install-experimental-channel), future releases of the Gateway API can include breaking changes to experimental resources and fields. {{</ caution >}} | ||
|
||
To install the Gateway API resources from the experimental channel, run the following: | ||
|
||
```shell | ||
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.4.0" | kubectl apply -f - | ||
``` | ||
|
||
ADubhlaoich marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{{< note >}}If you plan to use the `edge` version of NGINX Gateway Fabric, you can replace the version in `ref` with `main`, for example `ref=main`. {{</ note >}} | ||
|
||
To enable experimental features on NGINX Gateway Fabric: | ||
|
||
Using Helm: Set `nginxGateway.gwAPIExperimentalFeatures.enable` to true. An example can be found | ||
in the [Installation with Helm]({{< relref "installation/installing-ngf/helm.md#custom-installation-options" >}}) guide. | ||
|
||
Using Kubernetes manifests: Add the `--gateway-api-experimental-features` command-line flag to the deployment manifest args. | ||
An example can be found in the [Installation with Kubernetes manifests]({{< relref "installation/installing-ngf/manifests.md#3-deploy-nginx-gateway-fabric" >}}) guide. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.