Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-openolt-adapter
Clone this repo:

Branches

More...

Tags

More...
  1. cb23cbe VOL-5437:Openolt adapter fix for disable pon ports by balaji6299 · 5 weeks ago master v4.5.11
  2. 041a212 [VOL-5374] Update go version to 1.23 by Akash Kankanala · 7 months ago v4.5.10
  3. 93766e9 [VOL-5434] update voltha-lib-go for recv grpc rsrc exhauseted by abhay · 7 weeks ago v4.5.9
  4. d1c984b [VOL-5415] Reordered the stopping of heartbeat and readIndication routines in updateStateRebooted, moving it before the updateDeviceStateInCore function call by bseeniva · 4 months ago v4.5.8
  5. 2644994 [VOL-5429] - update voltha-lib-go version to 7.6.6 by Sridhar Ravindra · 3 months ago v4.5.7

OpenOLT adapter

The OpenOLT adapter connects the VOLTHA core to an OLT device running the OpenOLT agent.

Development make targets

The Makefile contains many commands that are useful in development:

% make help

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.

Building with a Local Copy of voltha-protos or voltha-lib-go

If 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 vendor directory are no longer what is in the most recent commit, and it will take manual git intervention to put the original files back.