Skip to content
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

feat(api): add consistent hash table size api #3348

Merged
merged 6 commits into from
May 14, 2024
Merged

feat(api): add consistent hash table size api #3348

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7a37883
Add consistent hash table size api
aoledk May 8, 2024
78f31d0
Set consistent hash table size's minimum as the smallest prime number: 2
aoledk May 8, 2024
621e1c4
Merge branch 'main' into consistent-hash-table-size-api
aoledk May 9, 2024
4202e18
Comment tableSize api as notImplementedHide
aoledk May 14, 2024
6002bd6
Merge branch 'main' into consistent-hash-table-size-api
aoledk May 14, 2024
6e3d50c
Merge branch 'main' into consistent-hash-table-size-api
aoledk May 14, 2024
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
8 changes: 8 additions & 0 deletions api/v1alpha1/loadbalancer_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ const (
// load balancer policy
type ConsistentHash struct {
Type ConsistentHashType `json:"type"`

// The table size for consistent hashing, must be prime number limited to 5000011.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add CEL to validate it must be prime number?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like CEL in Kubernetes 1 doesn't support complex validation logic like IsPrime function. But we can validate whether table size is prime number when translating ClientTrafficPolicy to IR.

func IsPrime(n int) bool {
    if n <= 1 {
        return false
    }
    for i := 2; i*i <= n; i++ {
        if n%i == 0 {
            return false
        }
    }
    return true
}

Footnotes

  1. https://kubernetes.io/docs/reference/using-api/cel/#cel-options-language-features-and-libraries ↩

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM

//
// +kubebuilder:validation:Minimum=1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we make it 2? because 1 is actually not a prime number.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, make the minimum to the smallest prime number 2 now.

// +kubebuilder:validation:Maximum=5000011
// +kubebuilder:default=65537
// +optional
TableSize *uint64 `json:"tableSize,omitempty"`
aoledk marked this conversation as resolved.
Show resolved Hide resolved
}

// ConsistentHashType defines the type of input to hash on.
Expand Down
7 changes: 6 additions & 1 deletion api/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions charts/gateway-helm/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,14 @@ spec:
ConsistentHash defines the configuration when the load balancer type is
set to ConsistentHash
properties:
tableSize:
default: 65537
description: The table size for consistent hashing, must be
prime number limited to 5000011.
format: int64
maximum: 5000011
minimum: 1
type: integer
type:
description: ConsistentHashType defines the type of input
to hash on.
Expand Down
1 change: 1 addition & 0 deletions site/content/en/latest/api/extension_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,7 @@ _Appears in:_
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | _[ConsistentHashType](#consistenthashtype)_ | true | |
| `tableSize` | _integer_ | false | The table size for consistent hashing, must be prime number limited to 5000011. |


#### ConsistentHashType
Expand Down
Loading