doc/development.md


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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

# Developer Information

## How to build the ovn4nfv?

ovn4nfv-k8s-plugin is maintained in opnfv gerrit repositry.[https://gerrit.opnfv.org/gerrit/admin/repos/ovn4nfv-k8s-plugin](
https://gerrit.opnfv.org/gerrit/admin/repos/ovn4nfv-k8s-plugin)

The github page [github.com/opnfv/ovn4nfv-k8s-plugin](https://github.com/opnfv/ovn4nfv-k8s-plugin/)
is github mirror repository for the user.

Contributor login with Linux Foundation ID into [https://gerrit.opnfv.org/gerrit/admin/repos/ovn4nfv-k8s-plugin](https://gerrit.opnfv.org/gerrit/admin/repos/ovn4nfv-k8s-plugin)
and add their ssh key or use the LF username and password

###How to build ovn4nfv entity?

Before packaging the ovn4nfv images, please make sure your feature request or
modification are compliable as follows:

```
git clone https://github.com/opnfv/ovn4nfv-k8s-plugin.git
make all
```

you can use gerrit anonymous http clone or clone with commit-msg hook. Above example show the clone with github

There are 3 components within the ovn4nfv-k8s-plugin - nfn-operator, ovn4nfvk8s-cni & nfn-agent.

All these components can be modified and build separately using the commands -  `make nfn-operator`, `make ovn4nfvk8s-cni` &
`make nfn-agent`

All the components can be cleaned with `make clean`

###How to run the CI tests?

ovn4nfv-k8s-plugin has go unit test for all golang package. For CNI testing is based on ginkgo framework.
The following command run the unit tests and it is intergrated with opnfv gerrit review to give +1

```
make test
```

###How to build docker images?

The ovn4nfv project has 2 major docker images for ovn/ovs operations and network
controller. The ovn4nfv currently support and tested in ubuntu and centos distro.
In this documentation, developer get the information regarding how to build and
package the docker images

- ovn dockerfile is maintained for centos and ubuntu package in the `utilities/docker` folder
- ovn4nfv k8s plugin dockerfile is maintained for centos and ubuntu in the `build` folder

#### ubuntu distro
Build the ovn-images
```
pushd utilities/docker && \
docker build --no-cache --rm -t integratedcloudnative/ovn-images:master . -f debian/Dockerfile && \
popd
```
Build the ovn4nfv-k8s-plugin images
```
docker build --no-cache --rm -t integratedcloudnative/ovn4nfv-k8s-plugin:master . -f build/Dockerfile && \
```

docker images are tagged with intergratedcloudnative dockerhub.
For development purpose use your private dockerhub, if planning to test k8s deployment is more than one node.

#### centos distro
Build the ovn-images
```
pushd utilities/docker && \
docker build --no-cache --rm -t integratedcloudnative/ovn-images:master . -f centos/Dockerfile && \
popd
```
Build the ovn4nfv-k8s-plugin images
```
docker build --no-cache --rm -t integratedcloudnative/ovn4nfv-k8s-plugin:master . -f build/Dockerfile.centos && \
```

###How to deploy the compiled ovn4nfv docker images in k8s cluster?

K8s yaml files in the `deploy` folder use that stable release of the ovn-images and ovn4nfv-k8s-plugin.
Please change the images in the yaml, if you deploying your compiled ovn4nfv images

Please follow the steps - [quickstart-installation-guide](https://github.com/opnfv/ovn4nfv-k8s-plugin#quickstart-installation-guide)

For the kubespray change the ansible variable - `ovn4nfv_ovn_image_version`, `ovn4nfv_k8s_plugin_image_version`,
`ovn4nfv_ovn_image_repo`, `ovn4nfv_k8s_plugin_image_repo` in the kubespray `roles/download/defaults/main.yml`

###How to test the compiled ovn4nfv docker images in k8s cluster?

Please follow the steps -[Todo](Todo)