Skip to content

docs: Update README#94

Open
aryakpadman wants to merge 1 commit intoibm-openbmc:mainfrom
aryakpadman:readme
Open

docs: Update README#94
aryakpadman wants to merge 1 commit intoibm-openbmc:mainfrom
aryakpadman:readme

Conversation

@aryakpadman
Copy link
Copy Markdown
Contributor

This commits updates the README file with all necessary details including description of data-sync config json keys.

Change-Id: I4180d5554ca4e596b28510e7be6da8d4908ebd60

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>
Copy link
Copy Markdown
Collaborator

@RameshIyyar RameshIyyar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your initiative to push the documentation...Keep it up...

Some suggestions.

and please add more flow also thats helps people...(may be different patch set based on your planning)


## Overview

This application provides a robust data synchronization mechanism for redundant
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and D-Bus method calls.

is it correct?


**Values**:

- `NotStarted` - No full sync has been initiated
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you splitting would be simple?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants