Skip to content

Commit a5a446a

Browse files
committed
Use forward domain notation for annotations
"kube-router.io/..." This is in line with convention set by k8s upstream.
1 parent c714a80 commit a5a446a

File tree

5 files changed

+24
-24
lines changed

5 files changed

+24
-24
lines changed

Documentation/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ and run kube-proxy with the configuration you have.
180180

181181
Communication from a Pod that is behind a Service to its own ClusterIP:Port is
182182
not supported by default. However, It can be enabled per-service by adding the
183-
`io.kube-router.net.service.hairpin=` annotation, or for all Services in a cluster by
183+
`kube-router.io/service.hairpin=` annotation, or for all Services in a cluster by
184184
passing the flag `--hairpin-mode=true` to kube-router.
185185

186186
Additionally, the `hairpin_mode` sysctl option must be set to `1` for all veth
@@ -209,7 +209,7 @@ Service ClusterIP if it is logging the source IP.
209209

210210
To enable hairpin traffic for Service `my-service`:
211211
```
212-
kubectl annotate service my-service "io.kube-router.net.service.hairpin="
212+
kubectl annotate service my-service "kube-router.io/service.hairpin="
213213
```
214214

215215

Documentation/bgp.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ per node models. Nodes in the cluster does not form full node-to-node mesh.
2323
Users has to explicitly select this mode by specifying `--nodes-full-mesh=false`
2424
when launching kube-router. In this mode kube-router expects each node is
2525
configured with an ASN number from the node's API object annoations. Kube-router
26-
will use the node's `io.kube-router.net.node.asn` annotation value as the ASN
26+
will use the node's `kube-router.io/node.asn` annotation value as the ASN
2727
number for the node.
2828

2929
Users can annotate node objects with the following command:
3030

3131
```
32-
kubectl annotate node <kube-node> "io.kube-router.net.node.asn=64512"
32+
kubectl annotate node <kube-node> "kube-router.io/node.asn=64512"
3333
```
3434

3535
Only nodes with in same ASN form full mesh. Two nodes with different ASNs never
@@ -55,21 +55,21 @@ For example:
5555
Alternativley, each node can be configured with one or more node specific BGP
5656
peers. Information regarding node specific BGP peer is read from node API object
5757
annotations:
58-
- `io.kube-router.net.peer.ips`
59-
- `io.kube-router.net.peer.asns`
58+
- `kube-router.io/peer.ips`
59+
- `kube-router.io/peer.asns`
6060

6161

6262
For e.g users can annotate node object with below commands
6363
```
64-
kubectl annotate node <kube-node> "io.kube-router.net.peer.ips=192.168.1.99,192.168.1.100"
65-
kubectl annotate node <kube-node> "io.kube-router.net.peer.asns=65000,65000"
64+
kubectl annotate node <kube-node> "kube-router.io/peer.ips=192.168.1.99,192.168.1.100"
65+
kubectl annotate node <kube-node> "kube-router.io/peer.asns=65000,65000"
6666
```
6767

6868
### BGP Peer Password Authentication
6969

7070
The examples above have assumed there is no password authentication with BGP
7171
peer routers. If you need to use a password for peering, you can use the
72-
`--peer-router-passwords` CLI flag or the `io.kube-router.net.peer.passwords` node
72+
`--peer-router-passwords` CLI flag or the `kube-router.io/peer.passwords` node
7373
annotation.
7474

7575
#### Base64 Encoding Passwords
@@ -97,7 +97,7 @@ Note the comma indicating the end of the first password.
9797

9898
Now here's the same example but configured as node annotations:
9999
```
100-
kubectl annotate node <kube-node> "io.kube-router.net.peer.ips=192.168.1.99,192.168.1.100"
101-
kubectl annotate node <kube-node> "io.kube-router.net.peer.asns=65000,65000"
102-
kubectl annotate node <kube-node> "io.kube-router.net.peer.passwords=U2VjdXJlUGFzc3dvcmQK,"
100+
kubectl annotate node <kube-node> "kube-router.io/peer.ips=192.168.1.99,192.168.1.100"
101+
kubectl annotate node <kube-node> "kube-router.io/peer.asns=65000,65000"
102+
kubectl annotate node <kube-node> "kube-router.io/peer.passwords=U2VjdXJlUGFzc3dvcmQK,"
103103
```

Documentation/upgrading.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,13 @@ CLI flag additions:
9595

9696
Annotation key changes:
9797
- OLD: `kube-router.io/hairpin-mode=` -> NEW:
98-
`io.kube-router.net.service.hairpin=`
99-
- OLD: `net.kuberouter.nodeasn=` -> NEW: `io.kube-router.net.node.asn=`
100-
- OLD: `net.kuberouter.node.bgppeer.address=` -> NEW: `io.kube-router.net.peer.ips`
101-
- OLD: `net.kuberouter.node.bgppeer.asn` -> NEW: `io.kube-router.net.peer.asns`
98+
`kube-router.io/service.hairpin=`
99+
- OLD: `net.kuberouter.nodeasn=` -> NEW: `kube-router.io/node.asn=`
100+
- OLD: `net.kuberouter.node.bgppeer.address=` -> NEW: `kube-router.io/peer.ips`
101+
- OLD: `net.kuberouter.node.bgppeer.asn` -> NEW: `kube-router.io/peer.asns`
102102

103103
Annotation key additions:
104-
- NEW: `io.kube-router.net.peer.passwords`
104+
- NEW: `kube-router.io/peer.passwords`
105105

106106
#### v0.0.17 Upgrade Procedure
107107

@@ -129,7 +129,7 @@ Annotations: kube-router.io/hairpin-mode=
129129

130130
You will then want to make a new annotation with the new key:
131131
```sh
132-
kubectl annotate service hairpin-service "io.kube-router.net.service.hairpin="
132+
kubectl annotate service hairpin-service "kube-router.io/service.hairpin="
133133
```
134134

135135
Once all new annotations are created, proceed with the

app/controllers/network_routes_controller.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -779,7 +779,7 @@ func (nrc *NetworkRoutingController) syncPeers() {
779779
// if node full mesh is not requested then just peer with nodes with same ASN
780780
// (run iBGP among same ASN peers)
781781
if !nrc.bgpFullMeshMode {
782-
nodeasn, ok := node.ObjectMeta.Annotations["io.kube-router.net.node.asn"]
782+
nodeasn, ok := node.ObjectMeta.Annotations["kube-router.io/node.asn"]
783783
if !ok {
784784
glog.Infof("Not peering with the Node %s as ASN number of the node is unknown.",
785785
nodeIP.String())
@@ -982,7 +982,7 @@ func (nrc *NetworkRoutingController) startBgpServer() error {
982982
if nrc.bgpFullMeshMode {
983983
nodeAsnNumber = nrc.defaultNodeAsnNumber
984984
} else {
985-
nodeasn, ok := node.ObjectMeta.Annotations["io.kube-router.net.node.asn"]
985+
nodeasn, ok := node.ObjectMeta.Annotations["kube-router.io/node.asn"]
986986
if !ok {
987987
return errors.New("Could not find ASN number for the node. " +
988988
"Node needs to be annotated with ASN number details to start BGP server.")
@@ -1030,7 +1030,7 @@ func (nrc *NetworkRoutingController) startBgpServer() error {
10301030
// else attempt to get peers from node specific BGP annotations.
10311031
if len(nrc.globalPeerRouters) == 0 {
10321032
// Get Global Peer Router ASN configs
1033-
nodeBgpPeerAsnsAnnotation, ok := node.ObjectMeta.Annotations["io.kube-router.net.peer.asns"]
1033+
nodeBgpPeerAsnsAnnotation, ok := node.ObjectMeta.Annotations["kube-router.io/peer.asns"]
10341034
if !ok {
10351035
glog.Infof("Could not find BGP peer info for the node in the node annotations so skipping configuring peer.")
10361036
return nil
@@ -1044,7 +1044,7 @@ func (nrc *NetworkRoutingController) startBgpServer() error {
10441044
}
10451045

10461046
// Get Global Peer Router IP Address configs
1047-
nodeBgpPeersAnnotation, ok := node.ObjectMeta.Annotations["io.kube-router.net.peer.ips"]
1047+
nodeBgpPeersAnnotation, ok := node.ObjectMeta.Annotations["kube-router.io/peer.ips"]
10481048
if !ok {
10491049
glog.Infof("Could not find BGP peer info for the node in the node annotations so skipping configuring peer.")
10501050
return nil
@@ -1058,7 +1058,7 @@ func (nrc *NetworkRoutingController) startBgpServer() error {
10581058

10591059
// Get Global Peer Router Password configs
10601060
peerPasswords := []string{}
1061-
nodeBGPPasswordsAnnotation, ok := node.ObjectMeta.Annotations["io.kube-router.net.peer.passwords"]
1061+
nodeBGPPasswordsAnnotation, ok := node.ObjectMeta.Annotations["kube-router.io/peer.passwords"]
10621062
if !ok {
10631063
glog.Infof("Could not find BGP peer password info in the node's annotations. Assuming no passwords.")
10641064
} else {

app/controllers/network_services_controller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ func buildServicesInfo() serviceInfoMap {
426426
}
427427

428428
svcInfo.sessionAffinity = (svc.Spec.SessionAffinity == "ClientIP")
429-
_, svcInfo.hairpin = svc.ObjectMeta.Annotations["io.kube-router.net.service.hairpin"]
429+
_, svcInfo.hairpin = svc.ObjectMeta.Annotations["kube-router.io/service.hairpin"]
430430

431431
svcId := generateServiceId(svc.Namespace, svc.Name, port.Name)
432432
serviceMap[svcId] = &svcInfo

0 commit comments

Comments
 (0)