Merge pull request #723 from planetscale/florent-hex-width-shard-range

allow specifying the hex width to use when generating shard ranges

Author: frouioui

deploy/crds/planetscale.com_vitessclusters.yaml

@@ -2140,6 +2140,12 @@ spec:
                             type: object
                           equal:
                             properties:
+                              hexWidth:
+                                default: 0
+                                format: int32
+                                maximum: 65536
+                                minimum: 0
+                                type: integer
                               parts:
                                 format: int32
                                 maximum: 65536

deploy/crds/planetscale.com_vitesskeyspaces.yaml

@@ -681,6 +681,12 @@ spec:
                       type: object
                     equal:
                       properties:
+                        hexWidth:
+                          default: 0
+                          format: int32
+                          maximum: 65536
+                          minimum: 0
+                          type: integer
                         parts:
                           format: int32
                           maximum: 65536

docs/api.md

@@ -5806,6 +5806,18 @@ migration, and then remove the old partitioning.</p>
 </tr>
 <tr>
 <td>
+<code>hexWidth</code><br>
+<em>
+int32
+</em>
+</td>
+<td>
+<p>HexWidth is the number of hex characters to use for the shard range start and end.
+If not set or set to 0, it will be automatically computed based on the number of requested shards.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>shardTemplate</code><br>
 <em>
 <a href="#planetscale.com/v2.VitessShardTemplate">

docs/api/index.html

@@ -5808,6 +5808,18 @@ <h3 id="planetscale.com/v2.VitessKeyspaceEqualPartitioning">VitessKeyspaceEqualP
 </tr>
 <tr>
 <td>
+<code>hexWidth</code><br>
+<em>
+int32
+</em>
+</td>
+<td>
+<p>HexWidth is the number of hex characters to use for the shard range start and end.
+If not set or set to 0, it will be automatically computed based on the number of requested shards.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>shardTemplate</code><br>
 <em>
 <a href="#planetscale.com/v2.VitessShardTemplate">

pkg/apis/planetscale/v2/vitesskeyspace_methods.go

@@ -34,7 +34,7 @@ import (
 func (p *VitessKeyspaceEqualPartitioning) KeyRanges() []VitessKeyRange {
 	// Invariant: number of parts must be between 1-65536. This is enforced via
 	// the CRD.
-	ranges, err := key.GenerateShardRanges(int(p.Parts), 0)
+	ranges, err := key.GenerateShardRanges(int(p.Parts), int(p.HexWidth))
 	if err != nil {
 		panic(fmt.Sprintf("could not generate shard range with %d parts: %v", p.Parts, err))
 	}

pkg/apis/planetscale/v2/vitesskeyspace_methods_test.go

@@ -23,8 +23,9 @@ import (
 
 func TestTranslationToVitessKeyRange(t *testing.T) {
 	table := []struct {
-		parts int32
-		want  []VitessKeyRange
+		hexWidth int32
+		parts    int32
+		want     []VitessKeyRange
 	}{
 		{
 			parts: 1,
@@ -62,10 +63,40 @@ func TestTranslationToVitessKeyRange(t *testing.T) {
 				{"e0", ""},
 			},
 		},
+		{
+			hexWidth: 4,
+			parts:    7,
+			want: []VitessKeyRange{
+				{"", "2492"},
+				{"2492", "4924"},
+				{"4924", "6db6"},
+				{"6db6", "9249"},
+				{"9249", "b6db"},
+				{"b6db", "db6d"},
+				{"db6d", ""},
+			},
+		},
+		{
+			hexWidth: 4,
+			parts:    8,
+			want: []VitessKeyRange{
+				{"", "2000"},
+				{"2000", "4000"},
+				{"4000", "6000"},
+				{"6000", "8000"},
+				{"8000", "a000"},
+				{"a000", "c000"},
+				{"c000", "e000"},
+				{"e000", ""},
+			},
+		},
 	}
 
 	for _, test := range table {
-		p := VitessKeyspaceEqualPartitioning{Parts: test.parts}
+		p := VitessKeyspaceEqualPartitioning{
+			HexWidth: test.hexWidth,
+			Parts:    test.parts,
+		}
 		if got, want := p.KeyRanges(), test.want; !reflect.DeepEqual(got, want) {
 			t.Errorf("KeyRanges(%v) = %#v; want %#v", test.parts, got, want)
 		}

pkg/apis/planetscale/v2/vitesskeyspace_types.go

@@ -357,6 +357,13 @@ type VitessKeyspaceEqualPartitioning struct {
 	// +kubebuilder:validation:Maximum=65536
 	Parts int32 `json:"parts"`
 
+	// HexWidth is the number of hex characters to use for the shard range start and end.
+	// If not set or set to 0, it will be automatically computed based on the number of requested shards.
+	// +kubebuilder:default=0
+	// +kubebuilder:validation:Minimum=0
+	// +kubebuilder:validation:Maximum=65536
+	HexWidth int32 `json:"hexWidth,omitempty"`
+
 	// ShardTemplate is the configuration used for each equal-sized shard.
 	// If you need shards that don't all share the same configuration,
 	// use custom partitioning instead.

test/endtoend/operator/302_new_shards.yaml

@@ -140,6 +140,7 @@ spec:
                   storage: 10Gi
     - equal:
         parts: 2
+        hexWidth: 4
         shardTemplate:
           databaseInitScriptSecret:
             name: example-cluster-config

test/endtoend/operator/306_down_shard_0.yaml

@@ -105,6 +105,7 @@ spec:
     partitionings:
     - equal:
         parts: 2
+        hexWidth: 4
         shardTemplate:
           databaseInitScriptSecret:
             name: example-cluster-config

test/endtoend/operator/401_scheduled_backups.yaml

@@ -40,10 +40,10 @@ spec:
         strategies:
           - name: customer_80-x
             keyspace: "customer"
-            shard: "80-"
+            shard: "8000-"
           - name: customer_x-80
             keyspace: "customer"
-            shard: "-80"
+            shard: "-8000"
   images:
     vtctld: vitess/lite:mysql80
     vtgate: vitess/lite:mysql80
@@ -139,6 +139,7 @@ spec:
     partitionings:
     - equal:
         parts: 2
+        hexWidth: 4
         shardTemplate:
           databaseInitScriptSecret:
             name: example-cluster-config