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

Docs: All examples of command-line tools should include bucket information

    Details

    • Sprint:
      PCI Team - Sprint 3

      Description

      This page is only an example: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-tasks-replica-backoff.html

      There are places throughout the entire documentation providing examples for our command-line tools. By not providing bucket information, it has been extremely confusing to users on the correct way to use these tools. By not providing any bucket information, the command is being sent to the default bucket. However, if one does not exist, or the user wants to change a different bucket, it's not at all clear from our docs on how to do this.

      Additionally, the main page for these tools should include much more detailed information on how to use them and what/where effect they will have. i.e, a specific bucket on a specific node and not cluster-wide nor even bucket-wide.

      These pages should not use "username" or "password" but rather "bucketname" and "bucketpassword" (even though the tool still says "username", that's a separate issue and I would argue that the docs should be more clear than correct): http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline-cbepctl.html

      No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

        Hide
        kzeller kzeller added a comment -

        Closing MB-7412 and consolidating here:

        This link: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline-cbstats.html (and anywhere else we reference how to use cbstats...it's in many places)

        As of 1.8.1 (but not 1.8.0) the syntax for cbstats is now:
        cbstats <IP>:11210 <command> -b <bucket_name> [-p <bucket_password>]

        ==========

        This actually affects all of the command-line tools under: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline.html

        http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline-cbstats-warmup.html

        http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline-cbepctl.html

        Show
        kzeller kzeller added a comment - Closing MB-7412 and consolidating here: This link: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline-cbstats.html (and anywhere else we reference how to use cbstats...it's in many places) As of 1.8.1 (but not 1.8.0) the syntax for cbstats is now: cbstats <IP>:11210 <command> -b <bucket_name> [-p <bucket_password>] ========== This actually affects all of the command-line tools under: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline.html http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline-cbstats-warmup.html http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-cmdline-cbepctl.html
        Hide
        perry Perry Krug added a comment -

        Karen, my current understanding is:

        Regarding cbbackup, it can be either:
        -A single command for backing up the whole cluster (all buckets)
        -A single command for backing up one bucket across the entire cluster
        -A command being run per-node to backup all buckets on that node (meaning you have to run it separately for all nodes in the cluster)
        -A command being run per-node to backup just one bucket on that node (meaning you have to run it separately for all buckets on all nodes in the cluster)

        The cbrestore is always for the whole cluster and can be run either for a single bucket (meaning you'd have to run it separately for each bucket) or for all buckets.

        Please double-check with Steve Y and Bin C to get the correct syntax and examples as they are the authorities.

        Show
        perry Perry Krug added a comment - Karen, my current understanding is: Regarding cbbackup, it can be either: -A single command for backing up the whole cluster (all buckets) -A single command for backing up one bucket across the entire cluster -A command being run per-node to backup all buckets on that node (meaning you have to run it separately for all nodes in the cluster) -A command being run per-node to backup just one bucket on that node (meaning you have to run it separately for all buckets on all nodes in the cluster) The cbrestore is always for the whole cluster and can be run either for a single bucket (meaning you'd have to run it separately for each bucket) or for all buckets. Please double-check with Steve Y and Bin C to get the correct syntax and examples as they are the authorities.
        Hide
        kzeller kzeller added a comment -

        Check this last statement and confirm the technical information is correct and I will add.

        Show
        kzeller kzeller added a comment - Check this last statement and confirm the technical information is correct and I will add.
        Hide
        kzeller kzeller added a comment -

        -added the per bucket, per node where applicable and warning:

        Be aware that this tool is a per-node operation. If you want to perform this operation for an entire cluster, you will need to perform the command for every node that exists for that cluster.

        -noted backup can be used in 4 different contexts/level of specficity
        -Noted cbrestore for entire cluster or single bucket in cluster

        Show
        kzeller kzeller added a comment - -added the per bucket, per node where applicable and warning: Be aware that this tool is a per-node operation. If you want to perform this operation for an entire cluster, you will need to perform the command for every node that exists for that cluster. -noted backup can be used in 4 different contexts/level of specficity -Noted cbrestore for entire cluster or single bucket in cluster
        Hide
        kzeller kzeller added a comment -

        -added the per bucket, per node where applicable and warning:

        Be aware that this tool is a per-node operation. If you want to perform this operation for an entire cluster, you will need to perform the command for every node that exists for that cluster.

        -noted backup can be used in 4 different contexts/level of specficity
        -Noted cbrestore for entire cluster or single bucket in cluster

        Show
        kzeller kzeller added a comment - -added the per bucket, per node where applicable and warning: Be aware that this tool is a per-node operation. If you want to perform this operation for an entire cluster, you will need to perform the command for every node that exists for that cluster. -noted backup can be used in 4 different contexts/level of specficity -Noted cbrestore for entire cluster or single bucket in cluster

          People

          • Assignee:
            kzeller kzeller
            Reporter:
            perry Perry Krug
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Agile

                Gerrit Reviews

                There are no open Gerrit changes