Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-eponolt-adapter / d7bf820d1553502037895d66f068b4538abc9070 / .
tree: 084c3ebb1125f5cc6253a59605e773b9c338481d [path history] [tgz]
  1. CODE_OF_CONDUCT.md
  2. Makefile
  3. README.md
  4. VERSION
  5. cmd/
  6. compose/
  7. docker/
  8. go.mod
  9. go.sum
  10. internal/
  11. pkg/
  12. vendor/
README.md

EPON OLT adapter

The EPON OLT adapter connects the VOLTHA core to an OLT device running the OLT hardware to support IEEE standard PON (SIEPON* package B).

*IEEE P1904.1 Service Interoperability in Ethernet Passive Optical Network

NOTE: This adapter has been verified with the following combinations:

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-profile      : Build eponolt adapter docker image with profiling enabled
docker-build              : Build eponolt 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.