AETHER-3162 Remove magma leftover iptables rule from enodebd

AETHER-3198 Add REUSE compliant to enodebd
AETHER-3196 Support identify IP from X-Real IP in enodebd
AETHER-3229 Documentation of configuration and state machine for enodebd
AETHER-3292 Adding new parameter to support in enodebd Sercomm driver
AETHER-3311 Remove unused protobuf definition from enodebd

Change-Id: Ie69f0141eff70cb3d4447cd9575c8224d42dd5e3
152 files changed
tree: ea31afd079eb2fa9b46fae76213d6bc2210283f9
  1. .gitignore
  2. LICENSES/
  3. Makefile
  4. README.md
  5. VERSION
  6. common/
  7. configuration/
  8. data_models/
  9. device_config/
  10. devices/
  11. docs/
  12. enodeb_status.py
  13. eventd/
  14. exceptions.py
  15. logger.py
  16. lte_utils.py
  17. magma_configs/
  18. main.py
  19. metrics.py
  20. override_configs/
  21. proto_files/
  22. pylint.ini
  23. requirements.txt
  24. rpc_servicer.py
  25. s1ap_client.py
  26. sercomm.out
  27. state_machines/
  28. stats_manager.py
  29. tests/
  30. tools/
  31. tr069/
README.md

ENODEBD

eNodeB daemon is an Automatic Configuration Server (ACS) which forks from Facebook Magma project. It currently tested with Sercomm eNodeB P27-SCE4255W small cell.

Run

make venv
python main.py

Configuration

We have these configuration files for configuring eNodeBD service.

  1. override_configs/gateway.mconfig

The enodebd will generate the empty configuration to config service, and it will load override_configs/gateway.mconfig to fill in the empty configuration.

  1. magma_configs/acs_common.yml

The acs_common.yml will hold the default value for all eNodeBs, like as the PLMN may be a shared value among all eNodeBs.

  1. magma_configs/serial_numbers/2009CW5000019.yml

The serial_number.yml will have the customized value for each configurable parameters. The value in serial_number.yml will override the value defines in gateway.mconfig and acs_common.yml when corresponding eNodeB connects (base on the serial number provided by eNodeB).

Prometheus Support

The following example configuration can start a Prometheus container for monitoring data sent by enodebd. The enodebd will start prometheus server on port 8000 by default.

# prometheus configuration - prometheus.yml
global:
  scrape_interval: 15s
  external_labels:
    monitor: 'codelab-monitor'

scrape_configs:
  - job_name: 'prometheus'
    scrape_interval: 5s
    static_configs:
      - targets: ['172.17.0.1:8000']

... and start prometheus container with docker command.

$ docker run -p 9090:9090 -v /home/ubuntu/magma-enodebd-new/prometheus.yml:/etc/prometheus/prometheus.yml prom/prometheus

License

This project is under 3-Clause BSD license.