Skip to content

Commit b3fed47

Browse files
Added Docker startup instructions (#85)
* Added nginx-agent-docker * Changed base image to Debian bullseye * Update nginx-agent-docker/Dockerfile Thank you Co-authored-by: Luca Comellini <[email protected]> Signed-off-by: 65397 <[email protected]> * Update nginx-agent-docker/Dockerfile Co-authored-by: Luca Comellini <[email protected]> Signed-off-by: 65397 <[email protected]> * Update nginx-agent-docker/Dockerfile Co-authored-by: Luca Comellini <[email protected]> Signed-off-by: 65397 <[email protected]> * Update nginx-agent-docker/Dockerfile Co-authored-by: Luca Comellini <[email protected]> Signed-off-by: 65397 <[email protected]> * Dockerfile updated * Added docker instructions --------- Signed-off-by: 65397 <[email protected]> Co-authored-by: Luca Comellini <[email protected]>
1 parent c9291a4 commit b3fed47

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

nginx-agent-docker/README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This repository has been tested with NGINX agent for:
2222

2323
## Building the docker image
2424

25-
The install script can be used to build the Docker image using automated or manual agent install:
25+
The install script can be used to build the Docker image:
2626

2727
```
2828
$ ./scripts/build.sh
@@ -47,13 +47,13 @@ NGINX Plus & NGINX Instance Manager agent Docker image builder
4747
=== Examples:
4848
4949
NGINX Plus and NGINX Agent image:
50-
./scripts/build.sh -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:2.7.0 -n https://nim.f5.ff.lan
50+
./scripts/build.sh -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:r28 -n https://nim.f5.ff.lan
5151
5252
NGINX Plus, NGINX App Protect WAF and NGINX Agent image:
53-
./scripts/build.sh -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:2.7.0 -w -n https://nim.f5.ff.lan
53+
./scripts/build.sh -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:r28-nap -w -n https://nim.f5.ff.lan
5454
5555
NGINX Plus, Developer Portal support and NGINX Agent image:
56-
./scripts/build.sh -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:2.7.0-devportal -d -n https://nim.f5.ff.lan
56+
./scripts/build.sh -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:r28-devportal -d -n https://nim.f5.ff.lan
5757
```
5858

5959
1. Clone this repository
@@ -62,15 +62,15 @@ NGINX Plus & NGINX Instance Manager agent Docker image builder
6262
4. Build the Docker image using:
6363

6464
```
65-
$ ./scripts/build.sh -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:automated -n https://ubuntu.ff.lan
65+
$ ./scripts/build.sh -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:r28 -n https://ubuntu.ff.lan
6666
```
6767

6868
the build script will push the image to your private registry once build is complete.
6969

7070
- the `-d` flag can be used to build a Docker image to run NGINX Plus in [Developer Portal](https://docs.nginx.com/nginx-management-suite/admin-guides/installation/on-prem/install-guide/#install-developer-portal) mode for [API Connectivity Manager](https://docs.nginx.com/nginx-management-suite/acm/about/architecture/)
7171
- the `-w` flag can be used to include NGINX App Protect WAF support in the docker image
7272

73-
### Running the docker image
73+
### Running the docker image on Kubernetes
7474

7575
1. Edit `manifests/1.nginx-nim.yaml` and specify the correct image by modifying the `image:` line, and set the following environment variables. Default values for `NIM_HOST` and `NIM_GRPC_PORT` can be used if NGINX Instance Manager is deployed using https://github.com/nginxinc/NGINX-Demos/tree/master/nginx-nms-docker
7676
- `NIM_HOST` - NGINX Instance Manager hostname/IP address
@@ -89,3 +89,20 @@ $ ./scripts/nginxWithAgentStart.sh stop
8989
```
9090

9191
3. After startup NGINX Plus instances will register to NGINX Instance Manager and will be displayed on the "instances" dashboard
92+
93+
### Running the docker image on Docker
94+
95+
1. Start using
96+
97+
```
98+
NGINX Plus and NGINX Agent
99+
docker run --name nginx-plus -d -e "NIM_HOST=<NIM_FQDN_OR_IP>" -e "NIM_GRPC_PORT=<GPRC_PORT>" -d registry.ff.lan:31005/nginx-with-agent:r28
100+
101+
NGINX Plus, NGINX Agent and NGINX App Protect WAF with precompiled policies
102+
docker run --name nginx-plus -d -e "NIM_HOST=<NIM_FQDN_OR_IP>" -e "NIM_GRPC_PORT=<GPRC_PORT>" -e "NAP_WAF=true" -e "NAP_WAF_PRECOMPILED_POLICIES=true" -d registry.ff.lan:31005/nginx-with-agent:r28-nap
103+
104+
NGINX Plus, NGINX Agent and Developer portal
105+
docker run --name nginx-plus -d -e "NIM_HOST=<NIM_FQDN_OR_IP>" -e "NIM_GRPC_PORT=<GPRC_PORT>" -e "ACM_DEVPORTAL=true" -d registry.ff.lan:31005/nginx-with-agent:r28-devportal
106+
```
107+
108+
2. After startup NGINX Plus instances will register to NGINX Instance Manager and will be displayed on the "instances" dashboard

nginx-agent-docker/scripts/build.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ $0 [options]\n\n
1616
-w\t\t\t- Add NGINX App Protect WAF\n\n
1717
=== Examples:\n\n
1818
NGINX Plus and NGINX Agent image:\n
19-
$0 -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:2.7.0 -n https://nim.f5.ff.lan\n\n
19+
$0 -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:r28 -n https://nim.f5.ff.lan\n\n
2020
NGINX Plus, NGINX App Protect WAF and NGINX Agent image:\n
21-
$0 -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:2.7.0 -w -n https://nim.f5.ff.lan\n\n
21+
$0 -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:r28-nap -w -n https://nim.f5.ff.lan\n\n
2222
NGINX Plus, Developer Portal support and NGINX Agent image:\n
23-
$0 -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:2.7.0-devportal -d -n https://nim.f5.ff.lan
23+
$0 -C nginx-repo.crt -K nginx-repo.key -t registry.ff.lan:31005/nginx-with-agent:r28-devportal -d -n https://nim.f5.ff.lan
2424
\n"
2525

2626
while getopts 'ht:C:K:a:n:dw' OPTION

0 commit comments

Comments
 (0)