-
Notifications
You must be signed in to change notification settings - Fork 98
Update the landing page #1202
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
Merged
Merged
Update the landing page #1202
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,131 +1,40 @@ | ||
 | ||
 | ||
 | ||
 | ||
[](https://nginxcommunity.slack.com/channels/nginx-agent) | ||
 | ||
|
||
# NGINX Agent | ||
# F5 NGINX Agent | ||
|
||
NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables: | ||
F5 NGINX Agent is a companion application designed to efficiently manage NGINX instances. Key features include: | ||
|
||
- Remote management of NGINX configurations | ||
- Collection and reporting of real-time NGINX performance and operating system metrics | ||
- Notifications of NGINX events | ||
- Remote management: Easily control and configure NGINX instances remotely. | ||
- Real-time metrics: Monitor and analyze performance data for NGINX and the underlying operating system. | ||
|
||
## Development Environment Setup | ||
Discover more advanced features and capabilities by visiting [Try NGINX One: Free Enterprise Trial](https://www.f5.com/trials/nginx-one). | ||
|
||
### Installing Prerequisite Packages | ||
|
||
The following packages need to be installed: | ||
## Installation | ||
|
||
- make | ||
- golang (<https://go.dev/doc/install>) | ||
- protoc (<https://grpc.io/docs/protoc-installation/>) | ||
- mdatagen (There is currently an [issue installing mdatagen](https://github.com/open-telemetry/opentelemetry-collector/issues/9281). See instructions below for workaround.) | ||
You can install **NGINX Agent** using one of the following methods: | ||
|
||
#### Workaround to install mdatagen | ||
1. **Official documentation** | ||
Follow the step-by-step guide to add and configure instances: | ||
[How to add an instance](https://docs.nginx.com/nginx-one/how-to/nginx-configs/add-instance/) | ||
|
||
```console | ||
git clone https://github.com/open-telemetry/opentelemetry-collector.git | ||
cd opentelemetry-collector | ||
git checkout v0.124.0 | ||
cd cmd/mdatagen | ||
go install | ||
``` | ||
2. **GitHub releases** | ||
Download the latest binaries or packages directly from the GitHub releases page: | ||
[NGINX Agent GitHub releases](https://github.com/nginx/agent/releases) | ||
|
||
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: | ||
3. **Installation and upgrade guide** | ||
Access detailed instructions to install or upgrade NGINX Agent from the official NGINX documentation: | ||
[NGINX Agent Installation Guide](https://docs.nginx.com/nginx-agent/installation-upgrade/) | ||
|
||
```console | ||
make install-tools | ||
``` | ||
## Useful links | ||
|
||
### Building NGINX Agent from Source Code | ||
* [v2 - Official NGINX Agent documentation](https://docs.nginx.com/nginx-agent/) | ||
* [v3 - Official NGINX Agent documentation](https://docs.nginx.com/nginx-one/agent/) | ||
* [F5 Support](https://my.f5.com/manage/s/) | ||
|
||
Build NGINX Agent deb package: | ||
|
||
```console | ||
OSARCH=<operating system archiecture> make local-deb-package | ||
``` | ||
|
||
Build NGINX Agent rpm package: | ||
|
||
```console | ||
OSARCH=<operating system archiecture> make local-rpm-package | ||
``` | ||
|
||
Build NGINX Agent apk package: | ||
|
||
```console | ||
OSARCH=<operating system archiecture> make local-apk-package | ||
``` | ||
|
||
### Testing NGINX Agent | ||
|
||
#### Unit tests | ||
|
||
To run unit tests and check that there is enough test coverage run the following | ||
|
||
```console | ||
make unit-test coverge | ||
``` | ||
|
||
To check for race conditions, the unit tests can also be run with a race condition detector | ||
|
||
```console | ||
make race-condition-test | ||
``` | ||
|
||
#### Integration tests | ||
|
||
To run integration tests, run the following | ||
|
||
```console | ||
make integration-test | ||
``` | ||
|
||
#### Testing with a mock management plane | ||
|
||
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) \ | ||
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) | ||
|
||
## NGINX Agent Technical Specifications | ||
|
||
### Supported Distributions | ||
|
||
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. | ||
|
||
### Supported Deployment Environments | ||
|
||
NGINX Agent can be deployed in the following environments: | ||
|
||
- Bare Metal | ||
- Container | ||
- Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure | ||
- Virtual Machine | ||
|
||
### Supported NGINX Product Versions | ||
|
||
NGINX Agent works with all supported versions of NGINX Open Source and NGINX Plus. | ||
|
||
### Sizing Recommendations | ||
|
||
Minimum system sizing recommendations for NGINX Agent: | ||
TBD | ||
|
||
## Community | ||
|
||
- Our [NGINX Community Forum ](https://community.nginx.org/tag/agent) is the go-to place to ask questions and share your thoughts. | ||
|
||
- Our [GitHub issues page](https://github.com/nginx/agent/issues) offers space for a more technical discussion at your own pace. | ||
|
||
## Contributing | ||
|
||
Get involved with the project by contributing! Please see our [contributing guide](CONTRIBUTING.md) for details. | ||
|
||
## Change Log | ||
|
||
See our [release page](https://github.com/nginx/agent/releases) to keep track of updates. | ||
|
||
## License | ||
|
||
[Apache License, Version 2.0](LICENSE) | ||
## Community | ||
If you have any questions please reach out using the [NGINX Community](https://community.nginx.org/) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we removing the coverage badge?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah good catch, accidental removal.