Uploaded image for project: 'Couchbase Server'
  1. Couchbase Server
  2. MB-8368

Make Couchbase-cli -h consistent

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Minor
    • 3.0
    • 3.0
    • tools
    • Security Level: Public
    • None
    • Yes

    Description

      Hi Anil,

      I found several typos and a few confusing explanations for couchbase-cli command options. Here are my suggested updates which will also make --help consistent with the docs. Please review and assign to engineering to update. Be also aware that compaction is misspelled as a command: "setting-compacttion"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      Attachments

        For Gerrit Dashboard: MB-8368
        # Subject Branch Project Status CR V

        Activity

          People

            bcui Bin Cui (Inactive)
            anil Anil Kumar (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty