Added Developer Portal support

Author: fabriziofiorucci

README.md

@@ -1,17 +1,18 @@
 # NGINX-Declarative-API
 
-This tool provides a set of declarative REST API for NGINX Instance Manager.
+This project provides a set of declarative REST API for [NGINX Instance Manager](https://docs.nginx.com/nginx-management-suite/nim/).
 
 It can be used to manage NGINX Plus configuration lifecycle and to create NGINX Plus configurations using JSON service definitions.
 
-GitOps integration is supported when used with NGINX Instance Manager: source of truth is checked for updates (NGINX App Protect policies, TLS certificates, keys and chains/bundles) and NGINX configurations are automatically kept in sync.
+GitOps integration is supported when used with NGINX Instance Manager: source of truth is checked for updates (NGINX App Protect policies, TLS certificates, keys and chains/bundles, Swagger/OpenAPI definitions) and NGINX configurations are automatically kept in sync.
 
 Use cases include:
 
 - Rapid configuration generation and templating
 - CI/CD integration with NGINX Instance Manager (instance groups and staged configs)
 - NGINX App Protect DevSecOps integration
 - API Gateway deployments with automated Swagger / OpenAPI schemas import
+- API Developer portals zero-touch deployment
 - GitOps integration with source of truth support for
   - NGINX App Protect WAF policies
   - TLS certificates, keys and chains/bundles
@@ -22,7 +23,7 @@ Use cases include:
 
 ## Requirements
 
-- NGINX Instance Manager 2.10+
+- NGINX Instance Manager 2.14+
 - NGINX Plus R30 or newer
 
 ## Architecture
@@ -100,42 +101,26 @@ Usage details and JSON schema are available here:
 
 A sample Postman collection and usage instructions can be found [here](/contrib/postman)
 
-### Using docker-compose
+## How to run
 
-This is the recommended method to run NGINX Declarative API on a Linux virtual machine. Refer to [installation instructions](https://github.com/fabriziofiorucci/NGINX-Declarative-API/tree/main/contrib/docker-compose)
+Docker-compose is the recommended method to run NGINX Declarative API on a Linux virtual machine. Full details are available [here](https://github.com/fabriziofiorucci/NGINX-Declarative-API/tree/main/contrib/docker-compose)
 
-### As a Python application
+## Building Docker images
 
-This repository requires Python 3.10+
-A running instance of [redis](https://redis.io/) is required: redis host and port can be configured in the `config.toml` file.
+Docker images can be built and run using:
 
-Run NGINX Declarative API using:
+    git clone https://github.com/fabriziofiorucci/NGINX-Declarative-API
 
-```
-$ git clone https://github.com/fabriziofiorucci/NGINX-Declarative-API
-$ cd NGINX-Declarative-API/src
-$ pip install -r requirements.txt
-$ python3 main.py
-```
-
-### As a Docker image
-
-The docker image can be built and run using:
-
-```
-$ git clone https://github.com/fabriziofiorucci/NGINX-Declarative-API
-$ cd NGINX-Declarative-API
-$ docker build --no-cache -t nginx-declarative-api -f ./Dockerfile .
-$ docker run --name nginx-declarative-api -d -p 5000:5000 nginx-declarative-api
-```
-
-Pre-built docker images are available on Docker Hub at https://hub.docker.com/repository/docker/fiorucci/nginx-declarative-api/general and can be run using:
+    cd NGINX-Declarative-API
+    docker build --no-cache -t fiorucci/nginx-declarative-api -f ./Dockerfile .
+    docker run --name nginx-declarative-api -d -p 5000:5000 fiorucci/nginx-declarative-api
 
-```
-$ docker run --rm --name nginx-declarative-api -d -p 5000:5000 <IMAGE_NAME>
-```
+    cd contrib/devportal
+    docker build --no-cache -t fiorucci/nginx-declarative-api-devportal .
+    docker run --name devportal -d -p 5001:5000 fiorucci/nginx-declarative-api-devportal
 
-Pre-built images are configured to access the redis instance on host:port `127.0.0.1:6379`. This can be changed by mounting a custom `config.toml` file on the `nginx-declarative-api` container.
+Pre-built docker images are available on Docker Hub at https://hub.docker.com/repository/docker/fiorucci/nginx-declarative-api/general
+Configuration can be customized mounting `config.toml` as a volume `nginx-declarative-api` docker image as a volume to customize 
 
 ## REST API documentation
 

USAGE-v3.md

@@ -117,7 +117,7 @@ is:
                                     "server_url": "https://petstore.swagger.io/v2"
                                 },
                                 "developer_portal": {
-                                    "enabled": false,
+                                    "enabled": true,
                                     "uri": "/petstore-devportal.html"
                                 },
                                 "rate_limit": {

contrib/docker-compose/README.md

@@ -1,6 +1,6 @@
 # Docker compose
 
-NGINX Declarative API can be deployed using docker compose on a Linux virtual machine running Docker.
+NGINX Declarative API can be deployed using docker compose on a Linux virtual machine running docker-compose v2.20+
 
 Usage:
 
@@ -18,13 +18,14 @@ NGINX Declarative API - https://github.com/fabriziofiorucci/NGINX-Declarative-AP
 
  === Options:
 
- -h                     - This help
- -c [start|stop]        - Deployment command
+ -h                             - This help
+ -c [start|stop|restart]        - Deployment command
 
  === Examples:
 
- Deploy NGINX DAPI:       ./nginx-dapi.sh -c start
- Remove NGINX DAPI:       ./nginx-dapi.sh -c stop
+ Deploy NGINX DAPI :    ./nginx-dapi.sh -c start
+ Remove NGINX DAPI :    ./nginx-dapi.sh -c stop
+ Restart NGINX DAPI:    ./nginx-dapi.sh -c restart
 ```
 
 ## How to deploy
@@ -34,26 +35,59 @@ NGINX Declarative API - https://github.com/fabriziofiorucci/NGINX-Declarative-AP
    - [API v1](/USAGE-v1.md) - deprecated
    - [API v2](/USAGE-v2.md)
 
-## Starting & stopping with docker-compose
+## How to run
 
 Starting NGINX Declarative API:
 
 ```
 $ ./nginx-dapi.sh -c start
+-> Updating docker images
+[+] Pulling 3/3
+ ✔ nginx-dapi Pulled 
+ ✔ redis Pulled 
+ ✔ devportal Pulled 
 -> Deploying NGINX Declarative API
-Creating network "nginx-dapi_default" with the default driver
-Creating redis ... done
-Creating nginx-dapi ... done
-$
+[+] Running 3/3
+ ✔ Container redis       Running 
+ ✔ Container devportal   Running 
+ ✔ Container nginx-dapi  Started
 ```
 
 Stopping NGINX Declarative API:
 
 ```
 $ ./nginx-dapi.sh -c stop
 -> Undeploying NGINX Declarative API
-Removing redis ... done
-Removing nginx-dapi ... done
-Removing network nginx-dapi_default
-$
+[+] Running 4/4
+ ✔ Container nginx-dapi        Removed 
+ ✔ Container devportal         Removed 
+ ✔ Container redis             Removed 
+ ✔ Network nginx-dapi_default  Removed 
 ```
+
+Restarting NGINX Declarative API:
+
+```
+$ ./nginx-dapi.sh -c restart
+[+] Running 4/4
+ ✔ Container devportal         Removed 
+ ✔ Container nginx-dapi        Removed 
+ ✔ Container redis             Removed 
+ ✔ Network nginx-dapi_default  Removed 
+-> Updating docker images
+[+] Pulling 3/3
+ ✔ nginx-dapi Pulled 
+ ✔ redis Pulled 
+ ✔ devportal Pulled 
+-> Deploying NGINX Declarative API
+[+] Running 4/4
+ ✔ Network nginx-dapi_default  Created-> Undeploying NGINX Declarative API
+[+] Running 4/4
+ ✔ Container nginx-dapi        Removed 
+ ✔ Container devportal         Removed 
+ ✔ Container redis             Removed 
+ ✔ Network nginx-dapi_default  Removed
+ ✔ Container devportal         Started 
+ ✔ Container redis             Started 
+ ✔ Container nginx-dapi        Started
+```

contrib/docker-compose/docker-compose.yaml

@@ -1,4 +1,4 @@
-version: "3.2"
+version: "3.9"
 
 volumes:
   redis_data:
@@ -11,6 +11,8 @@ services:
     restart: always
     ports:
       - "6379:6379"
+    networks:
+      - dapi-network
     volumes:
       - redis_data:/data:rw
 
@@ -21,6 +23,8 @@ services:
     restart: always
     ports:
       - "5001:5000"
+    networks:
+      - dapi-network
 
   nginx-dapi:
     image: fiorucci/nginx-declarative-api:latest
@@ -31,3 +35,8 @@ services:
       - redis
     ports:
       - "5000:5000"
+    networks:
+      - dapi-network
+
+networks:
+  dapi-network:

contrib/docker-compose/nginx-dapi.sh

@@ -9,11 +9,12 @@ This script is used to deploy/undeploy NGINX Declarative API using docker-compos
 === Usage:\n\n
 $0 [options]\n\n
 === Options:\n\n
--h\t\t\t- This help\n
--c [start|stop]\t- Deployment command\n\n
+-h\t\t\t\t- This help\n
+-c [start|stop|restart]\t- Deployment command\n\n
 === Examples:\n\n
-Deploy NGINX DAPI:\t$0 -c start\n
-Remove NGINX DAPI:\t$0 -c stop\n
+Deploy NGINX DAPI :\t$0 -c start\n
+Remove NGINX DAPI :\t$0 -c stop\n
+Restart NGINX DAPI:\t$0 -c restart\n
 "
 
 echo -e $BANNER 2>&1
@@ -51,6 +52,14 @@ echo "-> Undeploying NGINX Declarative API"
 COMPOSE_HTTP_TIMEOUT=240 docker-compose -p $PROJECT_NAME -f $DOCKER_COMPOSE_YAML down
 }
 
+#
+# NGINX Declarative API restart
+#
+nginx_dapi_restart() {
+nginx_dapi_stop
+nginx_dapi_start
+}
+
 #
 # Main
 #
@@ -70,7 +79,7 @@ do
         esac
 done
 
-if [ -z "${ACTION}" ] || [[ ! "${ACTION}" == +(start|stop) ]] 
+if [ -z "${ACTION}" ] || [[ ! "${ACTION}" == +(start|stop|restart) ]] 
 then
 	usage
 fi
@@ -82,4 +91,7 @@ case "$ACTION" in
     stop)
         nginx_dapi_stop
         ;;
+    restart)
+        nginx_dapi_restart
+        ;;
 esac