Gitiles
Code Review Sign In
gerrit.lfbroadband.org / voltha-openolt-adapter / 9bcfeb2ee6b7cc9b594c4c23c61aecedb6b64110
commit9bcfeb2ee6b7cc9b594c4c23c61aecedb6b64110[log] [tgz]
authorAbhay Kumar <abhayk@radisys.com>Fri Jul 12 09:14:25 2024 +0530
committerAbhay Kumar <abhayk@radisys.com>Wed Dec 11 06:46:50 2024 +0000
treeac6b524aa88ee0573e721562415ebbc3080c0552
parent1b590f14747fe206e3c5ed9c8d589338aa8e3e7a [diff]
[VOL-5359] Add redis option as KVStore

Change-Id: I5c2c837162685e45a50f8a4bef73bcf723a11f48
Signed-off-by: Abhay Kumar <abhayk@radisys.com>
5 files changed
tree: ac6b524aa88ee0573e721562415ebbc3080c0552
  1. .gitignore
  2. .gitreview
  3. .golangci.yml
  4. .pre-commit-config.yaml
  5. CODE_OF_CONDUCT.md
  6. Makefile
  7. README.md
  8. VERSION
  9. cmd/
  10. compose/
  11. config.mk
  12. docker/
  13. go.mod
  14. go.sum
  15. internal/
  16. makefiles/
  17. pkg/
  18. requirements.txt
  19. vendor/
README.md

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.