Skip to content

Commit 71f6077

Browse files
ADubhlaoichnginx-jack
ADubhlaoich
authored and
nginx-jack
committed
feat: Update tables
This commit updates tables across the NGINX documentation set by removing the old bootstrap shortcode or replacing it with the new table one. Mainframe has better sensible defaults, so the scaffolding provided by the bootstrap shortcode is no longer necessary.
1 parent 1f44bb7 commit 71f6077

25 files changed

+118
-339
lines changed

‎content/agent/about.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ For NGINX Agent to work properly with an NGINX Plus instance, the API needs to b
4646
NGINX Agent allows a gRPC connected control system to register a listener for a specific event. The control mechanism is then invoked when NGINX Agent sends an associated system signal. The source of a notification can be either the NGINX instance or NGINX Agent itself. Here's a list of currently supported events:
4747

4848

49-
{{<bootstrap-table "table table-striped table-bordered">}}
5049
| Event | Description |
5150
| -------------------------------- | -------------------------------------------- |
5251
| AGENT_START_MESSAGE | Agent process started |
@@ -61,7 +60,6 @@ NGINX Agent allows a gRPC connected control system to register a listener for a
6160
| CONFIG_APPLY_FAILURE_MESSAGE | Failed to apply new NGINX configuration |
6261
| CONFIG_ROLLBACK_SUCCESS_MESSAGE | Successfully rolled back NGINX configuration |
6362
| CONFIG_ROLLBACK_FAILURE_MESSAGE | Failed to roll back NGINX configuration |
64-
{{</bootstrap-table>}}
6563

6664

6765

‎content/agent/configuration/configuration-overview.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ If you are upgrading from an older version, update your configuration accordingl
177177

178178
{{< /call-out >}}
179179

180-
{{<bootstrap-table "table table-responsive table-bordered">}}
180+
{{< table >}}
181181
| CLI flag | Environment variable | Description |
182182
|---------------------------------------------|--------------------------------------|-----------------------------------------------------------------------------|
183183
| `--api-cert` | `NGINX_AGENT_API_CERT` | Specifies the certificate used by the Agent API. |
@@ -214,9 +214,7 @@ If you are upgrading from an older version, update your configuration accordingl
214214
| `--tls-enable` | `NGINX_AGENT_TLS_ENABLE` | Enables TLS for secure communications. |
215215
| `--tls-key` | `NGINX_AGENT_TLS_KEY` | Specifies the path to the certificate key file for TLS. |
216216
| `--tls-skip-verify` | `NGINX_AGENT_TLS_SKIP_VERIFY` | Insecurely skips verification for gRPC TLS credentials. |
217-
{{</bootstrap-table>}}
218-
219-
<br>
217+
{{< /table >}}
220218

221219
{{< call-out "note" >}}
222220
Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane.

‎content/agent/installation-upgrade/container-environments/docker-images.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,15 +175,12 @@ The NGINX Agent GitHub repo has a set of Make commands that you can use to build
175175
176176
You can pass the following arguments when running the **make** command to build an NGINX Agent container image.
177177
178-
{{<bootstrap-table "table table-striped table-border">}}
179178
| Argument | Definition |
180179
| ---------------- | -------------------------|
181180
| OS_RELEASE | The Linux distribution to use as the base image. <br>Can also be set in the repo Makefile.|
182181
| OS_VERSION | The version of the Linux distribution to use as the base image. <br>Can also be set in the repo Makefile.|
183182
| AGENT_VERSION | The versions of NGINX agent that you want installed on the image.|
184183
185-
{{</bootstrap-table>}}
186-
187184
### Build NGINX open source images
188185
189186
Run the following `make` command to build the default image, which uses Alpine as the base image:

‎content/agent/installation-upgrade/installation-unprivileged.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,13 @@ After installing NGINX Plus, you can install NGINX agent following the steps on
4242

4343
Run the command corresponding to your operating system to start NGINX Agent:
4444

45-
{{<bootstrap-table "table table-striped table-bordered">}}
4645

4746
| Operating System | Command(s) |
4847
|------------------------------------------------------|------------------------------------------------|
4948
| RHEL, CentOS,<br>Rocky Linux, AlmaLinux,<br>Oracle Linux, Ubuntu,<br>Debian, SLES, Amazon Linux | ```sudo systemctl start nginx-agent``` |
5049
| Alpine Linux | ```sudo rc-service nginx-agent start```<br>or<br>```sudo /etc/init.d/nginx-agent start``` |
5150
| FreeBSD | ```sudo service nginx-agent start``` |
5251

53-
{{</bootstrap-table>}}
54-
5552
You can confirm that NGINX Agent is running under the same user as NGINX Plus by running the following command:
5653

5754
```bash

‎content/agent/technical-specifications.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,28 @@ This document describes the requirements for NGINX Agent version 2.
1111
This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
1212

1313
## NGINX Agent 3.0 Compatibility
14-
{{< bootstrap-table "table table-striped table-bordered" >}}
14+
1515
| NGINX Product | Agent Version |
1616
|------------------------------|----------------|
1717
| **NGINX One Console** | 3.x |
1818
| **NGINX Gateway Fabric** | 3.x |
1919
| **NGINX Plus** | 2.x, 3.x |
2020
| **NGINX Ingress Controller** | 2.x, 3.x |
2121
| **NGINX Instance Manager** | 2.x |
22-
{{< /bootstrap-table >}}
2322

2423
## Supported Distributions
2524

2625
NGINX Agent can run in most environments. We support the following distributions:
2726

28-
{{< bootstrap-table "table table-striped table-bordered" >}}
2927
| | AlmaLinux | Alpine Linux | Amazon Linux | Amazon Linux 2| Debian |
3028
|-|-----------|--------------|--------------|----------------|--------|
3129
|**Version**|8 <br><hr>9 <br><hr>10| 3.19<br><hr>3.20<br><hr> 3.21<br><hr> 3.22| 2023| LTS| 11<br><hr> 12|
3230
|**Architecture**| x86_84<br><hr>aarch64| x86_64<br><hr>aarch64 | x86_64<br><hr>aarch64 | x86_64<br><hr>aarch64 | x86_64<br><hr>aarch64 | x86_64<br><hr>aarch64 |
33-
{{< /bootstrap-table >}}
3431

35-
{{< bootstrap-table "table table-striped table-bordered" >}}
3632
| |FreeBSD | Oracle Linux | Red Hat <br>Enterprise Linux <br>(RHEL) | Rocky Linux | SUSE Linux <br>Enterprise Server <br>(SLES) | Ubuntu |
3733
|-|--------|--------------|---------------------------------|-------------|-------------------------------------|--------|
3834
|**Version**|13<br><hr>14|8.1+<br><hr>9<br><hr>10|8.1+<br><hr>9.0+<br><hr>10|8<br><hr>9<br><hr>10|15 SP2|22.04 LTS<br><hr>24.04 LTS<br><hr>25.04 LTS|
3935
|**Architecture**|amd64|x86_64|x86_64<br><hr>aarch64|x86_64<br><hr>aarch64|x86_64|x86_64<br><hr>aarch64|
40-
{{< /bootstrap-table >}}
4136

4237

4338
## Supported deployment environments
@@ -57,11 +52,10 @@ NGINX Agent works with all supported versions of NGINX Open Source and NGINX Plu
5752
## Sizing recommendations
5853

5954
Minimum system sizing recommendations for NGINX Agent:
60-
{{< bootstrap-table "table table-striped table-bordered" >}}
55+
6156
| CPU | Memory | Network | Storage |
6257
|------------|----------|-----------|---------|
6358
| 1 CPU core | 1 GB RAM | 1 GbE NIC | 20 GB |
64-
{{< /bootstrap-table >}}
6559

6660
## Logging
6761

‎content/amplify/known-issues.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ nd-docs: DOCS-1692
1212

1313
### {{% icon-bug %}} Unable to add some NGINX HTTP requests metrics to custom graph {#631}
1414

15-
{{<bootstrap-table "table table-striped table-bordered">}}
1615
| Issue ID | Status |
1716
|----------|--------|
1817
| 631 | Open |
19-
{{</bootstrap-table>}}
2018

2119
#### Description
2220

‎content/ngf/overview/custom-policies.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,13 @@ These custom policies follow the Gateway API [Policy Attachment](https://gateway
1515
Policies are a Kubernetes object that augments the behavior of an object in a standard way. Policies can be attached to one object ([Direct Policy Attachment](#direct-policy-attachment)) or objects in a hierarchy ([Inherited Policy Attachment](#inherited-policy-attachment)).
1616
The following table summarizes NGINX Gateway Fabric custom policies:
1717

18-
{{< bootstrap-table "table table-striped table-bordered" >}}
1918

2019
| Policy | Description | Attachment Type | Supported Target Object(s) | Supports Multiple Target Refs | Mergeable | API Version |
2120
|---------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|-------------------------------|-------------------------------|-----------|-------------|
2221
| [ClientSettingsPolicy]({{< ref "/ngf/traffic-management/client-settings.md" >}}) | Configure connection behavior between client and NGINX | Inherited | Gateway, HTTPRoute, GRPCRoute | No | Yes | v1alpha1 |
2322
| [ObservabilityPolicy]({{< ref "/ngf/monitoring/tracing.md" >}}) | Define settings related to tracing, metrics, or logging | Direct | HTTPRoute, GRPCRoute | Yes | No | v1alpha2 |
2423
| [UpstreamSettingsPolicy]({{< ref "/ngf/traffic-management/upstream-settings.md" >}}) | Configure connection behavior between NGINX and backend | Direct | Service | Yes | Yes | v1alpha1 |
2524

26-
{{< /bootstrap-table >}}
27-
2825
{{< call-out "important" >}}
2926
If attaching a Policy to a Route, that Route must not share a hostname:port/path combination with any other Route that is not referenced by the same Policy. If it does, the Policy will be rejected. This is because the Policy would end up affecting other Routes that it is not attached to.
3027
{{< /call-out >}}

‎content/ngf/overview/gateway-api-compatibility.md

Lines changed: 22 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ Learn which Gateway API resources NGINX Gateway Fabric supports and to which lev
1111

1212
## Summary
1313

14-
{{< bootstrap-table "table table-striped table-bordered" >}}
15-
14+
{{< table >}}
1615
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
1716
|---------------------------------------|---------------------|------------------------|---------------------------------------|-------------|---------------------|
1817
| [GatewayClass](#gatewayclass) | Supported | Not supported | Supported | v1 | Standard |
@@ -25,8 +24,7 @@ Learn which Gateway API resources NGINX Gateway Fabric supports and to which lev
2524
| [UDPRoute](#udproute) | Not supported | Not supported | Not supported | v1alpha2 | Experimental |
2625
| [BackendTLSPolicy](#backendtlspolicy) | Partially Supported | Supported | Partially supported | v1alpha3 | Experimental |
2726
| [Custom policies](#custom-policies) | N/A | N/A | Supported | N/A | N/A |
28-
29-
{{< /bootstrap-table >}}
27+
{{< /table >}}
3028

3129
## Terminology
3230

@@ -49,13 +47,11 @@ For a description of each field, visit the [Gateway API documentation](https://g
4947

5048
### GatewayClass
5149

52-
{{< bootstrap-table "table table-striped table-bordered" >}}
53-
50+
{{< table >}}
5451
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
5552
|--------------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
5653
| GatewayClass | Supported | Not supported | Supported | v1 | Standard |
57-
58-
{{< /bootstrap-table >}}
54+
{{< /table >}}
5955

6056
NGINX Gateway Fabric supports a single GatewayClass resource configured with the `--gatewayclass` flag of the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command.
6157

@@ -77,13 +73,11 @@ NGINX Gateway Fabric supports a single GatewayClass resource configured with the
7773

7874
### Gateway
7975

80-
{{< bootstrap-table "table table-striped table-bordered" >}}
81-
76+
{{< table >}}
8277
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
8378
|----------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
8479
| Gateway | Supported | Partially supported | Not supported | v1 | Standard |
85-
86-
{{< /bootstrap-table >}}
80+
{{< /table >}}
8781

8882
NGINX Gateway Fabric supports multiple Gateway resources. The Gateway resources must reference NGINX Gateway Fabric's corresponding GatewayClass.
8983

@@ -144,14 +138,11 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
144138

145139
### HTTPRoute
146140

147-
{{< bootstrap-table "table table-striped table-bordered" >}}
148-
141+
{{< table >}}
149142
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
150143
|-----------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
151144
| HTTPRoute | Supported | Partially supported | Not supported | v1 | Standard |
152-
153-
{{< /bootstrap-table >}}
154-
145+
{{< /table >}}
155146
**Fields**:
156147

157148
- `spec`
@@ -196,13 +187,11 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
196187

197188
### GRPCRoute
198189

199-
{{< bootstrap-table "table table-striped table-bordered" >}}
200-
190+
{{< table >}}
201191
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
202192
|-----------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
203193
| GRPCRoute | Supported | Partially supported | Not supported | v1 | Standard |
204-
205-
{{< /bootstrap-table >}}
194+
{{< /table >}}
206195

207196
**Fields**:
208197

@@ -241,13 +230,11 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
241230

242231
### ReferenceGrant
243232

244-
{{< bootstrap-table "table table-striped table-bordered" >}}
245-
233+
{{< table >}}
246234
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
247235
|----------------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
248236
| ReferenceGrant | Supported | N/A | Not supported | v1beta1 | Standard |
249-
250-
{{< /bootstrap-table >}}
237+
{{< /table >}}
251238

252239
Fields:
253240

@@ -263,13 +250,11 @@ Fields:
263250

264251
### TLSRoute
265252

266-
{{< bootstrap-table "table table-striped table-bordered" >}}
267-
253+
{{< table >}}
268254
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
269255
|----------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
270256
| TLSRoute | Supported | Not supported | Not supported | v1alpha2 | Experimental |
271-
272-
{{< /bootstrap-table >}}
257+
{{< /table >}}
273258

274259
**Fields**:
275260

@@ -303,33 +288,27 @@ Fields:
303288

304289
### TCPRoute
305290

306-
{{< bootstrap-table "table table-striped table-bordered" >}}
307-
291+
{{< table >}}
308292
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
309293
|----------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
310294
| TCPRoute | Not supported | Not supported | Not supported | v1alpha2 | Experimental |
311-
312-
{{< /bootstrap-table >}}
295+
{{< /table >}}
313296

314297
### UDPRoute
315298

316-
{{< bootstrap-table "table table-striped table-bordered" >}}
317-
299+
{{< table >}}
318300
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
319301
|----------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
320302
| UDPRoute | Not supported | Not supported | Not supported | v1alpha2 | Experimental |
321-
322-
{{< /bootstrap-table >}}
303+
{{< /table >}}
323304

324305
### BackendTLSPolicy
325306

326-
{{< bootstrap-table "table table-striped table-bordered" >}}
327-
307+
{{< table >}}
328308
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
329309
|------------------|---------------------|------------------------|---------------------------------------|-------------|---------------------|
330310
| BackendTLSPolicy | Partially Supported | Supported | Partially Supported | v1alpha3 | Experimental |
331-
332-
{{< /bootstrap-table >}}
311+
{{< /table >}}
333312

334313
Fields:
335314

@@ -359,13 +338,11 @@ Fields:
359338

360339
### Custom Policies
361340

362-
{{< bootstrap-table "table table-striped table-bordered" >}}
363-
341+
{{< table >}}
364342
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
365343
|-----------------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
366344
| Custom policies | N/A | N/A | Supported | N/A | N/A |
367-
368-
{{< /bootstrap-table >}}
345+
{{< /table >}}
369346

370347
Custom policies are NGINX Gateway Fabric-specific CRDs (Custom Resource Definitions) that support features such as tracing, and client connection settings. These important data-plane features are not part of the Gateway API specifications.
371348
While these CRDs are not part of the Gateway API, the mechanism to attach them to Gateway API resources is part of the Gateway API. See the [Policy Attachment documentation](https://gateway-api.sigs.k8s.io/references/policy-attachment/).

0 commit comments

Comments
 (0)