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

Provide documentation for rebalance failure reason(s)

    XMLWordPrintable

Details

    • Bug
    • Resolution: Resolved
    • Major
    • Trinity
    • Trinity
    • documentation
    • None
    • 0

    Description

      We have introduced some new data to the pools/default endpoint regarding rebalance failure reasons and generally also include a short string as a description. Specifically we introduced:

      to_human_readable_reason(service_not_balanced) ->
          <<"Service needs rebalance.">>;
      to_human_readable_reason(num_replicas_changed) ->
          <<"Number of replicas for bucket has changed.">>;
      to_human_readable_reason(servers_not_balanced) ->
          <<"Servers of bucket are not balanced.">>;
      to_human_readable_reason(map_needs_rebalance) ->
          <<"Bucket map needs rebalance.">>;
      to_human_readable_reason(servers_changed) ->
          <<"Servers of bucket have changed.">>.
      

      which will look like this in the JSON:

      "servicesNeedRebalance": [
          {
            "code": "service_not_balanced",
            "description": "Service needs rebalance.",
            "services": ["kv", "n1ql"],
          }
      ],
      "bucketsNeedRebalance": [
          {
            "code": "num_replicas_changed",
            "description": "Number of replicas for bucket has changed.",
            "buckets": ["default", "another"]
          },
          {
            "code": "servers_not_balanced",
            "description": "Bucket map needs rebalance.",
            "buckets": ["another"]
          }
      ],
      

      So we are hoping to document the keys "service_not_balanced", "num_replicas_changed", "servers_not_balanced", "map_needs_rebalance", and "servers_changed". You can get a basic idea of their meaning from the longer string explanation but we can also give further detail, if the docs team needs more information. Here is some tips from Abhijeeth Nuthan:

      IMO the reason for needing rebalance should be captured in https://docs.couchbase.com/server/current/learn/clusters-and-availability/rebalance.html or https://docs.couchbase.com/server/current/rest-api/rest-rebalance-overview.html, probably Tony Hillman is a better judge on where this information for the reasons requiring rebalance and how to retrieve it should go.

      Ping Bryan McCoid for any additional help regarding this (if needed). 

      Attachments

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

        Activity

          People

            ray.offiah Ray Offiah
            bryan.mccoid Bryan McCoid
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty