/
consistent_hashing.proto
38 lines (31 loc) · 1.97 KB
/
consistent_hashing.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
syntax = "proto3";
package envoy.extensions.matching.input_matchers.consistent_hashing.v3;
import "udpa/annotations/status.proto";
import "validate/validate.proto";
option java_package = "io.envoyproxy.envoy.extensions.matching.input_matchers.consistent_hashing.v3";
option java_outer_classname = "ConsistentHashingProto";
option java_multiple_files = true;
option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/matching/input_matchers/consistent_hashing/v3;consistent_hashingv3";
option (udpa.annotations.file_status).package_version_status = ACTIVE;
// [#protodoc-title: Consistent Hashing Matcher]
// [#extension: envoy.matching.input_matchers.consistent_hashing]
// The consistent hashing matchers computes a consistent hash from the input and matches if the resulting hash
// is within the configured threshold.
// More specifically, this matcher evaluates to true if hash(input, seed) % modulo >= threshold.
// Note that the consistency of the match result relies on the internal hash function (xxhash) remaining
// unchanged. While this is unlikely to happen intentionally, this could cause inconsistent match results
// between deployments.
message ConsistentHashing {
// The threshold the resulting hash must be over in order for this matcher to evaluate to true.
// This value must be below the configured modulo value.
// Setting this to 0 is equivalent to this matcher always matching.
uint32 threshold = 1;
// The value to use for the modulus in the calculation. This effectively bounds the hash output,
// specifying the range of possible values.
// This value must be above the configured threshold.
uint32 modulo = 2 [(validate.rules).uint32 = {gt: 0}];
// Optional seed passed through the hash function. This allows using additional information when computing
// the hash value: by changing the seed value, a different partition of matching and non-matching inputs will
// be created that remains consistent for that seed value.
uint64 seed = 3;
}