From f75d6e38a36d400411f827696ec0de754e63af80 Mon Sep 17 00:00:00 2001 From: spyang Date: Tue, 14 Dec 2021 15:55:07 +0800 Subject: [PATCH] add docs content --- docs/curve-interface/curve-cli.md | 9 ++++++++ docs/curve-interface/curve-nbd.md | 5 +++++ .../curve-interface/snapshot-clone-service.md | 22 ++++++++++++++----- 3 files changed, 31 insertions(+), 5 deletions(-) diff --git a/docs/curve-interface/curve-cli.md b/docs/curve-interface/curve-cli.md index 7554adb..c5b6397 100644 --- a/docs/curve-interface/curve-cli.md +++ b/docs/curve-interface/curve-cli.md @@ -1,5 +1,14 @@ # Curve CLI +- [Create a directory](#create-a-directory) +- [Delete a directory](#delete-a-directory) +- [Create a volume](#create-a-volume) +- [Extend a volume](#extend-a-volume) +- [Get the volume information](#get-the-volume-information) +- [List the volumes in a directory](#list-the-volumes-in-a-directory) +- [Delete a volume](#delete-a-volume) +- [Code Comparison](#code-comparison) + ### Create a directory `curve mkdir [-h] --user USER --dirname DIRNAME` diff --git a/docs/curve-interface/curve-nbd.md b/docs/curve-interface/curve-nbd.md index fc71778..2b2c6fc 100644 --- a/docs/curve-interface/curve-nbd.md +++ b/docs/curve-interface/curve-nbd.md @@ -2,6 +2,11 @@ Map/unmap the curve device. +- [Usage](#usage) +- [Map](#map) +- [List mapped](#list-mapped) +- [Unmap](#unmap) + ### Usage ``` diff --git a/docs/curve-interface/snapshot-clone-service.md b/docs/curve-interface/snapshot-clone-service.md index 2593558..e21ca16 100644 --- a/docs/curve-interface/snapshot-clone-service.md +++ b/docs/curve-interface/snapshot-clone-service.md @@ -1,5 +1,17 @@ # Curve Snapshot/Clone Interface +- [Create a snapshot](#create-a-snapshot) +- [Delete a snapshot](#delete-a-snapshot) +- [Cancel a snapshot](#cancel-a-snapshot) +- [Query the snapshot information](#query-the-snapshot-information) +- [Clone](#clone) +- [Volume recover from a snapshot](#volume-recover-from-a-snapshot) +- [Flatten](#flatten) +- [Query the information of the specific clone or recover task](#query-the-information-of-the-specific-clone-or-recover-task) +- [Clean a clone or recover task](#clean-a-clone-or-recover-task) +- [Code Comparison](#code-comparison) + + ## Create a snapshot | Method | Url | @@ -209,7 +221,7 @@ Content-Length: xxx } ``` -## Clone +## Clone | Method | Url | | --- | --- | @@ -303,7 +315,7 @@ Content-Length: xxx } ``` -## Flatten: recover lazy-cloned volume +## Flatten | Method | Url | | --- | --- | @@ -346,7 +358,7 @@ Content-Length: xxx } ``` -## Query the information of the specific clone/recover task +## Query the information of the specific clone or recover task Get all tasks of the specific user, you can limit with: @@ -424,7 +436,7 @@ Content-Length: xxx } ``` -## Clean a clone/recover task +## Clean a clone or recover task Clean the clone/recover task. Delete the temporary cloned file in curvefs server if the task has been failed, otherwise delete the task only. @@ -469,7 +481,7 @@ Content-Length: xxx } ``` -## Code Comparison +## Code Comparison |Code |Message | HTTP Status Code| Description | | --- | --- | --- | --- |