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

cbectl documentation needs updating

    XMLWordPrintable

Details

    • Bug
    • Status: In Progress
    • Major
    • Resolution: Unresolved
    • 5.x Doc Updates, 6.x Doc Updates
    • Morpheus
    • server-tools
    • None
    • DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22
    • 1

    Description

      Noticed that the cbectl options don't appear to match what is offered in the tool.
      For example in 5.5.3/6.0 the tool offers the ability to change.

      • num_reader_threads
      • num_writer_threads
      • num_auxio_threads
      • num_nonio_threads

      But the documentation refers to

      • max_num_readers
      • max_num_writers
      • max_num_auxio
      • max_num_nonio

      6.0 docl
      5.5 doc

      The set of available options are documented in the code at the following
      5.5.3 code doc
      6.0 code doc

      Also the limit described in the Performance tuning options
      "All these options can be used only to tune down the number of threads: if the value was set as N at initial startup, then only a value < N will work."
      is now outdated (as of 5.0) given the following MB-22041

      Attachments

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

        Activity

          owend Daniel Owen created issue -
          owend Daniel Owen made changes -
          Field Original Value New Value
          Summary cbectl needs updating cbectl documentation needs updating
          owend Daniel Owen made changes -
          Description Noticed that the cbectl options don't appear to match what is offered in the tool.
          For example in 5.5.3/6.0 the tool offers the ability to change.

          - num_reader_threads
          - num_writer_threads
          - num_auxio_threads
          - num_nonio_threads

          But the documentation refers to
          - max_num_readers
          - max_num_writers
          - max_num_auxio
          - max_num_nonio

          [6.0 docl|https://docs.couchbase.com/server/6.0/cli/cbepctl/set-flush_param.html]
          [5.5 doc|https://docs.couchbase.com/server/5.5/cli/cbepctl/set-flush_param.html]

          The set of available options are documented in the code at the following
          [5.5.3 code doc|http://src.couchbase.org/source/xref/5.5.3/kv_engine/engines/ep/management/cbepctl#145]
          [6.0 code doc|http://src.couchbase.org/source/xref/6.0.0/kv_engine/engines/ep/management/cbepctl#145]
          Noticed that the cbectl options don't appear to match what is offered in the tool.
          For example in 5.5.3/6.0 the tool offers the ability to change.

          - num_reader_threads
          - num_writer_threads
          - num_auxio_threads
          - num_nonio_threads

          But the documentation refers to
          - max_num_readers
          - max_num_writers
          - max_num_auxio
          - max_num_nonio

          [6.0 docl|https://docs.couchbase.com/server/6.0/cli/cbepctl/set-flush_param.html]
          [5.5 doc|https://docs.couchbase.com/server/5.5/cli/cbepctl/set-flush_param.html]

          The set of available options are documented in the code at the following
          [5.5.3 code doc|http://src.couchbase.org/source/xref/5.5.3/kv_engine/engines/ep/management/cbepctl#145]
          [6.0 code doc|http://src.couchbase.org/source/xref/6.0.0/kv_engine/engines/ep/management/cbepctl#145]

          Also the limit described in the Performance tuning options
          "All these options can be used only to tune down the number of threads: if the value was set as N at initial startup, then only a value < N will work."
          is now outdated (as of 5.0) given the following [MB-22041|https://issues.couchbase.com/browse/MB-22041]
          amarantha.kulkarni Amarantha Kulkarni (Inactive) made changes -
          Affects Version/s 5.x Doc Updates [ 15024 ]
          Affects Version/s 5.5.3 [ 15923 ]
          amarantha.kulkarni Amarantha Kulkarni (Inactive) made changes -
          Component/s documentation [ 11812 ]
          amarantha.kulkarni Amarantha Kulkarni (Inactive) made changes -
          Component/s tools [ 13024 ]
          pvarley Patrick Varley made changes -
          Component/s server-tools [ 15713 ]
          Component/s tools [ 13024 ]
          amarantha.kulkarni Amarantha Kulkarni (Inactive) made changes -
          Fix Version/s 6.5 Milestone 1 [ 16654 ]
          amarantha.kulkarni Amarantha Kulkarni (Inactive) made changes -
          Fix Version/s Mad Hatter [ 15119 ]
          amarantha.kulkarni Amarantha Kulkarni (Inactive) made changes -
          Assignee Amarantha Kulkarni [ amarantha.kulkarni ] Tony Hillman [ tony.hillman ]
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S4-Mar08 [ 985 ]
          tony.hillman Tony Hillman made changes -
          Rank Ranked lower
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S4-Mar08 [ 985 ] DOC-2020-S3-Feb23 [ 984 ]
          tony.hillman Tony Hillman made changes -
          Rank Ranked lower
          tony.hillman Tony Hillman made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          tony.hillman Tony Hillman made changes -
          Fix Version/s Cheshire Cat [ 16006 ]
          Fix Version/s 6.5 Milestone 1 [ 16654 ]
          simon.dew Simon Dew made changes -
          Sprint DOC-2020-S3-Feb23 [ 984 ] DOC-2020-S3-Feb23, DOC-2020-S4-Mar08 [ 984, 994 ]
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S3-Feb23, DOC-2020-S4-Mar08 [ 984, 994 ] DOC-2020-S3-Feb23 [ 984 ]
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S3-Feb23 [ 984 ] DOC-2020-S3-Feb23, DOC-2020-S5-Mar22 [ 984, 995 ]
          tony.hillman Tony Hillman made changes -
          Rank Ranked higher
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S3-Feb23, DOC-2020-S5-Mar22 [ 984, 995 ] DOC-2020-S3-Feb23, DOC-2020-S4-Mar08 [ 984, 994 ]
          tony.hillman Tony Hillman made changes -
          Rank Ranked lower
          simon.dew Simon Dew made changes -
          Sprint DOC-2020-S3-Feb23, DOC-2020-S4-Mar08 [ 984, 994 ] DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22 [ 984, 994, 995 ]
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22 [ 984, 994, 995 ] DOC-2020-S3-Feb23, DOC-2020-S4-Mar08 [ 984, 994 ]
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S3-Feb23, DOC-2020-S4-Mar08 [ 984, 994 ] DOC-2020-S3-Feb23, SDK11: ??, DOC-2020-S4-Mar08 [ 984, 985, 994 ]
          tony.hillman Tony Hillman made changes -
          Rank Ranked higher
          amarantha.kulkarni Amarantha Kulkarni (Inactive) made changes -
          Sprint DOC-2020-S3-Feb23, SDK11: Coll/Txn/Docs More Chip, DOC-2020-S4-Mar08 [ 984, 985, 994 ] DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22 [ 984, 994, 995 ]
          simon.dew Simon Dew made changes -
          Sprint DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22 [ 984, 994, 995 ] DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22, DOC-2020-S6-Apr05 [ 984, 994, 995, 1012 ]
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22, DOC-2020-S6-Apr05 [ 984, 994, 995, 1012 ] DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22 [ 984, 994, 995 ]
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22 [ 984, 994, 995 ] DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22, DOC-2020-S7-Apr19 [ 984, 994, 995, 1021 ]
          tony.hillman Tony Hillman made changes -
          Rank Ranked higher
          tony.hillman Tony Hillman made changes -
          Sprint DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22, DOC-2020-S7-Apr19 [ 984, 994, 995, 1021 ] DOC-2020-S3-Feb23, DOC-2020-S4-Mar08, DOC-2020-S5-Mar22 [ 984, 994, 995 ]
          tony.hillman Tony Hillman made changes -
          Rank Ranked higher
          brett19 Brett Lawson made changes -
          Story Points 1
          tony.hillman Tony Hillman made changes -
          Fix Version/s CheshireCat.Next [ 17125 ]
          Fix Version/s Cheshire-Cat [ 16006 ]
          tony.hillman Tony Hillman made changes -
          Fix Version/s CheshireCat.Next [ 17125 ]
          Fix Version/s Morpheus [ 18254 ]

          People

            tony.hillman Tony Hillman
            owend Daniel Owen
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty