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

Updated README.md, SECURITY.md and OSS Docs Structure #124

Merged
merged 25 commits into from
Nov 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
4ceddac
Updated README.md with new structure, value props, images and technic…
mtbChef Nov 17, 2022
073fa98
Moving OSS required text files out of docs dir and into src root
mtbChef Nov 17, 2022
84c439a
update security.md file to the latest version
mtbChef Nov 17, 2022
6fb337c
Removing reference to mailing list
dwmcallister Nov 22, 2022
5a9df9f
Add REST interface config instructions, clarify command used for runn…
mtbChef Nov 22, 2022
f0803c0
updated flow diagram
mtbChef Nov 23, 2022
e67d939
added example REST TLS config params, more context on N+ API setup, c…
mtbChef Nov 23, 2022
093d02d
update binary package download instructions
mtbChef Nov 23, 2022
1432ad2
fix: README review
Jcahilltorre Nov 24, 2022
e7d7dd6
Update README.md
Jcahilltorre Nov 24, 2022
6e51bbe
fix: issuing > running
Jcahilltorre Nov 24, 2022
8a34d44
Merge pull request #119 from nginx/oss-readme-review
mtbChef Nov 28, 2022
854f178
Updated main graphic to Grafana example
mtbChef Nov 28, 2022
1460c30
Cropped empty space out of Grafana screenshot and added reference to …
mtbChef Nov 28, 2022
c82c0c0
corrected a typo
dwmcallister Nov 28, 2022
5a85aab
Added table of contents
mtbChef Nov 28, 2022
ea77ed0
Merge commit 'c82c0c0e04eec4a46c1a11276a42299e9587295d' into oss-readme
mtbChef Nov 28, 2022
5cbc3ed
Updated NGINX OSS install guide link
mtbChef Nov 28, 2022
b5414bf
Merge branch 'main' into oss-readme
mtbChef Nov 29, 2022
f7db78e
Updated readme to: warn user to create subdirectory before extracting…
mtbChef Nov 29, 2022
ea0d531
Further clarified package installation instructions in the README
mtbChef Nov 29, 2022
8f31cf1
Update README Ubuntu/Debian package install instructions to use dpkg …
mtbChef Nov 29, 2022
63c2788
Added sudo to make run, as agent must run as root
mtbChef Nov 29, 2022
102eaf7
minor typo
Nov 30, 2022
5efe87f
update section with gRPC mock control plane
oCHRISo Nov 30, 2022
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
File renamed without changes.
File renamed without changes.
318 changes: 227 additions & 91 deletions README.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/SECURITY.md → SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Security Policy

## Supported Versions
## Latest Versions

We advise users to run the most recent release and/or stable commit of the NGINX Agent, and we issue software updates to the most recent release. We provide technical support for F5 customers who are using the most recent version of the NGINX Agent, and any version released within two years of the current release.
We advise users to run or update to the most recent release of the NGINX Agent. Older versions of the NGINX Agent may not have all enhancements and/or bug fixes applied to them.

## Reporting a Vulnerability

Expand All @@ -11,4 +11,4 @@ The F5 Security Incident Response Team (F5 SIRT) has an email alias that makes i
* If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).
* If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities with any F5 product to the F5 Security Incident Response Team at [email protected]

For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability)
For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability)
Binary file added docs/agent-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/agent-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/grafana-dashboard-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/how-it-works.png
Binary file not shown.
14 changes: 7 additions & 7 deletions sdk/examples/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ func main() {

//Serve gRPC Server
log.Println("http listening")
log.Println("grpc listening")
log.Println("gRPC listening")

go func() {
if err := grpcServer.Serve(grpcListener); err != nil {
Expand All @@ -60,7 +60,7 @@ func main() {

http.Handle("/", http.FileServer(http.FS(content)))

http.Handle("/registered", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
http.Handle("/registered/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
payload, err := json.Marshal(commandService.GetRegistration())
if err != nil {
log.Warnf("%v", err)
Expand All @@ -69,7 +69,7 @@ func main() {
rw.Write(payload)
}))

http.Handle("/nginxes", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
http.Handle("/nginxes/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
payload, err := json.Marshal(commandService.GetNginxes())
if err != nil {
log.Warnf("%v", err)
Expand All @@ -78,7 +78,7 @@ func main() {
rw.Write(payload)
}))

http.Handle("/configs/chunked", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
http.Handle("/configs/chunked/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
payload, err := json.Marshal(commandService.GetChunks())
if err != nil {
log.Warnf("%v", err)
Expand All @@ -87,7 +87,7 @@ func main() {
rw.Write(payload)
}))

http.Handle("/configs/raw", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
http.Handle("/configs/raw/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
confFiles, auxFiles := commandService.GetContents()
response := map[string]interface{}{}
for _, confFile := range confFiles {
Expand All @@ -106,7 +106,7 @@ func main() {
rw.Write(payload)
}))

http.Handle("/configs", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
http.Handle("/configs/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
payload, err := json.Marshal(commandService.GetConfigs())
if err != nil {
log.Warnf("%v", err)
Expand All @@ -115,7 +115,7 @@ func main() {
rw.Write(payload)
}))

http.Handle("/metrics", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
http.Handle("/metrics/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
payload, err := json.Marshal(metricsService.GetMetrics())
if err != nil {
log.Warnf("%v", err)
Expand Down