[ 
https://issues.apache.org/jira/browse/HDDS-16986?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Siyao Meng updated HDDS-16986:
------------------------------
    Description: 
The snapshot documentation explains the design and system internals of snapshot 
defragmentation, but does not provide an operational user guide for enabling 
and using the feature.

Add the user guide to the Next documentation in apache/ozone-site, under 
Administrator Guide -> Operations -> Snapshots, with instructions covering:
* Prerequisites, including upgrade finalization, native rocks-tools 
availability, and administrator access for manual triggers.
* The defragmentation configuration keys and their current defaults, with an 
example of enabling periodic runs on each OM.
* Manual triggering with ozone admin om snapshot defrag, including HA 
service/node selection, --no-wait, and the per-task snapshot limit.
* Monitoring successful processing and failures through OM logs and snapshot 
metrics, and troubleshooting a disabled or unavailable service.
* The scope of space savings (OM snapshot metadata), temporary disk usage, and 
unchanged snapshot data access.

Link the guide from the snapshot documentation and retain the existing design 
document. HDDS-15113 and HDDS-15105 cover the existing system internals/design 
documentation; this task covers operational usage.

  was:
The snapshot documentation explains the design and system internals of snapshot 
defragmentation, but does not provide an operational user guide for enabling 
and using the feature.

Add user instructions covering:
* Prerequisites, including upgrade finalization, native rocks-tools 
availability, and administrator access for manual triggers.
* The defragmentation configuration keys and their current defaults, with an 
example of enabling periodic runs on each OM.
* Manual triggering with ozone admin om snapshot defrag, including HA 
service/node selection, --no-wait, and the per-task snapshot limit.
* Monitoring successful processing and failures through OM logs and snapshot 
metrics, and troubleshooting a disabled or unavailable service.
* The scope of space savings (OM snapshot metadata), temporary disk usage, and 
unchanged snapshot data access.

Link the guide from the snapshot documentation and retain the existing design 
document. HDDS-15113 and HDDS-15105 cover the existing system internals/design 
documentation; this task covers operational usage.


> [Docs] Add snapshot defragmentation user guide
> ----------------------------------------------
>
>                 Key: HDDS-16986
>                 URL: https://issues.apache.org/jira/browse/HDDS-16986
>             Project: Apache Ozone
>          Issue Type: Sub-task
>            Reporter: Siyao Meng
>            Assignee: Siyao Meng
>            Priority: Major
>
> The snapshot documentation explains the design and system internals of 
> snapshot defragmentation, but does not provide an operational user guide for 
> enabling and using the feature.
> Add the user guide to the Next documentation in apache/ozone-site, under 
> Administrator Guide -> Operations -> Snapshots, with instructions covering:
> * Prerequisites, including upgrade finalization, native rocks-tools 
> availability, and administrator access for manual triggers.
> * The defragmentation configuration keys and their current defaults, with an 
> example of enabling periodic runs on each OM.
> * Manual triggering with ozone admin om snapshot defrag, including HA 
> service/node selection, --no-wait, and the per-task snapshot limit.
> * Monitoring successful processing and failures through OM logs and snapshot 
> metrics, and troubleshooting a disabled or unavailable service.
> * The scope of space savings (OM snapshot metadata), temporary disk usage, 
> and unchanged snapshot data access.
> Link the guide from the snapshot documentation and retain the existing design 
> document. HDDS-15113 and HDDS-15105 cover the existing system 
> internals/design documentation; this task covers operational usage.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to