Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-northbound-bbf-adapter / c8d0d469dbfd2c930d8e20391e9e7bdd0034ee0f
commitc8d0d469dbfd2c930d8e20391e9e7bdd0034ee0f[log] [tgz]
authorElia Battiston <elia@opennetworking.org>Tue Feb 22 16:30:51 2022 +0100
committerElia Battiston <elia@opennetworking.org>Mon Mar 07 12:32:40 2022 +0100
tree5c041e45b849d259c0c2cca1aa70d77696b0d90f
parente3d656192b623f50dd668d1ff6d0087e59c59412 [diff]
[VOL-4638] Initial commit

Change-Id: I5e785d017e1d27783b24591b52f20f442895e602
311 files changed
tree: 5c041e45b849d259c0c2cca1aa70d77696b0d90f
  1. .dockerignore
  2. .gitignore
  3. .gitreview
  4. .golangci.yml
  5. CODE_OF_CONDUCT.md
  6. Makefile
  7. README.md
  8. VERSION
  9. build/
  10. cmd/
  11. go.mod
  12. go.sum
  13. internal/
  14. vendor/
README.md

Northbound BBF Adapter

The Northbound BBF Adapter is a translation layer between the VOLTHA Northbound APIs and the BBF yang model, enabling VOLTHA to be integrated into a full fledged BBF Cloud CO deployment.

Development make targets

The 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              : Build the BBF Adapter docker container
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                      : Run all lint targets
lint-mod                  : Verify the Go dependencies
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.