Skip to content

add a warning in the CRD about hex width #724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 16, 2025
Merged

add a warning in the CRD about hex width #724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92d38e5
add comment in crd about hex width
frouioui Sep 25, 2025
7fc3591
revert unwanted change
frouioui Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5814,6 +5814,11 @@ int32
<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>
<p>WARNING: DO NOT change the hex width in a partitioning after deploying.
That&rsquo;s effectively deleting the old partitioning and adding a new one,
which can lead to downtime or data loss. Instead, add an additional
partitioning with the desired hex width, perform a resharding
migration, and then remove the old partitioning.</p>
</td>
</tr>
<tr>
Expand Down
5 changes: 5 additions & 0 deletions docs/api/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5816,6 +5816,11 @@ <h3 id="planetscale.com/v2.VitessKeyspaceEqualPartitioning">VitessKeyspaceEqualP
<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>
<p>WARNING: DO NOT change the hex width in a partitioning after deploying.
That&rsquo;s effectively deleting the old partitioning and adding a new one,
which can lead to downtime or data loss. Instead, add an additional
partitioning with the desired hex width, perform a resharding
migration, and then remove the old partitioning.</p>
</td>
</tr>
<tr>
Expand Down
7 changes: 7 additions & 0 deletions pkg/apis/planetscale/v2/vitesskeyspace_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,13 @@ type VitessKeyspaceEqualPartitioning struct {

// 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.
//
// WARNING: DO NOT change the hex width in a partitioning after deploying.
// That's effectively deleting the old partitioning and adding a new one,
// which can lead to downtime or data loss. Instead, add an additional
// partitioning with the desired hex width, perform a resharding
// migration, and then remove the old partitioning.
//
// +kubebuilder:default=0
// +kubebuilder:validation:Minimum=0
// +kubebuilder:validation:Maximum=65536
Expand Down