Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Repository Link: https://gerrit.akraino.org/r/gitweb?p=iec.git;a=tree

The directory tree of IEC as following:

$ ls

ci deploy docs LICENSE misc README.rst src tox.ini


$ tree -L 3

├── ci
│   └── labs
│   └── arm
├── deploy
│   └── compass
│   ├── deployIEC.sh
│   ├── deploy.sh
│   └── deployVM.sh
├── docs
│   ├── conf.py
│   ├── conf.yaml
│   ├── index.rst
│   ├── release
│   │   ├── api
│   │   ├── installation
│   │   └── release-notes
│   └── requirements.txt
├── LICENSE
├── misc
│   └── type1
│   ├── macbin
│   └── README.md
├── README.rst
├── src
│   ├── foundation
│   │   ├── api
│   │   ├── hot
│   │   └── scripts
│   ├── use_cases
│   │   └── seba_on_arm
│   └── xConnect
│   └── README
└── tox.ini

./iec/docs

  • The documentation in this directory provides a more detailed introduction to IEC

./iec/src/foundation/scripts/

  • A series of scripts are provided to build the IEC infrastructure platform, including: building the k8s cluster and configuring the container network solution.

./iec/src/use_cases/seba_on_arm/

  • SDN-Enabled Broadband Access (SEBA) is an Exemplar Platform being built by the ONF and CORD community, which would also be a first use case of IEC. We provide  SEBA source repositories, compiling scripts, test scripts and SEBA installation guide on Arm.

./iec/misc/type1/macbin/

  • This dir contains the miscellaneous information about IEC Type 1 device and software info. Currently we choose the MACCHIATObin board as the main Type 1 hardware platform.


IEC Static Code Check

Currently, a source code commit to IEC code repo usually would be subject to a code syntax check under Akraino Jobbuilder job by Tox, which would check the following types of code in general:

  • Bash shell script(.sh)
  • Python(.py)
  • Yaml(.yaml,.yml)
  • ReStructuredText(.rst)

The IEC verify job follows [1], the rules used are the defaults provided by each tool, except where IEC required exceptions, e.g.:

  • git commit message checks, RST checks, shellcheck checks use default configurations;
  • pylint uses [2] to allow some common errors/warnings to be ignored;
  • yamllint uses [3] to allow unquoted truthy values, ignore missing document start markers.
  • No labels