Agent release 3.0

[JTorreG]

Proposed changes

Publish Agent release v3 documentation

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

• I have read the contributing guidelines
• I have signed the F5 Contributor License Agreement (CLA)
• I have rebased my branch onto main
• I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
• I have ensured that the commit messages adhere to Conventional Commits
• I have ensured that documentation content adheres to the style guide
• If the change involves potentially sensitive changes¹, I have assessed the possible impact
• If applicable, I have added tests that prove my fix is effective or that my feature works
• I have ensured that existing tests pass after adding my changes
• If applicable, I have updated README.md and CHANGELOG.md

Footnotes

1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩

[mjang]

Overall comment (before review), do make sure that what you've done is consistent with the other cards in the N1C home page. Specifically, review https://frontdoor-test-docs.nginx.com/previews/docs/567/nginx-one

• atm, when I select the NGINX Agent card from https://frontdoor-test-docs.nginx.com/previews/docs/567/nginx-one, I get redirected to https://frontdoor-test-docs.nginx.com/previews/docs/567/nginx-one/agent, which is a 404. (I think we need some content in _index.md)
• Include an:
  • Imperative title, such as Install NGINX Agent
  • Some description. See the pattern in content/nginx-one/_index.md. You should see the pattern, in a dedicated "card," at https://frontdoor-test-docs.nginx.com/previews/docs/567/nginx-one. Something like "Set up messaging between your NGINX instances and NGINX One Console". Ideally, it should be shorter.
• Put Agent in an appropriate location in the left-hand ToC. IMO, it should come just before ~Glossary and Changelog

[mjang]

My comments are related to the view of the Agent docs in the context of the N1C docs. Example: re "changelog". I think we should we specify "Agent changelog" when it's different from the N1C changelog.

[mjang]

Approving with most recent revision from "Changelog" -> "Releases"

[JTorreG]

Overall comment (before review), do make sure that what you've done is consistent with the other cards in the N1C home page. Specifically, review https://frontdoor-test-docs.nginx.com/previews/docs/567/nginx-one

• atm, when I select the NGINX Agent card from https://frontdoor-test-docs.nginx.com/previews/docs/567/nginx-one, I get redirected to https://frontdoor-test-docs.nginx.com/previews/docs/567/nginx-one/agent, which is a 404. (I think we need some content in _index.md)

• Include an:

  • Imperative title, such as Install NGINX Agent
  • Some description. See the pattern in content/nginx-one/_index.md. You should see the pattern, in a dedicated "card," at https://frontdoor-test-docs.nginx.com/previews/docs/567/nginx-one. Something like "Set up messaging between your NGINX instances and NGINX One Console". Ideally, it should be shorter.

• Put Agent in an appropriate location in the left-hand ToC. IMO, it should come just before ~Glossary and Changelog

addressed all of these

[ADubhlaoich]

LGTM!

[mjang]

Question, @JTorreG . How does one get a data plane key (as described in run-agent-container.md?

• I think we need something like a link to https://docs.nginx.com/nginx-one/connect-instances/create-manage-data-plane-keys/

  • Concern: you've set up an auth.token in the nginx-agent.conf file.
  • It feels inconsistent with the nginx-agent.conf file listed in this section of the N1C Get Started.

• Follow-up question: once we've included the data plane key in an nginx-agent.conf file, does that automatically allow an NGINX instance to register with N1C? (I think so. if so, we should be explicit.)

• I have not used "Data Plane access token." Can a data plane key (generated through NGINX One Console) actually also be used as a token? Or is a "Data Plane access token" something else?

[mjang]

A few comments for consistency. As suggested earlier, I'll set up a branch with changes to the Get started guide

[mjang]

Suggested change

	- `<your-data-plane-key-here>`: Your Data Plane access token.
	- `<your-data-plane-key-here>`: Your Data Plane key.

[mjang]

Suggested change

	- `<NGINX-One-Console-URL>`: The URL of your NGINX One Console instance.
	- `<NGINX-One-Console-URL>`: The URL of your NGINX One Console instance, typically `https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io/`.