|
1 | 1 |  |
| 2 | + |
2 | 3 |  |
3 | 4 |  |
4 | | -[](https://nginxcommunity.slack.com/channels/nginx-agent) |
5 | 5 |  |
6 | 6 |
|
7 | | -# NGINX Agent |
| 7 | +# F5 NGINX Agent |
8 | 8 |
|
9 | | -NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables: |
| 9 | +F5 NGINX Agent is a companion application designed to efficiently manage NGINX instances. Key features include: |
10 | 10 |
|
11 | | -- Remote management of NGINX configurations |
12 | | -- Collection and reporting of real-time NGINX performance and operating system metrics |
13 | | -- Notifications of NGINX events |
| 11 | +- Remote management: Easily control and configure NGINX instances remotely. |
| 12 | +- Real-time metrics: Monitor and analyze performance data for NGINX and the underlying operating system. |
14 | 13 |
|
15 | | -## Development Environment Setup |
| 14 | +Discover more advanced features and capabilities by visiting [Try NGINX One: Free Enterprise Trial](https://www.f5.com/trials/nginx-one). |
16 | 15 |
|
17 | | -### Installing Prerequisite Packages |
18 | 16 |
|
19 | | -The following packages need to be installed: |
| 17 | +## Installation |
20 | 18 |
|
21 | | -- make |
22 | | -- golang (<https://go.dev/doc/install>) |
23 | | -- protoc (<https://grpc.io/docs/protoc-installation/>) |
24 | | -- mdatagen (There is currently an [issue installing mdatagen](https://github.com/open-telemetry/opentelemetry-collector/issues/9281). See instructions below for workaround.) |
| 19 | +You can install **NGINX Agent** using one of the following methods: |
25 | 20 |
|
26 | | -#### Workaround to install mdatagen |
| 21 | +1. **Official documentation** |
| 22 | + Follow the step-by-step guide to add and configure instances: |
| 23 | + [How to add an instance](https://docs.nginx.com/nginx-one/how-to/nginx-configs/add-instance/) |
27 | 24 |
|
28 | | -```console |
29 | | -git clone https://github.com/open-telemetry/opentelemetry-collector.git |
30 | | -cd opentelemetry-collector |
31 | | -git checkout v0.124.0 |
32 | | -cd cmd/mdatagen |
33 | | -go install |
34 | | -``` |
| 25 | +2. **GitHub releases** |
| 26 | + Download the latest binaries or packages directly from the GitHub releases page: |
| 27 | + [NGINX Agent GitHub releases](https://github.com/nginx/agent/releases) |
35 | 28 |
|
36 | | -Before starting development on the NGINX Agent, it is important to download and install the necessary tool and dependencies required by the NGINX Agent. You can do this by running the following `make` command: |
| 29 | +3. **Installation and upgrade guide** |
| 30 | + Access detailed instructions to install or upgrade NGINX Agent from the official NGINX documentation: |
| 31 | + [NGINX Agent Installation Guide](https://docs.nginx.com/nginx-agent/installation-upgrade/) |
37 | 32 |
|
38 | | -```console |
39 | | -make install-tools |
40 | | -``` |
| 33 | +## Useful links |
41 | 34 |
|
42 | | -### Building NGINX Agent from Source Code |
| 35 | +* [v2 - Official NGINX Agent documentation](https://docs.nginx.com/nginx-agent/) |
| 36 | +* [v3 - Official NGINX Agent documentation](https://docs.nginx.com/nginx-one/agent/) |
| 37 | +* [F5 Support](https://my.f5.com/manage/s/) |
43 | 38 |
|
44 | | -Build NGINX Agent deb package: |
45 | | - |
46 | | -```console |
47 | | -OSARCH=<operating system archiecture> make local-deb-package |
48 | | -``` |
49 | | - |
50 | | -Build NGINX Agent rpm package: |
51 | | - |
52 | | -```console |
53 | | -OSARCH=<operating system archiecture> make local-rpm-package |
54 | | -``` |
55 | | - |
56 | | -Build NGINX Agent apk package: |
57 | | - |
58 | | -```console |
59 | | -OSARCH=<operating system archiecture> make local-apk-package |
60 | | -``` |
61 | | - |
62 | | -### Testing NGINX Agent |
63 | | - |
64 | | -#### Unit tests |
65 | | - |
66 | | -To run unit tests and check that there is enough test coverage run the following |
67 | | - |
68 | | -```console |
69 | | -make unit-test coverge |
70 | | -``` |
71 | | - |
72 | | -To check for race conditions, the unit tests can also be run with a race condition detector |
73 | | - |
74 | | -```console |
75 | | -make race-condition-test |
76 | | -``` |
77 | | - |
78 | | -#### Integration tests |
79 | | - |
80 | | -To run integration tests, run the following |
81 | | - |
82 | | -```console |
83 | | -make integration-test |
84 | | -``` |
85 | | - |
86 | | -#### Testing with a mock management plane |
87 | | - |
88 | | -For testing command operations, there is a mock management gRPC server that can be used. See here: [mock management gRPC server](test/mock/grpc/README.md) \ |
89 | | -For testing metrics, there is a mock management OTel collector that can be used. See here: [mock management OTel collector](test/mock/collector/README.md) |
90 | | - |
91 | | -## NGINX Agent Technical Specifications |
92 | | - |
93 | | -### Supported Distributions |
94 | | - |
95 | | -NGINX Agent can run in most environments. For a list of supported distributions, see the [NGINX Technical Specs](https://docs.nginx.com/nginx/technical-specs/#supported-distributions) guide. |
96 | | - |
97 | | -### Supported Deployment Environments |
98 | | - |
99 | | -NGINX Agent can be deployed in the following environments: |
100 | | - |
101 | | -- Bare Metal |
102 | | -- Container |
103 | | -- Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure |
104 | | -- Virtual Machine |
105 | | - |
106 | | -### Supported NGINX Product Versions |
107 | | - |
108 | | -NGINX Agent works with all supported versions of NGINX Open Source and NGINX Plus. |
109 | | - |
110 | | -### Sizing Recommendations |
111 | | - |
112 | | -Minimum system sizing recommendations for NGINX Agent: |
113 | | -TBD |
114 | | - |
115 | | -## Community |
116 | | - |
117 | | -- Our [NGINX Community Forum ](https://community.nginx.org/tag/agent) is the go-to place to ask questions and share your thoughts. |
118 | | - |
119 | | -- Our [GitHub issues page](https://github.com/nginx/agent/issues) offers space for a more technical discussion at your own pace. |
120 | | - |
121 | | -## Contributing |
122 | | - |
123 | | -Get involved with the project by contributing! Please see our [contributing guide](CONTRIBUTING.md) for details. |
124 | | - |
125 | | -## Change Log |
126 | | - |
127 | | -See our [release page](https://github.com/nginx/agent/releases) to keep track of updates. |
128 | | - |
129 | | -## License |
130 | | - |
131 | | -[Apache License, Version 2.0](LICENSE) |
| 39 | +## Community |
| 40 | +If you have any questions please reach out using the [NGINX Community](https://community.nginx.org/) |
0 commit comments