PBM-1662 Added pbm-agent configuration options documentation#327
PBM-1662 Added pbm-agent configuration options documentation#327nastena1606 wants to merge 1 commit intomainfrom
Conversation
modified: docs/manage/logpath.md
modified: docs/manage/start-agent-with-config.md
new file: docs/reference/pbm-agent-config-options.md
modified: mkdocs-base.yml
nastena1606
requested review from
boris-ilijic,
Copilot,
jcechace and
sandraromanchenko
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for pbm-agent configuration file options. The documentation includes a new reference page detailing all available configuration options (MongoDB URI, backup settings, and logging options) and updates existing documentation to link to this new reference.
Key Changes:
- New reference documentation describing pbm-agent configuration file options with detailed descriptions, types, defaults, and requirements
- Updated navigation to include the new reference page
- Added cross-references between related documentation pages
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/reference/pbm-agent-config-options.md | New reference documentation detailing all pbm-agent configuration options including mongodb-uri, backup.dump-parallel-collections, and logging settings |
| mkdocs-base.yml | Added new reference page to navigation structure |
| docs/manage/start-agent-with-config.md | Added link to new configuration options reference |
| docs/manage/logpath.md | Added hyperlink to start-agent-with-config.md for configuration file documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The log severity level. Supported levels are (from low to high): `D` - Debug (default), `I` - Info, `W` - Warning, `E` - Error, `F` - Fatal. | ||
|
|
||
| The output includes both the specified severity level and all higher ones. For example, if you set the level to `I` (Info), the output will include Info, Warning, Error, and Fatal messages. | ||
|
|
There was a problem hiding this comment.
When this parameter in the config file changes, PBM Agent will automatically apply the change.
| *Default*: `false` | ||
|
|
||
| Output log messages in JSON format. If set to `false` or undefined, logs are written in the default text format. | ||
|
|
There was a problem hiding this comment.
When this parameter in the config file changes, PBM Agent will automatically apply the change.
3 participants
modified: docs/manage/logpath.md
modified: docs/manage/start-agent-with-config.md
new file: docs/reference/pbm-agent-config-options.md
modified: mkdocs-base.yml