Merge pull request cubefs#396 from ssscottt/master

doc: update parameters in documentation according to yum tools.

docs/source/admin-api/master/cluster.rst

@@ -6,7 +6,7 @@ Overview
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/admin/getCluster" | python -m json.tool
+   curl -v "http://10.196.59.198:17010/admin/getCluster" | python -m json.tool
 
 
 display the base information of the cluster, such as the detail of metaNode,dataNode,vol and so on.
@@ -17,7 +17,7 @@ response
 
    {
        "Name": "test",
-       "LeaderAddr": "127.0.0.1:80",
+       "LeaderAddr": "10.196.59.198:17010",
        "DisableAutoAlloc": false,
        "Applied": 225,
        "MaxDataPartitionID": 100,
@@ -36,11 +36,11 @@ Freeze
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/cluster/freeze?enable=true"
+   curl -v "http://10.196.59.198:17010/cluster/freeze?enable=true"
 
 if cluster is freezed,the vol never allocates dataPartitions automatically
 
 .. csv-table:: Parameters
    :header: "Parameter", "Type", "Description"
 
-   "enable", "bool", "if enable is true,the cluster is freezed"
+   "enable", "bool", "if enable is true,the cluster is freezed"

docs/source/admin-api/master/data-partition.rst

@@ -6,7 +6,7 @@ Create
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/dataPartition/create?count=400&name=test"
+   curl -v "http://10.196.59.198:17010/dataPartition/create?count=400&name=test"
 
 
 create a set of data partition
@@ -22,7 +22,7 @@ Get
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/dataPartition/get?id=100"  | python -m json.tool
+   curl -v "http://10.196.59.198:17010/dataPartition/get?id=100"  | python -m json.tool
 
 
 .. csv-table:: Parameters
@@ -54,7 +54,7 @@ Decommission
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/dataPartition/decommission?id=13&addr=127.0.0.1:5000"
+   curl -v "http://10.196.59.198:17010/dataPartition/decommission?id=13&addr=10.196.59.201:17310"
 
 
 remove the replica of data partition,and create new replica asynchronous
@@ -70,7 +70,7 @@ Load
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/dataPartition/load?id=1"
+   curl -v "http://10.196.59.198:17010/dataPartition/load?id=1"
 
 
 send load task to the dataNode which data partition locate on,then check the crc of each file in the data partition asynchronous

docs/source/admin-api/master/datanode.rst

@@ -6,7 +6,7 @@ GET
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/dataNode/get?addr=127.0.0.1:5000"  | python -m json.tool
+   curl -v "http://10.196.59.198:17010/dataNode/get?addr=10.196.59.201:17310"  | python -m json.tool
 
 
 show the base information of the dataNode,such as addr,disk total size,disk used size and so on.
@@ -28,7 +28,7 @@ response
        "UsedWeight": 2438143586304,
        "Available": 37228069113856,
        "Cell": "default",
-       "Addr": "10.196.30.231:6000",
+       "Addr": "10.196.59.201:17310",
        "ReportTime": "2018-12-06T10:56:38.881784447+08:00",
        "Ratio": 0.06146650815226848,
        "SelectCount": 5,
@@ -45,12 +45,12 @@ Decommission
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/dataNode/decommission?addr=127.0.0.1:5000"
+   curl -v "http://10.196.59.198:17010/dataNode/decommission?addr=10.196.59.201:17310"
 
 
 remove the dataNode from cluster, data partitions which locate the dataNode will be migrate other available dataNode asynchronous
 
 .. csv-table:: Parameters
    :header: "Parameter", "Type", "Description"
 
-   "addr", "string", "the addr which communicate with master"
+   "addr", "string", "the addr which communicate with master"

docs/source/admin-api/master/management.rst

@@ -6,7 +6,7 @@ Add
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/raftNode/add?addr=127.0.0.1:80&id=3"
+   curl -v "http://10.196.59.198:17010/raftNode/add?addr=10.196.59.197:17010&id=3"
 
 
 add new master  node to master raft group
@@ -22,7 +22,7 @@ Remove
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/raftNode/remove?addr=127.0.0.1:80&id=3"
+   curl -v "http://10.196.59.198:17010/raftNode/remove?addr=10.196.59.197:17010&id=3"
 
 
 remove the master node from master raft group
@@ -31,4 +31,4 @@ remove the master node from master raft group
    :header: "Parameter", "Type", "Description"
 
    "addr", "string", "the addr of master server, format is ip:port"
-   "id", "uint64", "the node id of master server"
+   "id", "uint64", "the node id of master server"

docs/source/admin-api/master/meta-partition.rst

@@ -6,7 +6,7 @@ Create
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/metaPartition/create?name=test&start=10000"
+   curl -v "http://10.196.59.198:17010/metaPartition/create?name=test&start=10000"
 
 
 split meta partition manually,if max meta partition of the vol which range is [0,end),end larger than start parameter,old meta partition range is[0,start], new meta partition is [start+1,end)
@@ -22,7 +22,7 @@ Get
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/client/metaPartition?id=1" | python -m json.tool
+   curl -v "http://10.196.59.198:17010/client/metaPartition?id=1" | python -m json.tool
 
 
 show base information of meta partition,such as id,start,end and so on.
@@ -55,7 +55,7 @@ Decommission
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/metaPartition/decommission?id=13&addr=127.0.0.1:9021"
+   curl -v "http://10.196.59.198:17010/metaPartition/decommission?id=13&addr=10.196.59.202:17210"
 
 
 remove the replica of meta partition,and create new replica asynchronous
@@ -71,7 +71,7 @@ Load
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/metaPartition/load?id=1"
+   curl -v "http://10.196.59.198:17010/metaPartition/load?id=1"
 
 
 send load task to the metaNode which meta partition locate on,then check the crc of each replica in the meta partition

docs/source/admin-api/master/metanode.rst

@@ -6,7 +6,7 @@ GET
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/metaNode/get?addr=127.0.0.1:9021"  | python -m json.tool
+   curl -v "http://10.196.59.198:17010/metaNode/get?addr=10.196.59.202:17210"  | python -m json.tool
 
 
 show the base information of the metaNode,such as addr,total memory,used memory and so on.
@@ -22,7 +22,7 @@ response
 
    {
        "ID": 3,
-       "Addr": "127.0.0.1:9021",
+       "Addr": "10.196.59.202:17210",
        "IsActive": true,
        "Sender": {
            "TaskMap": {}
@@ -68,4 +68,4 @@ the used memory percent arrives the threshold,the status of the meta partitions
 .. csv-table:: Parameters
    :header: "Parameter", "Type", "Description"
 
-   "threshold", "float64", "the max percent of memory which metaNode can use"
+   "threshold", "float64", "the max percent of memory which metaNode can use"

docs/source/admin-api/master/volume.rst

@@ -6,7 +6,7 @@ Create
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/admin/createVol?name=test&capacity=100&owner=cfs&mpCount=3"
+   curl -v "http://10.196.59.198:17010/admin/createVol?name=test&capacity=100&owner=cfs&mpCount=3"
 
 
 | Allocate a set of data partition and a meta partition to the user.
@@ -25,7 +25,7 @@ Delete
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/vol/delete?name=test&authKey=md5(owner)"
+   curl -v "http://10.196.59.198:17010/vol/delete?name=test&authKey=md5(owner)"
 
 
 Mark the vol status to MarkDelete first, then delete data partition and meta partition asynchronous,finally delete meta data from persist store
@@ -41,7 +41,7 @@ Get
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/client/vol?name=test&authKey=md5(owner)" | python -m json.tool
+   curl -v "http://10.196.59.198:17010/client/vol?name=test&authKey=md5(owner)" | python -m json.tool
 
 
 show the base information of the vol,such as name,the detail of data partitions and meta partitions and so on.
@@ -73,7 +73,7 @@ Stat
 
 .. code-block:: bash
 
-   curl -v http://127.0.0.1/client/volStat?name=test
+   curl -v http://10.196.59.198:17010/client/volStat?name=test
 
 
 show vol stat information
@@ -99,7 +99,7 @@ Update
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1/vol/update?name=test&capacity=100&authKey=md5(owner)"
+   curl -v "http://10.196.59.198:17010/vol/update?name=test&capacity=100&authKey=md5(owner)"
 
 add the vol quota
 
@@ -108,4 +108,4 @@ add the vol quota
 
    "name", "string", ""
    "capacity", "int", "the quota of vol, unit is GB"
-   "authKey", "string", "calculates the MD5 value of the owner field  as authentication information"
+   "authKey", "string", "calculates the MD5 value of the owner field  as authentication information"

docs/source/admin-api/metanode/dentry.rst

@@ -6,7 +6,7 @@ Get Dentry
 
 .. code-block:: bash
 
-   curl -v 'http://127.0.0.1:9092/getDentry?pid=100&name=""&parentIno=1024'
+   curl -v 'http://10.196.59.202:17210/getDentry?pid=100&name=""&parentIno=1024'
 
 
 Get dentry information
@@ -24,7 +24,7 @@ Get Directory
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1:9092/getDirectory?pid=100&parentIno=1024"
+   curl -v "http://10.196.59.202:17210/getDirectory?pid=100&parentIno=1024"
 
 
 Get all files of the parent inode is 1024
@@ -41,11 +41,11 @@ Get All Dentry
 
 .. code-block:: bash
 
-   curl -v "http://127.0.0.1:9092/getAllDentry?pid=100"
+   curl -v "http://10.196.59.202:17210/getAllDentry?pid=100"
 
 
 
 .. csv-table:: Parameters
    :header: "Parameter", "Type", "Description"
 
-   "pid", "integer", "partition id"
+   "pid", "integer", "partition id"

docs/source/admin-api/metanode/inode.rst

@@ -6,7 +6,7 @@ Get Inode
 
 .. code-block:: bash
 
-   curl -v http://127.0.0.1:9092/getInode?pid=100&ino=1024
+   curl -v http://10.196.59.202:17210/getInode?pid=100&ino=1024
 
 Get inode information
 
@@ -21,7 +21,7 @@ Get Extents by Inode
 
 .. code-block:: bash
 
-   curl -v http://127.0.0.1:9092/getExtentsByInode?pid=100&ino=1024
+   curl -v http://10.196.59.202:17210/getExtentsByInode?pid=100&ino=1024
 
 Get inode all extents information
 
@@ -36,7 +36,7 @@ Get All Inodes
 
 .. code-block:: bash
 
-   curl -v http://127.0.0.1:9092/getAllInodes?pid=100
+   curl -v http://10.196.59.202:17210/getAllInodes?pid=100
 
 Get all inodes of the specified partition
 

docs/source/admin-api/metanode/partition.rst

@@ -6,7 +6,7 @@ Get Partitions
 
 .. code-block:: bash
 
-   curl -v  http://127.0.0.1:9092/getPartitions
+   curl -v  http://10.196.59.202:17210/getPartitions
 
 Get all meta-partition base information of the metanode.
 
@@ -15,7 +15,7 @@ Get Partition by ID
 
 .. code-block:: bash
 
-   curl -v http://127.0.0.1:9092/getPartitionById?pid=100
+   curl -v http://10.196.59.202:17210/getPartitionById?pid=100
 
 Get the specified partition information, this result contains: leader address, raft group peer and cursor.
 

docs/source/index.rst

@@ -7,7 +7,7 @@ Welcome to ChubaoFS(Chubao File System)
 
    overview
    user-guide/yum
-   quick-start-guide
+   manual-deploy
 
 .. toctree::
    :maxdepth: 2