Skip to content

Commit

Permalink
Merge pull request kubernetes#15414 from thockin/exp-beta-annotations
Browse files Browse the repository at this point in the history
Auto commit by PR queue bot
  • Loading branch information
k8s-merge-robot committed Oct 21, 2015
2 parents 674878f + 2f4c303 commit 6dc3dcf
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 14 deletions.
11 changes: 9 additions & 2 deletions cmd/kube-proxy/app/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ const (
proxyModeUserspace = "userspace"
proxyModeIptables = "iptables"
experimentalProxyModeAnnotation = "net.experimental.kubernetes.io/proxy-mode"
betaProxyModeAnnotation = "net.beta.kubernetes.io/proxy-mode"
)

func checkKnownProxyMode(proxyMode string) bool {
Expand Down Expand Up @@ -330,9 +331,15 @@ func mayTryIptablesProxy(proxyMode string, client nodeGetter, hostname string) b
glog.Errorf("Not trying iptables proxy: got nil Node %q", hostname)
return false
}
proxyMode, found := node.Annotations[experimentalProxyModeAnnotation]
proxyMode, found := node.Annotations[betaProxyModeAnnotation]
if found {
glog.V(1).Infof("Found experimental annotation %q = %q", experimentalProxyModeAnnotation, proxyMode)
glog.V(1).Infof("Found beta annotation %q = %q", betaProxyModeAnnotation, proxyMode)
} else {
// We already published some information about this annotation with the "experimental" name, so we will respect it.
proxyMode, found = node.Annotations[experimentalProxyModeAnnotation]
if found {
glog.V(1).Infof("Found experimental annotation %q = %q", experimentalProxyModeAnnotation, proxyMode)
}
}
if proxyMode == proxyModeIptables {
glog.V(1).Infof("Annotation allows iptables proxy")
Expand Down
8 changes: 8 additions & 0 deletions cmd/kube-proxy/app/server_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,19 @@ func Test_mayTryIptablesProxy(t *testing.T) {
{"", "net.experimental.kubernetes.io/proxy-mode", "iptables", true},
{"", "net.experimental.kubernetes.io/proxy-mode", "other", false},
{"", "net.experimental.kubernetes.io/proxy-mode", "", false},
{"", "net.beta.kubernetes.io/proxy-mode", "userspace", false},
{"", "net.beta.kubernetes.io/proxy-mode", "iptables", true},
{"", "net.beta.kubernetes.io/proxy-mode", "other", false},
{"", "net.beta.kubernetes.io/proxy-mode", "", false},
{"", "proxy-mode", "iptables", false},
{"userspace", "net.experimental.kubernetes.io/proxy-mode", "userspace", false},
{"userspace", "net.experimental.kubernetes.io/proxy-mode", "iptables", false},
{"iptables", "net.experimental.kubernetes.io/proxy-mode", "userspace", true},
{"iptables", "net.experimental.kubernetes.io/proxy-mode", "iptables", true},
{"userspace", "net.beta.kubernetes.io/proxy-mode", "userspace", false},
{"userspace", "net.beta.kubernetes.io/proxy-mode", "iptables", false},
{"iptables", "net.beta.kubernetes.io/proxy-mode", "userspace", true},
{"iptables", "net.beta.kubernetes.io/proxy-mode", "iptables", true},
}
for i, c := range cases {
getter := &fakeNodeInterface{}
Expand Down
2 changes: 1 addition & 1 deletion docs/devel/api-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,7 @@ Therefore, resources supporting auto-generation of unique labels should have a `

Annotations have very different intended usage from labels. We expect them to be primarily generated and consumed by tooling and system extensions. I'm inclined to generalize annotations to permit them to directly store arbitrary json. Rigid names and name prefixes make sense, since they are analogous to API fields.

In fact, experimental API fields, including those used to represent fields of newer alpha/beta API versions in the older stable storage version, may be represented as annotations with the form `something.experimental.kubernetes.io/name`. For example `net.experimental.kubernetes.io/policy` might represent an experimental network policy field.
In fact, in-development API fields, including those used to represent fields of newer alpha/beta API versions in the older stable storage version, may be represented as annotations with the form `something.alpha.kubernetes.io/name` or `something.beta.kubernetes.io/name` (depending on our confidence in it). For example `net.alpha.kubernetes.io/policy` might represent an experimental network policy field.

Other advice regarding use of labels, annotations, and other generic map keys by Kubernetes components and tools:
- Key names should be all lowercase, with words separated by dashes, such as `desired-replicas`
Expand Down
4 changes: 2 additions & 2 deletions pkg/kubelet/kubelet.go
Original file line number Diff line number Diff line change
Expand Up @@ -2858,7 +2858,7 @@ func validateBandwidthIsReasonable(rsrc *resource.Quantity) error {
}

func extractBandwidthResources(pod *api.Pod) (ingress, egress *resource.Quantity, err error) {
str, found := pod.Annotations["kubernetes.io/ingress-bandwidth"]
str, found := pod.Annotations["net.alpha.kubernetes.io/ingress-bandwidth"]
if found {
if ingress, err = resource.ParseQuantity(str); err != nil {
return nil, nil, err
Expand All @@ -2867,7 +2867,7 @@ func extractBandwidthResources(pod *api.Pod) (ingress, egress *resource.Quantity
return nil, nil, err
}
}
str, found = pod.Annotations["kubernetes.io/egress-bandwidth"]
str, found = pod.Annotations["net.alpha.kubernetes.io/egress-bandwidth"]
if found {
if egress, err = resource.ParseQuantity(str); err != nil {
return nil, nil, err
Expand Down
18 changes: 9 additions & 9 deletions pkg/kubelet/kubelet_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3529,7 +3529,7 @@ func TestCleanupBandwidthLimits(t *testing.T) {
ObjectMeta: api.ObjectMeta{
Name: "foo",
Annotations: map[string]string{
"kubernetes.io/ingress-bandwidth": "10M",
"net.alpha.kubernetes.io/ingress-bandwidth": "10M",
},
},
},
Expand All @@ -3554,7 +3554,7 @@ func TestCleanupBandwidthLimits(t *testing.T) {
ObjectMeta: api.ObjectMeta{
Name: "foo",
Annotations: map[string]string{
"kubernetes.io/ingress-bandwidth": "10M",
"net.alpha.kubernetes.io/ingress-bandwidth": "10M",
},
},
},
Expand All @@ -3580,7 +3580,7 @@ func TestCleanupBandwidthLimits(t *testing.T) {
ObjectMeta: api.ObjectMeta{
Name: "foo",
Annotations: map[string]string{
"kubernetes.io/ingress-bandwidth": "10M",
"net.alpha.kubernetes.io/ingress-bandwidth": "10M",
},
},
},
Expand All @@ -3605,7 +3605,7 @@ func TestCleanupBandwidthLimits(t *testing.T) {
ObjectMeta: api.ObjectMeta{
Name: "foo",
Annotations: map[string]string{
"kubernetes.io/ingress-bandwidth": "10M",
"net.alpha.kubernetes.io/ingress-bandwidth": "10M",
},
},
},
Expand Down Expand Up @@ -3693,7 +3693,7 @@ func TestExtractBandwidthResources(t *testing.T) {
pod: &api.Pod{
ObjectMeta: api.ObjectMeta{
Annotations: map[string]string{
"kubernetes.io/ingress-bandwidth": "10M",
"net.alpha.kubernetes.io/ingress-bandwidth": "10M",
},
},
},
Expand All @@ -3703,7 +3703,7 @@ func TestExtractBandwidthResources(t *testing.T) {
pod: &api.Pod{
ObjectMeta: api.ObjectMeta{
Annotations: map[string]string{
"kubernetes.io/egress-bandwidth": "10M",
"net.alpha.kubernetes.io/egress-bandwidth": "10M",
},
},
},
Expand All @@ -3713,8 +3713,8 @@ func TestExtractBandwidthResources(t *testing.T) {
pod: &api.Pod{
ObjectMeta: api.ObjectMeta{
Annotations: map[string]string{
"kubernetes.io/ingress-bandwidth": "4M",
"kubernetes.io/egress-bandwidth": "20M",
"net.alpha.kubernetes.io/ingress-bandwidth": "4M",
"net.alpha.kubernetes.io/egress-bandwidth": "20M",
},
},
},
Expand All @@ -3725,7 +3725,7 @@ func TestExtractBandwidthResources(t *testing.T) {
pod: &api.Pod{
ObjectMeta: api.ObjectMeta{
Annotations: map[string]string{
"kubernetes.io/ingress-bandwidth": "foo",
"net.alpha.kubernetes.io/ingress-bandwidth": "foo",
},
},
},
Expand Down

0 comments on commit 6dc3dcf

Please sign in to comment.