diff options
| -rw-r--r-- | doc/development.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/development.md b/doc/development.md index c3b5b3e..d4c818c 100644 --- a/doc/development.md +++ b/doc/development.md @@ -11,35 +11,35 @@ 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? +### How to build ovn4nfv entity? Before packaging the ovn4nfv images, please make sure your feature request or -modification are compliable as follows: +modification are compilable as follows: ``` -git clone https://github.com/opnfv/ovn4nfv-k8s-plugin.git -make all +# 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. +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? +### 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 +# make test ``` -###How to build docker images? +### 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. @@ -76,7 +76,7 @@ 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? +### 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 @@ -86,6 +86,6 @@ Please follow the steps - [quickstart-installation-guide](https://github.com/opn 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? +### How to test the compiled ovn4nfv docker images in k8s cluster? -Please follow the steps -[Todo](Todo) +Please follow the steps -[doc/how-to-use.md#network-testing](https://github.com/opnfv/ovn4nfv-k8s-plugin/blob/master/doc/how-to-use.md#network-testing) |