Skip to content

Commit

Permalink
add details for prerequisite
Browse files Browse the repository at this point in the history
  • Loading branch information
lut777 committed Apr 7, 2021
1 parent 340b95d commit 0265747
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,29 @@

## How to build Kube-OVN

Kube-OVN is developed by [Go](https://golang.org/) 1.15 and uses [Go Modules](https://github.com/golang/go/wiki/Modules) to manage dependency.
##### Prerequisites:

To minimize image size we use docker experiment buildx features, please enable it through the [reference](https://docs.docker.com/develop/develop-images/build_enhancements/).
1, Kube-OVN is developed by [Go](https://golang.org/) 1.15 and uses [Go Modules](https://github.com/golang/go/wiki/Modules) to manage dependency. Make sure `GO111MODULE="on"`.

We also use [gosec](https://github.com/securego/gosec) to inspects source code for security problems.
2, We also use [gosec](https://github.com/securego/gosec) to inspects source code for security problems.

```shell
go get github.com/securego/gosec/v2/cmd/gosec
```

3, To minimize image size we use docker experimental buildx features.

​ For version < Docker 19.03, please enable it manually through the [reference](https://docs.docker.com/develop/develop-images/build_enhancements/).

​ For first compilation, create a new builder instance.

```shell
docker buildx create --use
```

##### Make:

```shell
git clone https://github.com/kubeovn/kube-ovn.git
go get -u github.com/securego/gosec/cmd/gosec
cd kube-ovn
Expand All @@ -19,7 +36,7 @@ make release
Kube-OVN uses [KIND](https://kind.sigs.k8s.io/) to setup a local Kubernetes cluster and [j2cli](https://github.com/kolypto/j2cli) to render template
and [Ginkgo](https://onsi.github.io/ginkgo/) as the test framework to run the e2e tests.

```
```shell
go get -u github.com/onsi/ginkgo/ginkgo
go get -u github.com/onsi/gomega/...

Expand Down

0 comments on commit 0265747

Please sign in to comment.