Documentation Request: device details

[d90]

Request for Enhancement to the existing documentation for the orb-agent project: Specifically, I am seeking detailed information on the following aspects:

Data Ingestion into NetBox: A comprehensive list of device attributes and data points that orb-agent collects and ingests into NetBox during its discovery processes. This includes, but is not limited to, details such as device types, interfaces, IP addresses, and any other relevant information.​

agent.yaml Configuration: Clarification on the parameters within the agent.yaml configuration file, particularly those that influence data collection and ingestion. While the current documentation provides an overview of the configuration structure, a more in-depth explanation of each parameter's role, acceptable values, and impact on the discovery process would be highly beneficial.​

I have reviewed the existing documentation available in the orb-agent repository and the NetBox Labs documentation site. However, I believe that more detailed information on the above topics would greatly assist users in effectively deploying and configuring orb-agent.​

Specifically, I suggest that this information be included in the defaults section of the device_discovery.md file within the orb-agent documentation.

[sepetuks]

I want to add more o this issue:
I am also missing clear details for configuring agent. In my specific case git based configs.
Reviewing documentation in Git configuration manager I am missing some part of examples:

• Is there any example how policy file should be constructed?
  • Where the config with target system and api key should be kept?
  • Should/can backend be stored in git as well?
• Can I keep config with target system and api key in git config or it needs to be in agent config locally?
• Documentation stated "Policies" and it s not clear about other parts

as the topic is related to same issue about not clear documentation am just adding my comment to already existing issue