[ 
https://issues.apache.org/jira/browse/RATIS-637?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16899691#comment-16899691
 ] 

Ankit Singhal commented on RATIS-637:
-------------------------------------

we need to change this from
{code}
+### ARCHIVING
+
+The ARCHIVING state is reached by the archive or export API call from
+the LogService client. Archive and Export are similar actions. An archival
+of a log is equivalent to an export of that log from the beginning of the
+log file to a known location.
+
{code}

to
{code}

+The ARCHIVING state is reached by the archive API call from
+the LogService client. An archival
+of a log is equivalent to an export of that log from the beginning of the
+log file to a known location.
{code}

Archive and Export are similar actions with a difference that Export doesn't 
change the state of the log and can be done as many times to different 
locations even when the log is OPEN/CLOSED but archival can be done once to a 
predefined location and can only be done when the log is CLOSED.

LSC#getExportInfo API can be used to get details on the progress of export. 
While for Archival, the state of the log can be monitored until it turns to 
ARCHIVED from ARCHIVING.



> Document the lifecycle of a log
> -------------------------------
>
>                 Key: RATIS-637
>                 URL: https://issues.apache.org/jira/browse/RATIS-637
>             Project: Ratis
>          Issue Type: Task
>          Components: LogService
>            Reporter: Josh Elser
>            Assignee: Josh Elser
>            Priority: Major
>             Fix For: asf-site
>
>         Attachments: RATIS-637.001.patch
>
>
> With Ankit's changes around archiving and exporting logs, it would be good to 
> get a diagram on the lifecycle of a log on the website.



--
This message was sent by Atlassian JIRA
(v7.6.14#76016)

Reply via email to