Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add NGINX Agent documentation #2353

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions nginx-agent/README-short.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Official build of Nginx Agent.
36 changes: 36 additions & 0 deletions nginx-agent/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# What is NGINX Agent?
NGINX Agent runs as a companion process on a system running NGINX. It provides gRPC and REST interfaces for configuration management and metrics collection from the NGINX process and operating system. NGINX Agent enables remote interaction with NGINX using common Linux tools and unlocks the ability to build sophisticated monitoring and control systems that can manage large collections of NGINX instances.

For more information, check out [NGINX Agent Overview](https://docs.nginx.com/nginx-agent/overview/).

# Available tags

| Tag | Description |
|-----------------------------------------------|-----------------------------------------------------------------------|
| \<nginx-agent-version\>-nginx-mainline-alpine | Latest NGINX mainline version with the specified NGINX Agent version. |
| \<nginx-agent-version\>-nginx-stable-alpine | Latest NGINX stable version with the specified NGINX Agent version. |

# How to use this image

Example of how to run a NGINX Agent container:

```console
$ docker run --name nginx-agent-container -d nginx-agent
```

By default the NGINX Agent REST API is not enabled. To enable it, the NGINX Agent configuration needs to be updated to include the API configuration. Here is an example of what needs to be added to the `nginx-agent.conf`:

```yaml
api:
host: 0.0.0.0
port: 8038
```

Once the nginx-agent.conf is updated with the API setting, here is an example of how to run the container with the updated `nginx-agent.conf` mounted and the port `8038` exposed:

```console
$ docker run --name nginx-agent-container -d \
--mount type=bind,source="$(pwd)"/nginx-agent.conf,target=/etc/nginx-agent/nginx-agent.conf,readonly \
-p 127.0.0.1:8038:8038/tcp \
nginx-agent
```
1 change: 1 addition & 0 deletions nginx-agent/get-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
the [GitHub issues page](https://github.com/nginx/agent/issues), the [NGINX Community Slack](https://community.nginx.org/joinslack)
1 change: 1 addition & 0 deletions nginx-agent/github-repo
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://github.com/nginx/agent
1 change: 1 addition & 0 deletions nginx-agent/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
View [license information](https://github.com/nginx/agent/blob/main/LICENSE) for the software contained in this image.
1 change: 1 addition & 0 deletions nginx-agent/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the NGINX Agent Docker Maintainers](%%GITHUB-REPO%%)