Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-go-controller / refs/heads/master
commitaca03cf7acc613a98904a7d3e54e163ffc902d04[log] [tgz]
authorJoey Armstrong <jarmstrong@linuxfoundation.org>Tue Apr 23 09:29:52 2024 -0400
committerEric Ball <eball@linuxfoundation.org>Fri Sep 13 17:08:46 2024 -0700
tree62c89c4dd050765b161103c677dcba6884808cbf
parentec895f87f4ab78b790c18e010c75ae631c7a3152 [diff]
[VOL-5346] Update copyright notice, gather profiling stats.

[See Also] https://gerrit.opencord.org/c/voltha-go-controller/+/35217
  o No jira ticket available yet so reference gerrit patch.

VERSION
-------
  o Bump version string for the patch.

database/database.go
internal/pkg/application/application.go
internal/pkg/application/service.go
internal/pkg/util/envutils/envutils.go
tests/results/go-test-coverage.out
tests/results/go-test-coverage.xml
tests/results/go-test-results.xml
voltha-go-controller/nbi/bwprofile.go
voltha-go-controller/nbi/igmpproxy.go
voltha-go-controller/nbi/mvlan.go
---------------------------------------
  o Update copyright notice to contain SPDX tokens and span 2024.
  o This patch is submitted for side effects, generate comparison stats.
  o Patch 35217 failed make sca/profiling phase due to a timeout.
  o Copyright edits will run a NOP version of the original patch to
    determine if the timeout is pre-existing or new behavior.

Change-Id: I7f63613c71c8a4eee80ad5d6332810dc9b5b361c
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
Signed-off-by: Eric Ball <eball@linuxfoundation.org>
11 files changed
tree: 62c89c4dd050765b161103c677dcba6884808cbf
  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