Skip to content

Commit a305c7a

Browse files
20240814 - NGINX One Cloud Console early access finalized (#68)
1 parent 59ea39a commit a305c7a

9 files changed

+333
-97
lines changed

FEATURES.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
NGINX Declarative API has been tested with the following NGINX control plane releases:
66

7-
| Control plane | API v4.2 | API v5.0 | API v5.1 | Notes |
8-
|--------------------------|----------|--------------|--------------|------------------------|
9-
| NGINX Instance Manager | 2.14+ | 2.14+ | 2.16+ | |
10-
| NGINX One Cloud Console | | Early access | Early access | Early stage / unstable |
7+
| Control plane | API v4.2 | API v5.0 | API v5.1 | Notes |
8+
|--------------------------|----------|--------------|--------------|---------------|
9+
| NGINX Instance Manager | 2.14+ | 2.14+ | 2.16+ | |
10+
| NGINX One Cloud Console | | Early access | Early access | Early access |
1111

1212

1313
### NGINX `http` and `stream` servers

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
44

5-
This project provides a set of declarative REST API for [NGINX Instance Manager](https://docs.nginx.com/nginx-management-suite/nim/) and [NGINX One Cloud Console](https://docs.nginx.com/nginx-one/) (currently in early stage / unstable).
5+
This project provides a set of declarative REST API for [NGINX Instance Manager](https://docs.nginx.com/nginx-management-suite/nim/) and [NGINX One Cloud Console](https://docs.nginx.com/nginx-one/)
66

77
It can be used to manage NGINX Plus configuration lifecycle and to create NGINX Plus configurations using JSON service definitions.
88

@@ -28,7 +28,7 @@ A **blog article** to automate NGINX API Gateway management from OpenAPI schemas
2828
## Supported releases
2929

3030
- NGINX Instance Manager 2.14+
31-
- NGINX One Cloud Console (early stage / unstable)
31+
- NGINX One Cloud Console Early Access
3232
- NGINX Plus R30+
3333
- NGINX App Protect WAF 4
3434

USAGE-v5.1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Version 5.1 supports:
44

55
- [NGINX Instance Manager](https://docs.nginx.com/nginx-management-suite/nim/) 2.14+
6-
- [NGINX One Cloud Console](https://docs.nginx.com/nginx-one/) - early stage / unstable
6+
- [NGINX One Cloud Console](https://docs.nginx.com/nginx-one/) - Early Access
77
- [NGINX Plus](https://docs.nginx.com/nginx/) R30+
88
- [NGINX App Protect WAF](https://docs.nginx.com/nginx-app-protect-waf/) 4 with precompiled [policy bundles](https://docs.nginx.com/nginx-app-protect-waf/v5/admin-guide/compiler/)
99

contrib/postman/NGINX Declarative API.postman_collection.json

+317-87
Large diffs are not rendered by default.

src/V5_1_NginxConfigDeclaration.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -786,7 +786,7 @@ class DevPortal_Redocly(BaseModel, extra="forbid"):
786786

787787

788788
class DevPortal_Backstage(BaseModel, extra="forbid"):
789-
name: str
789+
name: str = ""
790790
lifecycle: Optional[str] = "production"
791791
owner: str = ""
792792
system: Optional[str] = ""

src/v5_1/NGINXOneOutput.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def NGINXOneOutput(d, declaration: ConfigDeclaration, apiversion: str, b64HttpCo
4141
# NGINX Instance Manager Staged Configuration publish
4242

4343
nOneToken = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.token')
44-
nOneCluster = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.cluster')
44+
nOneConfigSyncGroup = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.configsyncgroup')
4545
nOneNamespace = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.namespace')
4646

4747
nOneSynctime = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.synctime')
@@ -187,7 +187,7 @@ def NGINXOneOutput(d, declaration: ConfigDeclaration, apiversion: str, b64HttpCo
187187

188188
# Get the instance group id nOneUrl: str, nOneTokenUsername: str, nameSpace: str, clusterName: str
189189
returnCode, igUid = v5_1.NGINXOneUtils.getConfigSyncGroupId(nOneUrl = nOneUrl, nOneToken = nOneToken,
190-
nameSpace = nOneNamespace, configSyncGroupName = nOneCluster)
190+
nameSpace = nOneNamespace, configSyncGroupName = nOneConfigSyncGroup)
191191

192192
# Invalid instance group
193193
if returnCode != 200:

templates/v5.1/misc/resolver.tmpl

+2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1+
# DNS resolver template
2+
13
resolver {{ resolverprofile.address }}{% if resolverprofile.valid %}valid={{ resolverprofile.valid }}{% endif %} ipv4={% if resolverprofile.ipv4 == True %}on{% else %}off{% endif %} ipv6={% if resolverprofile.ipv6 == True %}on{% else %}off{% endif %};
24
{% if resolverprofile.timeout %}resolver_timeout {{ resolverprofile.timeout }}{% endif %};

templates/v5.1/misc/upstream-http.tmpl

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# HTTP upstream template
2+
13
{% if u.name %}
24
{% if u.origin %}
35
upstream {{ u.name }} {

templates/v5.1/misc/upstream-stream.tmpl

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Stream upstream template
2+
13
{% if u.name %}
24
{% if u.origin %}
35
upstream {{ u.name }} {

0 commit comments

Comments
 (0)