AETHER-3573 Simplify configuration files in enodebd

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

Install & Run

# The all command will create a virtual environment, install protoc and compile the proto files
make all
# Enter the virtual environment
. venv/bin/activate

# Run enodebd
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:
      # The 8000 is the default port of prometheus client of enodebd
      - 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.