Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-go-controller / ec895f87f4ab78b790c18e010c75ae631c7a3152
commitec895f87f4ab78b790c18e010c75ae631c7a3152[log] [tgz]
authorJoey Armstrong <jarmstrong@linuxfoundation.org>Thu Apr 25 14:26:07 2024 -0400
committerJoey Armstrong <jarmstrong@linuxfoundation.org>Thu Apr 25 14:29:16 2024 -0400
tree34f41329af541ab8d344314b882504d19bd650f7
parentd213b0936f487e8c312ce30da0ff7930a5179d13 [diff]
Add tool pre-commit to suport source linting.

Makefile
requirements.txt
.pre-commit-config.yaml
-----------------------
  o Add project copyright notice with SPDX tokens.
  o Added makefile targets for installing a virtualenv and the
    tool/library pre-commit.
  o .pre-commit-config added for basic linting config.

Change-Id: Ib225221e1db149715d015a71877655299657d6a7
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
4 files changed
tree: 34f41329af541ab8d344314b882504d19bd650f7
  1. .gitignore
  2. .gitreview
  3. .golangci.yml
  4. .pre-commit-config.yaml
  5. Makefile
  6. README.md
  7. VERSION
  8. database/
  9. docker/
  10. entryscript.sh
  11. go.mod
  12. go.sum
  13. infra/
  14. internal/
  15. log/
  16. requirements.txt
  17. tests/
  18. vendor/
  19. voltha-go-controller/
README.md

VOLTHA-go-controller

  • Go based light-weight controller
  • Handling the control plane functionality which translates the user-configurations to system configurations
  • Community Defined gRPC based communication towards voltha
  • Seamless software upgrade with support for data migration
                    +--------------------------+------------+--------------------------+
                    |                          | NBI (REST) |                          |
                    |                          +------------+                          |
                    |                                                                  |
                    |                      Voltha-Go-Controller          +--------+    |
                    |                                                    | VGCCTL |    |
                    |     +------------------------------------------+   +--------+    |
                    |     |               Applications               |                 |
                    |     +------------------------------------------+   +---------+   |
                    |                                                    |   NB    |   |
                    |     +------------------------------------------+   | HANDLER |   |
                    |     |                Controller                |   +---------+   |
                    |     +------------------------------------------+                 |
                    |                                                    +---------+   |
                    |     +------------------------------------------+   |   DB    |   |
                    |     |                 VPAgent                  |   | HANDLER |   |
                    |     +------------------------------------------+   | (Redis) |   |
                    |                                                    +---------+   |
                    +------------------------------------------------------------------+
                                                  |
                                                  | gRPC 
                                                  |
                              +------------------------------------------+
                              |                                          |
                              |                 Voltha                   |
                              |                                          |
                              +------------------------------------------+

Features Supported:

  • User Profile Configuration
  • Logical Device Management
  • DHCP Relay
  • PPPoE Relay
  • Igmp Proxy
  • Periodic Audit of Flows/Groups/Meters
  • CLI support for read-only access to configuration

Interfaces Supported

  • North : REST
  • South : gRPC (community defined)
  • East-West : Kafka

NB API Details:

Add Meter Profile:

curl --request  POST -H Content-Type:application/json http://$VGC_POD_IP:8181/profiles/service1 -d @addbw.json

addbw.json:
{
            "id": "High-Speed-Internet",
            "gir": 50000,
            "cbs": 10000,
            "cir": 50000,
            "pbs": 1000,
            "pir": 300000
}

Add Service/Subscriber Info:

curl --request  POST -H Content-Type:application/json http://$VGC_POD_IP:8181/subscribers/service1 -d @addsub.json

addsub.json
{
  "id": "service1",
  "nasPortId": "XXXX429d750e-1",
  "uniTagList": [
    {
      "uniTagMatch": 4096,
      "ponCTag": 4096,
      "ponSTag": 140,
      "technologyProfileId": 64,
      "downstreamBandwidthProfile": "High-Speed-Internet",
      "upstreamBandwidthProfile": "High-Speed-Internet"
    }
  ]
}

Remove Service and bring down flows:

    curl --request  DELETE http://$VGC_POD_IP:8181/subscribers/service1

CLI Support: VGCCTL

device      : Lists Device Info
group       : Lists configured Groups
vnet        : Lists configured VNET profiles
tasklist    : Lists TaskList
igmp        : Displays current IGMP configuration
mcast       : Displays current MCAST configuration
flows       : Lists configured flows
service     : Lists configured services
mvlan       : Lists configured MVLANs
dhcpsession : Lists DHCP Session Info
port        : Lists all the logical ports
igmpgroup   : Lists configured IGMP Groups
meter       : Lists all the meter profiles
vpvs        : Lists configured vpvs
igmpchannel : Lists configured IGMP channels
igmpport    : Lists configured IGMP ports
igmpdevice  : Lists configured IGMP devices

Pre-Requisties:

Use the package manager pip to install foobar.

Compatibility:

Compatible goLang version: go1.16.3
Compatible Redis version: github.com/go-redis/redis/v8 v8.3.4

Development Usage:

build                     : Build voltha-go-controller image
clean                     : Removes any local filesystem artifacts generated by a build
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

Basic build:

Clone "voltha-go-controller"
cd voltha-go-controller
go mod vendor
make clean; make build

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

APACHE