Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-3232

cbsummary command needs documentation

    XMLWordPrintable

Details

    • Bug
    • Resolution: Unresolved
    • Major
    • 6.5.x Doc Updates
    • spock, Server 5.5/Vulcan
    • server-tools
    • None
    • DOC-2020-S10-May31, DOC-2020-S11-Jun14, DOC-2020-S12-Jun28, DOC-2020-S13-Jul12, DOC-2020-S14-Jul26, DOC-2020-S15-Aug09, DOC-2020-S22-Nov15
    • 1

    Description

      Chaitra reports that there is no documentation for cbsummary.

      cbsummary is a relatively simple command that was added in Spock for connecting to a series of clusters and generating a report. The usage details, as reported by the tool, are:

       

      usage: cbsummary --config=<config file> [--output=<output file>]
       
        cbsummary connects to a set of Couchbase clusters and generates a summary report.
       
        The config file contains JSON specifying an array of information on each cluster,
        giving the Couchbase login/password and one or more IP addresses for cluster nodes.
        An example config file giving information about 2 clusters is:
       
        { "clusters": [
          {"login": "Administrator", "pass": "password1", "nodes": ["http://192.168.1.1:8091"]},
          {"login": "Administrator", "pass": "password2", "nodes": ["http://192.166.1.1:8091","http://192.16.1.2:8091"]}
        ]}
       
        The summary report is sent to the file 'cbsummary.out.<timestamp>', unless a different
        file name is specified with the --output option.
      
      

       

      Attachments

        Issue Links

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

          Activity

            People

              amarantha.kulkarni Amarantha Kulkarni (Inactive)
              eben Eben Haber
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty