Skip to content

Commit da86fea

Browse files
Code cleanup, API v3 stable
1 parent e58bb3e commit da86fea

34 files changed

+219
-6531
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -80,26 +80,25 @@ Two branches are currently available:
8080

8181
## Supported NGINX Plus features
8282

83-
| Feature | API v1 | API v2 | API v3 | Notes |
84-
|----------------------------| - |------|--------------------------|-----------------------------------------------------------------------------------------------|
85-
| Upstreams | X | CRUD | CRUD | Snippets supported: static and from source of truth |
86-
| HTTP servers | X | CRUD | CRUD | Snippets supported (`http`, `servers`, `locations`, `upstreams`: static and from source of truth |
87-
| TCP/UDP servers | X | CRUD | CRUD | Snippets supported (`streams`, `servers`, `upstreams`: static and from source of truth |
88-
| TLS | X | CRUD | CRUD | Certificates and keys can be dynamically fetched from source of truth |
89-
| mTLS | X | CRUD | CRUD | Certificates and keys can be dynamically fetched from source of truth |
90-
| Rate limiting | X | X | X | |
91-
| Active healthchecks | X | X | X | |
92-
| Cookie-based stickiness | X | X | X | |
93-
| Maps | X | X | X | |
94-
| NGINX Plus REST API access | X | X | X | |
95-
| NGINX App Protect WAF | policies & log formats at `server` and `location` level | Per-policy CRUD at `server` and `location` level with dataplane-based bundle compilation | Per-policy CRUD at `server` and `location` level with dataplane-based bundle compilation | Security policies can be dynamically fetched from source of truth |
83+
| Feature | API v3 | Notes |
84+
|----------------------------| ---------------------------|-----------------------------------------------------------------------------------------------|
85+
| Upstreams | CRUD | Snippets supported: static and from source of truth |
86+
| HTTP servers | CRUD | Snippets supported (`http`, `servers`, `locations`, `upstreams`: static and from source of truth |
87+
| TCP/UDP servers | CRUD | Snippets supported (`streams`, `servers`, `upstreams`: static and from source of truth |
88+
| TLS | CRUD | Certificates and keys can be dynamically fetched from source of truth |
89+
| mTLS | CRUD | Certificates and keys can be dynamically fetched from source of truth |
90+
| Rate limiting | X | |
91+
| Active healthchecks | X | |
92+
| Cookie-based stickiness | X | |
93+
| Maps | X | |
94+
| NGINX Plus REST API access | X | |
95+
| NGINX App Protect WAF | Per-policy CRUD at `server` and `location` level with dataplane-based bundle compilation | Security policies can be dynamically fetched from source of truth |
9696

9797
## How to use
9898

9999
Usage details and JSON schema are available here:
100-
- [API v1](/USAGE-v1.md) - deprecated
101-
- [API v2](/USAGE-v2.md) - stable
102-
- [API v3](/USAGE-v3.md) - development
100+
101+
- [API v3](/USAGE-v3.md) - current
103102

104103
A sample Postman collection and usage instructions can be found [here](/contrib/postman)
105104

@@ -142,8 +141,8 @@ Available images are:
142141

143142
| Image name | Architecture | API version | Notes |
144143
|---------------------------------------| ------------ |-------------|------------|
145-
| fiorucci/nginx-declarative-api:v1 | linux/amd64 | v1 | Deprecated |
146-
| fiorucci/nginx-declarative-api:latest | linux/amd64 | v1, v2 | Latest |
144+
| fiorucci/nginx-declarative-api:v3 | linux/amd64 | v3 | Current |
145+
| fiorucci/nginx-declarative-api:latest | linux/amd64 | v3 | Current |
147146

148147
Pre-built images are configured to access the redis instance on host:port `redis:6379`. This can be changed by mounting a custom `config.toml` file on the nginx-dapi container.
149148

USAGE-v1.md

Lines changed: 0 additions & 312 deletions
This file was deleted.

0 commit comments

Comments
 (0)