DataSync: Added error code, method, property and Enum #160
Conversation
|
Can one of the admins verify this patch? |
| Start a full Sync of all the configured files and directory, to | ||
| the sibling BMC. | ||
| errors: | ||
| - xyz.openbmc_project.DataSync.BMCData.Error.SiblingNotAvailable |
There was a problem hiding this comment.
Should we return an error if the FullSync is in progress, or would you prefer to handle this based on the error handling logic?
| methods: | ||
| - name: FullSync | ||
| description: > | ||
| Start a full Sync of all the configured files and directory, to |
There was a problem hiding this comment.
a full Sync of all the configured files and directory
Thanks for capturing this but two point need to consider.
-
It won't sync all configured files and directories; the sync will be based on the role, correct? Please make sure to capture that information as well.
-
We have one more use case: some firmware subsystems or their components need to sync their data based on specific requirements rather than immediately or periodically. Since the OpenBMC DBus YAML framework does not support default arguments (i.e., FullSync with an argument to specify the required files—if the argument is not provided, it defaults to syncing all files), we cannot use this API for such cases. Therefore, we will need a separate method for this, but we can consider it once we have finalized the end-to-end flow between firmware subsystems (HB/PHYP, etc.).
and I believe we should include details on how we plan to track the status of the full sync.
| type: enum[self.SyncStatus] | ||
| default: Unknown | ||
| description: > | ||
| This property represents the current status of the synchronization |
There was a problem hiding this comment.
current status of the synchronization
I think you meant the full sync status.
The current sync status won’t be very useful without specifying details about the specific files or directories. I believe these factors should also be considered from a statistics perspective. Let's make sure to clarify this in the documentation for this status property.
- Introduced the SiblingNotAvailable error code specific to DataSync interfaces. - This error should be triggered when a request involves a sibling BMC that is unavailable. Change-Id: Ica32191154b7eb6b0a806fe45249f733352eae7f Signed-off-by: Harsh Agarwal <[email protected]>
- This interface will be used to initiate a full sync of the configured files and directory to the sibling BMC based on the role. The added method will throw below exceptions. - xyz.openbmc_project.DataSync.BMCData.Error.SiblingNotAvailable - If the sibling is not available for sync. Change-Id: I1ac2375e807ca04a331b784d56a923bf894619a6 Signed-off-by: Harsh Agarwal <[email protected]>
- This property is used to define the full Synchronization status of the BMC. - This property can take values: "Unknown" and "FullSyncCompleted". Change-Id: Ifedc8a6767db4d199b7dd00de77dd4e566346623 Signed-off-by: Harsh Agarwal <[email protected]>
harsh-agarwal1
force-pushed
the
SyncProp
branch
from
bfb479f to
535c6d7
Compare
|
As discussed, I am waiting for upstream approval of the changes, as the DBus interface directory has been updated based on the community's suggestion. This PR needs to incorporate those changes, and I noticed that a few comments have not been addressed yet. |
DataSync interfaces.
sync of the configured files and directory to the sibling BMC.
Synchronization status of the BMC.