Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-13169

Move Replica Docs need improvement (V1 and V2 introspect)

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 8.6
    • Component/s: v2 API
    • Labels:
      None

      Description

      At a minimum required parameters should be noted equally in both places. Conversation with Andrzej Bialecki indicates that there are also some discrepancies in what is and is not actually required in docs vs code. ("in MoveReplicaCmd if you specify “replica” then “shard” is completely ignored")

      Also in v2 it seems shard might be inferred from the URL and in that case it's not clear if the URL or the json takes precedence.

      From introspect:

                      "move-replica": {
                          "type": "object",
                          "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#movereplica",
                          "description": "This command moves a replica from one node to a new node. In case of shared filesystems the `dataDir` and `ulogDir` may be reused.",
                          "properties": {
                              "replica": {
                                  "type": "string",
                                  "description": "The name of the replica"
                              },
                              "shard": {
                                  "type": "string",
                                  "description": "The name of the shard"
                              },
                              "sourceNode": {
                                  "type": "string",
                                  "description": "The name of the node that contains the replica."
                              },
                              "targetNode": {
                                  "type": "string",
                                  "description": "The name of the destination node. This parameter is required."
                              },
                              "waitForFinalState": {
                                  "type": "boolean",
                                  "default": "false",
                                  "description": "Wait for the moved replica to become active."
                              },
                              "timeout": {
                                  "type": "integer",
                                  "default": 600,
                                  "description": "Timeout to wait for replica to become active. For very large replicas this may need to be increased."
                              },
                              "inPlaceMove": {
                                  "type": "boolean",
                                  "default": "true",
                                  "description": "For replicas that use shared filesystems allow 'in-place' move that reuses shared data."
                              }
      

      From ref guide for V1:
      MOVEREPLICA Parameters
      collection
      The name of the collection. This parameter is required.
      shard
      The name of the shard that the replica belongs to. This parameter is required.
      replica
      The name of the replica. This parameter is required.
      sourceNode
      The name of the node that contains the replica. This parameter is required.
      targetNode
      The name of the destination node. This parameter is required.
      async
      Request ID to track this action which will be processed asynchronously.

        Attachments

        1. screenshot-1.png
          43 kB
          Gus Heck
        2. SOLR-13169.patch
          7 kB
          Gus Heck
        3. testing.txt
          28 kB
          Gus Heck

          Issue Links

            Activity

              People

              • Assignee:
                gus Gus Heck
                Reporter:
                gus Gus Heck
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

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