Skip to content

Commit e1ff5c7

Browse files
authored
Merge pull request #1 from alauda/migrate
chore: migrate from bitbucket to github
2 parents 127ef4b + 890934f commit e1ff5c7

27 files changed

+457
-34
lines changed

LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

Makefile

+3-3
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ test:
3535
build-bin: lint
3636
docker run -e GOOS=linux -e GOCACHE=/tmp \
3737
-u $(shell id -u):$(shell id -g) \
38-
-v $(CURDIR):/go/src/bitbucket.org/mathildetech/kube-ovn:ro \
39-
-v $(CURDIR)/dist:/go/src/bitbucket.org/mathildetech/kube-ovn/dist/ \
38+
-v $(CURDIR):/go/src/github.com/alauda/kube-ovn:ro \
39+
-v $(CURDIR)/dist:/go/src/github.com/alauda/kube-ovn/dist/ \
4040
golang:$(GO_VERSION) /bin/bash -c '\
41-
cd /go/src/bitbucket.org/mathildetech/kube-ovn && \
41+
cd /go/src/github.com/alauda/kube-ovn && \
4242
make test && \
4343
make build-go '

README.md

+36-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,38 @@
1-
Kube-ovn
1+
# Kube-OVN
22

3-
kube-ovn is a Kubernetes network plugin on top of OVN.
3+
Kube-OVN is an advanced Kubernetes network fabric designed for Enterprise container network management.
44

5-
Roadmap: http://confluence.alaudatech.com/pages/viewpage.action?pageId=30868972
6-
Technical Detail: http://confluence.alaudatech.com/pages/viewpage.action?pageId=36871817
5+
## Primary Features
6+
- **Namespaced Subnet Allocation**: Each namespace can has a unique subnet(backend by a vswitch) to allocated pod ip. Multiple namespaces can also share a same subnet.
7+
- **Subnet Isolation**: Control which address can visit a specific subnet.
8+
- **Static IP Address for Workload**: Allocate random or static IP addresses to workloads just as you wish.
9+
- **Dynamic QoS**: Modify pod ingress/egress traffic rate on the fly.
10+
- **Embedded Loadbalancer**: Replace kube-proxy by ovn embedded distributed L2 Loadbalancer.
11+
- **Distributed Gateway**: Every node can act as a gateway to provide external network connectivity.
12+
13+
## Features on The Way
14+
- **Namespaced Gateway**
15+
- **Direct External Connectivity**
16+
- **ACL Based Network Policy**
17+
- **Policy based QoS**
18+
- **More Metrics and Traffic Graph**
19+
- **More Diagnose and Tracing Tools**
20+
21+
## Quick Start
22+
Kube-OVN is easy to use and has a quick out of box installation. Please refer to [Installation](docs/install.md).
23+
24+
## Documents
25+
- [Namespaced Subnet](docs/subnet.md)
26+
- [Subnet Isolation](docs/isolation.md)
27+
- [Static IP](docs/static-ip.md)
28+
- [Dynamic QoS](docs/qos.md)
29+
- [Policy Routing Gateway](docs/policy-gateway.md)
30+
- [Direct External Connectivity](docs/direct-connect.md)
31+
32+
## !!Cautions!!
33+
Kube-OVN is still in early stage and heavy development. Please *DO NOT* use it in production!!
34+
35+
## Contact
36+
Mail: mengxin#alauda.io
37+
38+
WeChat: liumengxinfly

cmd/cni/cni.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
package main
22

33
import (
4-
"bitbucket.org/mathildetech/kube-ovn/pkg/request"
54
"encoding/json"
65
"errors"
76
"fmt"
7+
"github.com/alauda/kube-ovn/pkg/request"
88
"github.com/containernetworking/cni/pkg/skel"
99
"github.com/containernetworking/cni/pkg/types"
1010
"github.com/containernetworking/cni/pkg/types/current"

cmd/controller/controller.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"os"
55
"time"
66

7-
"bitbucket.org/mathildetech/kube-ovn/pkg/controller"
7+
"github.com/alauda/kube-ovn/pkg/controller"
88
kubeinformers "k8s.io/client-go/informers"
99
"k8s.io/klog"
1010
"k8s.io/sample-controller/pkg/signals"

cmd/daemon/cniserver.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import (
44
"os"
55
"time"
66

7-
"bitbucket.org/mathildetech/kube-ovn/pkg/daemon"
8-
"bitbucket.org/mathildetech/kube-ovn/pkg/ovs"
7+
"github.com/alauda/kube-ovn/pkg/daemon"
8+
"github.com/alauda/kube-ovn/pkg/ovs"
99
kubeinformers "k8s.io/client-go/informers"
1010
"k8s.io/klog"
1111
"k8s.io/sample-controller/pkg/signals"

docs/install.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Installation
2+
3+
4+
Kube-OVN includes two parts:
5+
- Native OVS and OVN
6+
- Controller and CNI plugins that combine OVN and Kubernetes
7+
8+
## Steps
9+
10+
1. Add label to node which will deploy the ovn db and ovn central control plan
11+
12+
`kubectl label node <node to deploy ovn db> kube-ovn/role=master`
13+
2. Install native OVS and OVN
14+
15+
`kubectl apply -f https://raw.githubusercontent.com/alauda/kube-ovn/master/yamls/ovn.yaml`
16+
3. Install Controller and CNI plugins
17+
18+
`kubectl apply -f https://raw.githubusercontent.com/alauda/kube-ovn/master/yamls/kube-ovn.yaml`
19+
20+
That's all! You can try to create pod and test connectivity.
21+
22+
## More Configuration
23+
24+
### Controller Configuration
25+
26+
```bash
27+
--default-cidr: Default cidr for namespace with no logical switch annotation, default: 10.16.0.0/16
28+
--node-switch-cidr: The cidr for node switch. Default: 100.64.0.0/16
29+
```

docs/isolation.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Subnet Isolation
2+
3+
Kube-OVN supports subnet isolation and access control by modifying annotation of namespace.
4+
5+
Use following keys to modify isolation policy:
6+
- `ovn.kubernetes.io/private`: boolean, control whether ip outside this subnet can access this subnet. Default: false.
7+
- `ovn.kubernetes.io/allow`: strings of cidr separated by comma, control which address can visit this subnet, if private=true.
8+
9+
Example:
10+
11+
```bash
12+
apiVersion: v1
13+
kind: Namespace
14+
metadata:
15+
annotations:
16+
ovn.kubernetes.io/cidr: 10.17.0.0/16
17+
ovn.kubernetes.io/gateway: 10.17.0.1
18+
ovn.kubernetes.io/logical_switch: ovn-subnet
19+
ovn.kubernetes.io/exclude_ips: 10.17.0.0..10.17.0.10
20+
ovn.kubernetes.io/private: "true"
21+
ovn.kubernetes.io/allow: 10.17.0.0/16,10.18.0.0/16
22+
name: ovn-subnet
23+
```

docs/qos.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# QoS
2+
3+
Kube-OVN supports dynamically change ingress and egress traffic rate control by modifying annotation to pod spec.
4+
5+
Use following keys to define qos:
6+
- `ovn.kubernetes.io/ingress_rate`: traffic rate that inbound pod, unit Mbit/s
7+
- `ovn.kubernetes.io/egress_rate`: traffic rate that outbound pod, unit Mbit/s
8+
9+
Example:
10+
11+
```bash
12+
apiVersion: v1
13+
kind: Pod
14+
metadata:
15+
name: qos
16+
namespace: ls1
17+
annotations:
18+
ovn.kubernetes.io/ingress_rate: "3"
19+
ovn.kubernetes.io/egress_rate: "1"
20+
spec:
21+
containers:
22+
- name: qos
23+
image: nginx:alpine
24+
```

0 commit comments

Comments
 (0)