-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
8 additions
and
7 deletions.
There are no files selected for viewing
9 changes: 5 additions & 4 deletions
9
site/content/includes/installation/install-gateway-api-experimental-features.md
This file contains 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 |
---|---|---|
@@ -1,23 +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>}} | ||
{{< 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 - | ||
``` | ||
|
||
{{<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>}} | ||
{{< 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: | ||
|
||
If using Helm: The `nginxGateway.gwAPIExperimentalFeatures.enable` option must be set to true. An example can be found | ||
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. | ||
|
||
If using Kubernetes manifests: The `--gateway-api-experimental-features` command-line flag must be set to true on the deployment manifest. | ||
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 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