Skip to content

Commit 1e1c859

Browse files
authored
Merge branch 'main' into Update-docs-issue147
2 parents b58afba + d809970 commit 1e1c859

File tree

9 files changed

+42
-23
lines changed

9 files changed

+42
-23
lines changed

_banners/agent-v3-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{{< banner "notice" "NGINX Agent 3.0 is now available" >}}
22

33

4-
F5 NGINX One Console and NGINX Instance Manager (NIM) do not currently support Agent 3.x. If you are using NGINX One Console or NGINX Instance Manager in your environment, upgrade to the latest Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
4+
F5 NGINX Instance Manager (NIM) does not currently support Agent 3.x. NGINX Instance Manager customers can upgrade to the latest Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
55

66
Please see the [Technical specifications](/nginx-agent/technical-specifications/) for product compatibility.
77

content/includes/agent/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ Additionally, it collects system-level data, including CPU usage, memory consump
4040
deep observability into NGINX's behavior, enabling teams to troubleshoot issues effectively, optimize performance, and
4141
maintain high availability.
4242

43-
Collected metrics can be seamlessly exported to NGINX One Console or integrated with third-party data aggregators.
43+
By default, the OpenTelemetry Collector is configured to send metrics to NGINX One Console.

content/ngf/install/manifests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,13 @@ Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps.
5454
#### Stable release
5555

5656
```shell
57-
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
57+
kubectl apply --server-side -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
5858
```
5959

6060
#### Edge version
6161

6262
```shell
63-
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/main/deploy/crds.yaml
63+
kubectl apply --server-side -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/main/deploy/crds.yaml
6464
```
6565

6666
### Deploy NGINX Gateway Fabric

content/ngf/install/upgrade-version.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ kubectl kustomize "https://github.com/nginx/nginx-gateway-fabric/config/crd/gate
5353
Run the following command to upgrade the CRDs:
5454

5555
```shell
56-
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
56+
kubectl apply --server-side -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
5757
```
5858

5959
{{< note >}}
@@ -157,7 +157,7 @@ For customization options during the Helm installation process, view the [Instal
157157
Apply the new CRDs with the following command:
158158

159159
```shell
160-
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
160+
kubectl apply --server-side -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
161161
```
162162

163163
Next, install the latest stable release of NGINX Gateway Fabric in the `nginx-gateway` namespace with the following command:

content/ngf/troubleshooting.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -512,6 +512,21 @@ It indicates that `proxy_protocol` is enabled for the gateway listeners, but the
512512

513513
- Send valid proxy information with requests being handled by your application.
514514

515+
#### Custom Resource Definition is invalid due to being too large
516+
517+
If you apply the NGINX Gateway Fabric CRDs and see the following error:
518+
519+
```text
520+
The CustomResourceDefinition "nginxproxies.gateway.nginx.org" is invalid: metadata.annotations: Too long: may not be more than 262144 bytes
521+
```
522+
523+
This is a known issue with Kubernetes, more specifically the client-side-apply annotation limit with kubectl, and our recommended workaround
524+
is to use kubectl's server-side apply when installing the NGINX Gateway Fabric CRDs. To do this, you can use the `--server-side` flag when applying the CRDs:
525+
526+
```shell
527+
kubectl apply --server-side -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
528+
```
529+
515530
### See also
516531

517532
You can view the [Kubernetes Troubleshooting Guide](https://kubernetes.io/docs/tasks/debug/debug-application/) for more debugging guidance.

content/nginx-one/agent/containers/run-agent-container.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,10 @@ container image and create a configuration file.
2929

3030
### Pull the NGINX Agent container image
3131

32-
The NGINX Agent container image must be downloaded from a trusted source such as Docker Hub or a private container registry.
33-
3432
Run the following command to pull the official image:
3533

3634
```bash
37-
<!-- Registry HERE -->
38-
docker pull <Registry HERE>:latest
35+
docker pull private-registry.nginx.com/nginx-plus/agentv3:latest
3936
```
4037

4138
Ensure you are using the correct image version. Replace `latest` with the desired version tag if necessary.

content/nginx-one/connect-instances/connect-nginx-plus-container-images-to-nginx-one.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ sudo docker login private-registry.nginx.com --username=YOUR_JWT_HERE --password
4242

4343
### Pull the NGINX Plus image
4444

45-
Pull the NGINX Plus image from the private registry. Replace `VERSION_TAG` with the desired version, such as `alpine`, `debian`, or `ubi`.
45+
Pull the NGINX Plus image from the private registry. Replace `<version-tag>` with the desired version, such as `alpine`, `debian`, or `ubi`.
4646

4747
```sh
48-
sudo docker pull private-registry.nginx.com/nginx-plus/agent:VERSION_TAG
48+
docker pull private-registry.nginx.com/nginx-plus/agentv3:<version-tag>
4949
```
5050

51-
You must specify a version tag. The `latest` tag is not supported. Learn more in the [Deploying NGINX and NGINX Plus on Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}) guide.
51+
You must specify a version tag that matches your distribution. The `latest` tag is not supported. Learn more in the [Deploying NGINX and NGINX Plus on Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}) guide.
5252

5353
<br>
5454

@@ -62,7 +62,7 @@ sudo docker pull private-registry.nginx.com/nginx-plus/agent:debian
6262

6363
### Start the NGINX Plus container
6464

65-
Start the Docker container to connect it to NGINX One. Replace `YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE` with your data plane key and `VERSION_TAG` with the version tag you pulled.
65+
Start the Docker container to connect it to NGINX One. Replace `YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE` with your data plane key and `version-tag` with the version tag you pulled.
6666

6767
**For NGINX Plus R33 or later**:
6868

@@ -79,7 +79,7 @@ sudo docker run \
7979
--env=NGINX_AGENT_TLS_ENABLE=true \
8080
--restart=always \
8181
--runtime=runc \
82-
-d private-registry.nginx.com/nginx-plus/agent:<VERSION_TAG>
82+
-d private-registry.nginx.com/nginx-plus/agent:<version-tag>
8383
```
8484

8585
<br>

content/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -162,14 +162,9 @@ When adding a new NGINX instance that is not yet registered with NGINX One, you
162162
- From the **OS Type** list, choose the appropriate operating system for your Docker image.
163163
- After selecting the OS, run the provided command to pull the Docker image.
164164

165-
**Note**: Subject to availability, you can modify the `agent: <VERSION_TAG>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agent: r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
165+
**Note**: Subject to availability, you can modify the `agentv3:<version-tag>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agentv3:r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
166166

167167

168-
- From the **OS Type** list, choose the appropriate operating system for your Docker image.
169-
- After selecting the OS, run the provided command to pull the Docker image.
170-
171-
**Note**: Subject to availability, you can modify the `agent: <VERSION_TAG>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agent: r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
172-
173168
10. Run the provided command, which includes the data plane key, in your NGINX instance terminal to start the Docker container.
174169

175170
11. Select **Done** to complete the process.

content/nginx/admin-guide/installing-nginx/installing-nginx-docker.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,24 +156,36 @@ For NGINX Plus, run:
156156
docker pull private-registry.nginx.com/nginx-plus/base:<version-tag>
157157
```
158158

159-
For NGINX Plus with NGINX Agent, run:
159+
For NGINX Plus with NGINX Agent version 2, run:
160160

161161
```shell
162162
docker pull private-registry.nginx.com/nginx-plus/agent:<version-tag>
163163
```
164164

165+
For NGINX Plus with NGINX Agent version 3, run:
166+
167+
```shell
168+
docker pull private-registry.nginx.com/nginx-plus/agentv3:<version-tag>
169+
```
170+
165171
For NGINX Plus installed from `nginx` user (rootless installation), run:
166172

167173
```shell
168174
docker pull private-registry.nginx.com/nginx-plus/rootless-base:<version-tag>
169175
```
170176

171-
For NGINX Plus with NGINX Agent installed from `nginx` user (rootless installation), run:
177+
For NGINX Plus with NGINX Agent version 2 installed from `nginx` user (rootless installation), run:
172178

173179
```shell
174180
docker pull private-registry.nginx.com/nginx-plus/rootless-agent:<version-tag>
175181
```
176182

183+
For NGINX Plus with NGINX Agent version 3 installed from `nginx` user (rootless installation), run:
184+
185+
```shell
186+
docker pull private-registry.nginx.com/nginx-plus/rootless-agentv3:<version-tag>
187+
```
188+
177189
For NGINX modules, run:<!-- Is this enough info?-->
178190

179191
```shell

0 commit comments

Comments
 (0)