20240814 - NGINX One Cloud Console early access finalized (#68)

f5devcentral · Aug 14, 2024 · a305c7a · a305c7a
1 parent 59ea39a
commit a305c7a
Show file tree

Hide file tree

Showing 9 changed files with 333 additions and 97 deletions.
diff --git a/FEATURES.md b/FEATURES.md
@@ -4,10 +4,10 @@
 
 NGINX Declarative API has been tested with the following NGINX control plane releases:
 
-| Control plane            | API v4.2 | API v5.0     | API v5.1     | Notes                  |
-|--------------------------|----------|--------------|--------------|------------------------|
-| NGINX Instance Manager   |  2.14+   | 2.14+        | 2.16+        |                        |
-| NGINX One Cloud Console  |          | Early access | Early access | Early stage / unstable |
+| Control plane            | API v4.2 | API v5.0     | API v5.1     | Notes         |
+|--------------------------|----------|--------------|--------------|---------------|
+| NGINX Instance Manager   |  2.14+   | 2.14+        | 2.16+        |               |
+| NGINX One Cloud Console  |          | Early access | Early access | Early access  |
 
 
 ### NGINX `http` and `stream` servers

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![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)
 
-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).
+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/)
 
 It can be used to manage NGINX Plus configuration lifecycle and to create NGINX Plus configurations using JSON service definitions.
 
@@ -28,7 +28,7 @@ A **blog article** to automate NGINX API Gateway management from OpenAPI schemas
 ## Supported releases
 
 - NGINX Instance Manager 2.14+
-- NGINX One Cloud Console (early stage / unstable)
+- NGINX One Cloud Console Early Access
 - NGINX Plus R30+
 - NGINX App Protect WAF 4
 

diff --git a/USAGE-v5.1.md b/USAGE-v5.1.md
@@ -3,7 +3,7 @@
 Version 5.1 supports:
 
 - [NGINX Instance Manager](https://docs.nginx.com/nginx-management-suite/nim/) 2.14+
-- [NGINX One Cloud Console](https://docs.nginx.com/nginx-one/) - early stage / unstable
+- [NGINX One Cloud Console](https://docs.nginx.com/nginx-one/) - Early Access
 - [NGINX Plus](https://docs.nginx.com/nginx/) R30+
 - [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/)
 

diff --git a/contrib/postman/NGINX Declarative API.postman_collection.json b/contrib/postman/NGINX Declarative API.postman_collection.json
diff --git a/src/V5_1_NginxConfigDeclaration.py b/src/V5_1_NginxConfigDeclaration.py
@@ -786,7 +786,7 @@ class DevPortal_Redocly(BaseModel, extra="forbid"):
 
 
 class DevPortal_Backstage(BaseModel, extra="forbid"):
-    name: str
+    name: str = ""
     lifecycle: Optional[str] = "production"
     owner: str = ""
     system: Optional[str] = ""

diff --git a/src/v5_1/NGINXOneOutput.py b/src/v5_1/NGINXOneOutput.py
@@ -41,7 +41,7 @@ def NGINXOneOutput(d, declaration: ConfigDeclaration, apiversion: str, b64HttpCo
     # NGINX Instance Manager Staged Configuration publish
 
     nOneToken = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.token')
-    nOneCluster = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.cluster')
+    nOneConfigSyncGroup = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.configsyncgroup')
     nOneNamespace = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.namespace')
 
     nOneSynctime = v5_1.MiscUtils.getDictKey(d, 'output.nginxone.synctime')
@@ -187,7 +187,7 @@ def NGINXOneOutput(d, declaration: ConfigDeclaration, apiversion: str, b64HttpCo
 
         # Get the instance group id nOneUrl: str, nOneTokenUsername: str, nameSpace: str, clusterName: str
         returnCode, igUid = v5_1.NGINXOneUtils.getConfigSyncGroupId(nOneUrl = nOneUrl, nOneToken = nOneToken,
-                                                nameSpace = nOneNamespace, configSyncGroupName = nOneCluster)
+                                                nameSpace = nOneNamespace, configSyncGroupName = nOneConfigSyncGroup)
 
         # Invalid instance group
         if returnCode != 200:

diff --git a/templates/v5.1/misc/resolver.tmpl b/templates/v5.1/misc/resolver.tmpl
@@ -1,2 +1,4 @@
+# DNS resolver template
+
 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 %};
 {% if resolverprofile.timeout %}resolver_timeout {{ resolverprofile.timeout }}{% endif %};
diff --git a/templates/v5.1/misc/upstream-http.tmpl b/templates/v5.1/misc/upstream-http.tmpl
@@ -1,3 +1,5 @@
+# HTTP upstream template
+
 {% if u.name %}
 {% if u.origin %}
 upstream {{ u.name }} {

diff --git a/templates/v5.1/misc/upstream-stream.tmpl b/templates/v5.1/misc/upstream-stream.tmpl
@@ -1,3 +1,5 @@
+# Stream upstream template
+
 {% if u.name %}
 {% if u.origin %}
 upstream {{ u.name }} {