commit | 05d74025a211a953789c1bd0fd490d51ffb463b0 | [log] [tgz] |
---|---|---|
author | Kengof20xx <kenichi.goto@furukawaelectric.com> | Mon Dec 21 11:56:38 2020 +0900 |
committer | Kengof20xx <kenichi.goto@furukawaelectric.com> | Mon Dec 21 15:25:26 2020 +0900 |
tree | 75decc0c540fbf0d86b451efcfb9828e30085fe7 | |
parent | d7bf820d1553502037895d66f068b4538abc9070 [diff] |
[VOL-1349] EPON OLT adapter (package A) Change-Id: Id110f270b0acfb7fbda0ff79ff85bb8182af4b92
The EPON OLT adapter connects the VOLTHA core to an OLT device running the OLT hardware to support IEEE standard PON (SIEPON* package A and B).
*IEEE P1904.1 Service Interoperability in Ethernet Passive Optical Network
NOTE: This adapter has been verified with the following combinations:
- VOLTHA 2.5
- Tibit MicroPlug OLT (Firmware R1.3.X-XXX)
- Technology profile for EPON
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 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.
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 manualgit
intervention to put the original files back.