Conversation
This commits updates the README file with all necessary details including description of data-sync config json keys. Change-Id: I4180d5554ca4e596b28510e7be6da8d4908ebd60 Signed-off-by: Arya K Padman <aryakpadman@gmail.com>
|
|
||
| ## Overview | ||
|
|
||
| This application provides a robust data synchronization mechanism for redundant |
There was a problem hiding this comment.
Explain why the data sync is required as well..
| - **Periodic Sync**: Scheduled synchronization at configurable time intervals | ||
| - **Full Sync**: Complete synchronization of all configured data via D-Bus | ||
| method call. Data sync issues fullsync during startup and in all other case | ||
| RBMC manager issues full sync when needed. |
There was a problem hiding this comment.
Please list out when the RBMC Mgr issue full sync or point the RBMC manager README..
|
|
||
| - **Sibling Notification**: After successful synchronization, automatically | ||
| notify services on the sibling BMC to reload or restart as needed. Supports | ||
| both systemd service notifications and D-Bus method calls. |
There was a problem hiding this comment.
and D-Bus method calls.
is it correct?
|
|
||
| **Values**: | ||
|
|
||
| - `NotStarted` - No full sync has been initiated |
There was a problem hiding this comment.
I would not prefer to maintain these information here, just point DBus interface doc?
Example command is fine - keep it in the separate section.
| SyncEventsHealth | ||
| ``` | ||
|
|
||
| ## To build |
There was a problem hiding this comment.
I would prefer build steps before DBus command usage.
Also, please feel free to add table of contents as needed.
| ##### Path (Required) | ||
|
|
||
| - **Type**: String | ||
| - **Description**: Absolute path of the file or directory to be synchronized |
There was a problem hiding this comment.
Is it field to explain why are syncing the file/directry, right?
and also explain usage about each config field - I think your Description matching. Just revisit all once.
| extension. | ||
| extension | ||
|
|
||
| ## Rsync and Stunnel Configuration Generation |
There was a problem hiding this comment.
Do you splitting would be simple?
This commits updates the README file with all necessary details including description of data-sync config json keys.
Change-Id: I4180d5554ca4e596b28510e7be6da8d4908ebd60