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

Documentation: Clarify Compress and Uncompress Options in Cbbackup/CbabbackupWrapper, CbRestoreWrapper

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Major
    • Server 5.5/Vulcan
    • 3.0.x, 3.1.x, 4.1, 4.5.1
    • tools
    • None

    Description

      +Background: +

      There seems to be much confusion over whether compression is enabled in the legacy cbbackup and cbrestore utilities: the purpose of this Doc Bug is to get documentation consistency across all CB versions.

      According to MB-10917, cbbackup compression capability is delayed until Spock. However, the documentation for cbbackup shows a compress and uncompress option now: http://docs.couchbase.com/admin/admin/CLI/cbbackup_tool.html.

      Cbbackupwrapper in 4.5.1 has an "uncompress" flag in its option list if one executes "cbbackupwrapper help" ; this option is not found in the option list of cbbackupwrapper for 3.1.X. the "uncompress" option is listed in the cbbackupwrapper documentation although, again, it is not documented very clearly. See http://developer.couchbase.com/documentation/server/current/cli/cbbackup-wrapper.html.

      So there is much confusion over whether compression has been introduced into the existing cbbackup/cbrestore utilities and their wrappers, and additional confusion of how the "uncompress" flag actually works in the various utilities.

      Can we get this clarified and retrofitted into the docs?

      Attachments

        Issue Links

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

          Activity

            People

              simon.dew Simon Dew
              morrie Morrie Schreibman (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - 40h
                  40h
                  Remaining:
                  Remaining Estimate - 40h
                  40h
                  Logged:
                  Time Spent - Not Specified
                  Not Specified

                  Gerrit Reviews

                    There are no open Gerrit changes

                    PagerDuty