| commit | 106c61a2c63a8259f9aa47dc8a852a2f176c5a6f | [log] [tgz] |
|---|---|---|
| author | khenaidoo <knursimu@ciena.com> | Wed Aug 11 18:05:46 2021 -0400 |
| committer | khenaidoo <knursimu@ciena.com> | Tue Oct 05 13:53:50 2021 -0400 |
| tree | 36012e1835c280c6efe857bf05d83940466677b8 | |
| parent | 6f345c101cbbd4d6d45b4b371d0b3b477c1497ea [diff] |
[VOL-4292] OpenOLT Adapter changes for gRPC migration Change-Id: I5af2125f2c2f53ffc78c474a94314bba408f8bae
The OpenOLT adapter connects the VOLTHA core to an OLT device running the OpenOLT agent.
make targetsThe Makefile contains many commands that are useful in development:
build : Alias for 'docker build' clean : Removes any local filesystem artifacts generated by a build distclean : Removes any local filesystem artifacts generated by a build or test run docker-build-profile : Build openolt adapter docker image with profiling enabled docker-build : Build openolt adapter docker image docker-kind-load : Load docker images into a KinD cluster docker-push : Push the docker images to an external repository help : Print help for each Makefile target lint-dockerfile : Perform static analysis on Dockerfile lint-mod : Verify the Go dependencies lint : Run all lint targets local-lib-go : Copies a local version of the voltha-lib-go dependency into the vendor directory local-protos : Copies a local version of the voltha-protos dependency into the vendor directory mod-update : Update go mod files sca : Runs static code analysis with the golangci-lint tool test : Run unit tests
Some highlights:
It's recommended that you run the lint, sca, and test targets before submitting code changes.
The docker-* targets for building and pushing Docker images depend on the variables DOCKER_REGISTRY, DOCKER_REPOSITORY, and DOCKER_TAG as described in the CORD documentation
If you make changes the dependencies in the go.mod file, you will need to run make mod-update to update the go.sum and vendor directory.
voltha-protos or voltha-lib-goIf you want to build/test using a local copy of the voltha-protos or voltha-lib-go libraries this can be accomplished by using the environment variables LOCAL_PROTOS and LOCAL_LIB_GO. These environment variables should be set to the filesystem path where the local source is located, e.g.:
export LOCAL_PROTOS=/path/to/voltha-protos export LOCAL_LIB_GO=/path/to/voltha-lib-go
Then run make local-protos and/or make local-lib-go as is appropriate to copy them into the vendor directory.
NOTE: That the files in the
vendordirectory are no longer what is in the most recent commit, and it will take manualgitintervention to put the original files back.