Couchbase IV(管理与维护)

Couchbase IV(管理与维护)

管理

常用命令

Command                 Description

server-list             List all servers in a cluster
server-info             Show details on one server
server-add              Add one or more servers to the cluster
server-readd            Readd a server that was failed over
rebalance               Start a cluster rebalancing
rebalance-stop          Stop current cluster rebalancing
rebalance-status        Show status of current cluster rebalancing
failover                Failover one or more servers
cluster-init            Set the username,password and port of the cluster
cluster-edit            Modify cluster settings
node-init               Set node specific parameters
bucket-list             List all buckets in a cluster
bucket-create           Add a new bucket to the cluster
bucket-edit             Modify an existing bucket
bucket-delete           Delete an existing bucket
bucket-flush            Flush all data from disk for a given bucket
bucket-compact          Compact database and index data
setting-compaction      Set auto compaction settings
setting-notification    Set notifications.
setting-alert           Email alert settings
setting-autofailover    Set auto failover settings
setting-xdcr            Set XDCR-related configuration which affect behavior.
xdcr-setup              Set up XDCR replication.
xdcr-replicate          Create and run replication via XDCR
help show longer        usage/help and example

命令选项

Command Option  Description

server-add      --server-add=HOST[:PORT]    Server to add to cluster
server-add      --server-add-username=USERNAME  Admin username for the server to be added
server-add      --server-add-password=PASSWORD  Admin password for the server to be added

server-readd    --server-add=HOST[:PORT]    Server to re-add to cluster
server-readd    --server-add-username=USERNAME  Admin username for the server to be added
server-readd    --server-add-password=PASSWORD  Admin password for the server to be added

rebalance    --server-add*  See server-add OPTIONS
rebalance    --server-remove=HOST[:PORT]    The server to remove from cluster

failover     --server-failover=HOST[:PORT]  Server to failover

cluster-*    --cluster-username=USER    New admin username
cluster-*    --cluster-password=PASSWORD    New admin password
cluster-*    --cluster-port=PORT    New cluster REST/http port
cluster-*    --cluster-ramsize=RAMSIZEMB    Per node RAM quota in MB

node-init    --node-init-data-path=PATH Per node path to store data
node-init    --node-init-index-path=PATH    Per node path to store index

bucket-*     --bucket=BUCKETNAME    Named bucket to act on
bucket-*     --bucket-type=TYPE Bucket type, either memcached or couchbase
bucket-*     --bucket-port=PORT Supports ASCII protocol and does not require authentication
bucket-*     --bucket-password=PASSWORD Standard port, exclusive with bucket-port
bucket-*     --bucket-ramsize=RAMSIZEMB Bucket RAM quota in MB
bucket-*     --bucket-replica=COUNT Replication count
bucket-*     --enable-flush=[0|1]   Enable/disable flush
bucket-*     --enable-index-replica=[0|1]   Enable/disable index replicas
bucket-*     --wait Wait for bucket create to be complete before returning
bucket-*     --force    Force command execution without asking for confirmation
bucket-*     --data-only    Compact database data only
bucket-*     --view-only    Compact view data only

setting-compacttion  --compaction-db-percentage=PERCENTAGE  Percentage of disk fragmentation when database compaction is triggered

setting-compacttion  --compaction-db-size=SIZE[MB]  Size of disk fragmentation when database compaction is triggered
setting-compacttion  --compaction-view-percentage=PERCENTAGE    Percentage of disk fragmentation when views compaction is triggered
setting-compacttion  --compaction-view-size=SIZE[MB]    Size of disk fragmentation when views compaction is triggered
setting-compacttion  --compaction-period-from=HH:MM Enable compaction from this time onwards
setting-compacttion  --compaction-period-to=HH:MM   Stop enabling compaction at this time
setting-compacttion  --enable-compaction-abort=[0|1]    Allow compaction to abort when time expires
setting-compacttion  --enable-compaction-parallel=[0|1] Allow parallel compaction processes for database and view

setting-notification    --enable-notification=[0|1] Allow notifications

setting-alert   --enable-email-alert=[0|1]  Allow email alert
setting-alert   --email-recipients=RECIPIENT    Email recipents, separate addresses with , or ;
setting-alert   --email-sender=SENDER   Sender email address
setting-alert   --email-user=USER   Email server username
setting-alert   --email-password=PWD    Email server password
setting-alert   --email-host=HOST   Email server hostname
setting-alert   --email-port=PORT   Email server port
setting-alert   --enable-email-encrypt=[0|1]    Email encryption with 0 the default for no encryption
setting-alert   --alert-auto-failover-node  Node was failed over via autofailover
setting-alert   --alert-auto-failover-max-reached   Maximum number of auto failover nodes reached
setting-alert   --alert-auto-failover-node-down Node not auto failed-over as other nodes are down at the same time
setting-alert   --alert-auto-failover-cluster-small Node not auto failed-over as cluster was too small
setting-alert   --alert-ip-changed  Node ip address changed unexpectedly
setting-alert   --alert-disk-space  Disk space used for persistent storage has reached at least 90% capacity
setting-alert   --alert-meta-overhead   Metadata overhead is more than 50% of RAM for node
setting-alert   --alert-meta-oom    Bucket memory on a node is entirely used for metadata
setting-alert   --alert-write-failed    Writing data to disk for a specific bucket has failed

setting-autofailover    --enable-auto-failover=[0|1]    Allow auto failover
setting-autofailover    --auto-failover-timeout=TIMEOUT (>=30)  Specify amount of node timeout that triggers auto failover

setting-xdcr    --max-concurrent-reps=[32]  Maximum concurrent replicators per bucket, 8 to 256.
setting-xdcr    --checkpoint-interval=[1800]    Intervals between checkpoints, 60 to 14400 seconds.
setting-xdcr    --worker-batch-size=[500]   Doc batch size, 500 to 10000.
setting-xdcr    --doc-batch-size=[2048]KB   Document batching size, 10 to 100000 KB
setting-xdcr    --failure-restart-interval=[30] Interval for restarting failed xdcr, 1 to 300 seconds
setting-xdcr    --optimistic-replication-threshold=[256]    Document body size threshold (bytes) to trigger optimistic replication

xdcr-setup  --create    Create a new xdcr configuration
xdcr-setup  --edit  Modify existed xdcr configuration
xdcr-setup  --delete    Delete existing xdcr configuration
xdcr-setup  --xdcr-cluster-name=CLUSTERNAME Remote cluster name
xdcr-setup  --xdcr-hostname=HOSTNAME    Remote host name to connect to
xdcr-setup  --xdcr-username=USERNAME    Remote cluster admin username
xdcr-setup  --xdcr-password=PASSWORD    Remote cluster admin password

xdcr-replicate  --create    Create and start a new replication
xdcr-replicate  --delete    Stop and cancel a replication
xdcr-replicate  --xdcr-from-bucket=BUCKET   Source bucket name to replicate from
xdcr-replicate  --xdcr-clucter-name=CLUSTERNAME Remote cluster to replicate to
xdcr-replicate  --xdcr-to-bucket=BUCKETNAME Remote bucket to replicate to

备份与恢复

cbbackup

可以用来备份单节点，单bucket，甚至整个集群

命令格式如下：

cbbackup [options] [source] [backup_dir]

[options]

• --single-node

  备份指定的单节点
  

• --bucket-source or -b

  备份指定的bucket
  

[source]

• Local Directory Reference

  使用couchstore-files的url形式备份在某node的单bucket：
  couchstore-files:///opt/couchbase/var/lib/couchbase/data/default
  这类方法不备份bucket的design document
  

• cluster node

  备份整个节点，使用url形式：
  http://HOST:8091
  
  使用couchbase 协议前缀：
  couchbase://Administrator:password@HOST:8091
  
  url的多余选项可以用来指定备份整个集群或某一节点，或单bucket等
  

[backup_dir]

备份的路径

cbbackup最佳实践

Backup all nodes and all buckets

shell> cbbackup http://HOST:8091 /backups/backup-20120501 \
  -u Administrator -p password
  [####################] 100.0% (231726/231718 msgs)
bucket: default, msgs transferred...
       :                total |       last |    per sec
 batch :                 5298 |       5298 |      617.1
 byte  :             10247683 |   10247683 |  1193705.5
 msg   :               231726 |     231726 |    26992.7
done
  [####################] 100.0% (11458/11458 msgs)
bucket: loggin, msgs transferred...
       :                total |       last |    per sec
 batch :                 5943 |       5943 |    15731.0
 byte  :             11474121 |   11474121 | 30371673.5
 msg   :84 |84 |   643701.2
done

Backup all nodes, single bucket

shell> cbbackup http://HOST:8091 /backups/backup-20120501 \
  -u Administrator -p password \
  -b default
  [####################] 100.0% (231726/231718 msgs)
bucket: default, msgs transferred...
       :                total |       last |    per sec
 batch :                 5294 |       5294 |      617.0
 byte  :             10247683 |   10247683 |  1194346.7
 msg   :               231726 |     231726 |    27007.2
done

Backup single node, all buckets

shell> cbbackup http://HOST:8091 /backups/backup-20120501 \
  -u Administrator -p password \
  --single-node

Backup single node, single bucket; backup files stored on same node

shell> ssh USER@HOST
remote-shell> sudo su - couchbase
remote-shell> cbbackup http://127.0.0.1:8091 /mnt/backup-20120501 \
  -u Administrator -p password \
  --single-node \
  -b default

过滤bucket的key

#只备份key前缀为object.的内容数据
shell> cbbackup http://HOST:8091 /backups/backup-20120501 \
  -u Administrator -p password \
  -b default \
  -k '^object.*'

使用复制备份

shell> cbbackup \
couchstore-files:///opt/couchbase/var/lib/couchbase/data/default \
/mnt/backup-20120501

#上面的cbbackup相当于：
shell> cp -R /opt/couchbase/var/lib/couchbase/data/default \
  /mnt/copy-20120501

cbrestore

用于恢复数据到节点或指定bucket等

命令格式：

cbrestore [options] [source] [destination]

[options]

• --bucket-source

  指定要恢复bucket的名字
  

• --bucket-destination

  指定要恢复到bucket的名字
  

[source]

指定要备份数据的路径

[destination]

指定要数据恢复到的源

cbresotre最佳实践

恢复一个bucket到集群

shell> cbrestore \
    /backups/backup-2012-05-10 \
    http://Administrator:password@HOST:8091 \
    --bucket-source=XXX
  [####################] 100.0% (231726/231726 msgs)
bucket: default, msgs transferred...
       :                total |       last |    per sec
 batch :                  232 |        232 |       33.1
 byte  :             10247683 |   10247683 |  1462020.7
 msg   :               231726 |     231726 |    33060.0
done

恢复bucket到指定的bucket

shell> cbrestore \
    /backups/backup-2012-05-10 \
    http://Administrator:password@HOST:8091 \
    --bucket-source=XXX \
    --bucket-destination=YYY
  [####################] 100.0% (231726/231726 msgs)
bucket: default, msgs transferred...
       :                total |       last |    per sec
 batch :                  232 |        232 |       33.1
 byte  :             10247683 |   10247683 |  1462020.7
 msg   :               231726 |     231726 |    33060.0
done

过滤筛选bucekt的内容

#恢复key前缀为obejct的文档
shell> cbrestore /backups/backup-20120501 http://HOST:8091 \
  -u Administrator -p password \
  -b default \
  -k '^object.*'
2013-02-18 10:39:09,476: w0 skipping msg with key: sales_7597_3783_6
...
2013-02-18 10:39:09,476: w0 skipping msg with key: sales_5575_3699_6
2013-02-18 10:39:09,476: w0 skipping msg with key: sales_7597_3840_6
  [                    ] 0.0% (0/231726 msgs)
bucket: default, msgs transferred...
       :                total |       last |    per sec
 batch :                    1 |          1 |        0.1
 byte  :                    0 |          0 |        0.0
 msg   :                    0 |          0 |        0.0
done