Skip to content

Commit 0d0b81b

Browse files
Update trafficDistribution API spec docs for GA graduation
1 parent 0f2bde7 commit 0d0b81b

File tree

2 files changed

+22
-27
lines changed

2 files changed

+22
-27
lines changed

pkg/apis/core/types.go

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4550,13 +4550,11 @@ const (
45504550

45514551
// These are valid values for the TrafficDistribution field of a Service.
45524552
const (
4553-
// Indicates a preference for routing traffic to endpoints that are
4554-
// topologically proximate to the client. The interpretation of "topologically
4555-
// proximate" may vary across implementations and could encompass endpoints
4556-
// within the same node, rack, zone, or even region. Setting this value gives
4557-
// implementations permission to make different tradeoffs, e.g. optimizing for
4558-
// proximity rather than equal distribution of load. Users should not set this
4559-
// value if such tradeoffs are not acceptable.
4553+
// Indicates a preference for routing traffic to endpoints that are in the
4554+
// same zone as the client. Setting this value gives implementations
4555+
// permission to make different tradeoffs, e.g. optimizing for proximity
4556+
// rather than equal distribution of load. Users should not set this value
4557+
// if such tradeoffs are not acceptable.
45604558
ServiceTrafficDistributionPreferClose = "PreferClose"
45614559
)
45624560

@@ -4824,12 +4822,12 @@ type ServiceSpec struct {
48244822
// +optional
48254823
InternalTrafficPolicy *ServiceInternalTrafficPolicy
48264824

4827-
// TrafficDistribution offers a way to express preferences for how traffic is
4828-
// distributed to Service endpoints. Implementations can use this field as a
4829-
// hint, but are not required to guarantee strict adherence. If the field is
4830-
// not set, the implementation will apply its default routing strategy. If set
4831-
// to "PreferClose", implementations should prioritize endpoints that are
4832-
// topologically close (e.g., same zone).
4825+
// TrafficDistribution offers a way to express preferences for how traffic
4826+
// is distributed to Service endpoints. Implementations can use this field
4827+
// as a hint, but are not required to guarantee strict adherence. If the
4828+
// field is not set, the implementation will apply its default routing
4829+
// strategy. If set to "PreferClose", implementations should prioritize
4830+
// endpoints that are in the same zone.
48334831
// +optional
48344832
TrafficDistribution *string
48354833
}

staging/src/k8s.io/api/core/v1/types.go

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5344,13 +5344,11 @@ const (
53445344

53455345
// These are valid values for the TrafficDistribution field of a Service.
53465346
const (
5347-
// Indicates a preference for routing traffic to endpoints that are
5348-
// topologically proximate to the client. The interpretation of "topologically
5349-
// proximate" may vary across implementations and could encompass endpoints
5350-
// within the same node, rack, zone, or even region. Setting this value gives
5351-
// implementations permission to make different tradeoffs, e.g. optimizing for
5352-
// proximity rather than equal distribution of load. Users should not set this
5353-
// value if such tradeoffs are not acceptable.
5347+
// Indicates a preference for routing traffic to endpoints that are in the
5348+
// same zone as the client. Setting this value gives implementations
5349+
// permission to make different tradeoffs, e.g. optimizing for proximity
5350+
// rather than equal distribution of load. Users should not set this value
5351+
// if such tradeoffs are not acceptable.
53545352
ServiceTrafficDistributionPreferClose = "PreferClose"
53555353
)
53565354

@@ -5699,13 +5697,12 @@ type ServiceSpec struct {
56995697
// +optional
57005698
InternalTrafficPolicy *ServiceInternalTrafficPolicy `json:"internalTrafficPolicy,omitempty" protobuf:"bytes,22,opt,name=internalTrafficPolicy"`
57015699

5702-
// TrafficDistribution offers a way to express preferences for how traffic is
5703-
// distributed to Service endpoints. Implementations can use this field as a
5704-
// hint, but are not required to guarantee strict adherence. If the field is
5705-
// not set, the implementation will apply its default routing strategy. If set
5706-
// to "PreferClose", implementations should prioritize endpoints that are
5707-
// topologically close (e.g., same zone).
5708-
// This is a beta field and requires enabling ServiceTrafficDistribution feature.
5700+
// TrafficDistribution offers a way to express preferences for how traffic
5701+
// is distributed to Service endpoints. Implementations can use this field
5702+
// as a hint, but are not required to guarantee strict adherence. If the
5703+
// field is not set, the implementation will apply its default routing
5704+
// strategy. If set to "PreferClose", implementations should prioritize
5705+
// endpoints that are in the same zone.
57095706
// +featureGate=ServiceTrafficDistribution
57105707
// +optional
57115708
TrafficDistribution *string `json:"trafficDistribution,omitempty" protobuf:"bytes,23,opt,name=trafficDistribution"`

0 commit comments

Comments
 (0)