Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 4.25 KB

README.rst

File metadata and controls

91 lines (61 loc) · 4.25 KB
Raw

polycube code generation tools

This repository keeps in the same place the two tools pyang-swagger and swagger-codegen, which are used to generate a polycube stub from a YANG datamodel.

The preferred way to generate a stub from a yang datamodel is through its corresponding docker.

Docker

A ready-to-go Docker image is at polycubenetwork/polycube-codegen. The entry point of the image is polycube-codegen and the usage provided in this document. In this case you should provide a volume in /polycube-base-datamodel with the polycube base datamodel you want to handle.

The following is a full command line example, where the --user `id -u` guarantees that the generated files have the permissions set to the current user:

export POLYCUBE_BASEMODELS=<path to base models usually /usr/local/include/polycube/datamodel-common/>
docker pull polycubenetwork/polycube-codegen
docker run -it --user `id -u` \
  -v $POLYCUBE_BASEMODELS:/polycube-base-datamodels \
  -v <input yang>:/input \
  -v <output folder in host>:/output \
  polycubenetwork/polycube-codegen \
  -i /input/<yang datamodel> \
  -o /output/<output folder>

Usage

polycube-codegen expects the POLYCUBE_BASE_DATAMODELS_FOLDER to be set to the folder were the base datamodels of polycube are located. If you have installed polycube in the standard location and everything is ok you could omit that parameter that defaults to /usr/local/include/polycube/datamodel-common/.

$ docker run -it --user `id -u` [folder-options] [polycube-codegen-options]

where [folder-options] are required to tell the Docker the location of input/output files
and the exact datamodel we are interested in:
    -v $POLYCUBE_BASEMODELS:/polycube-base-datamodels \
    -v <input yang file>:/input \
    -v <output folder in host>:/output

and where [polycube-codegen-options] can be:
    -h  show this help text
    -i  path to the input YANG file
    -o  path to the destination folder where the service stub will be placed
    -s  path to the destination swagger file (optional)
    -l  language used to generate service's client library (optional)"

Client stub for Polycube services

Each Polycube service uses a specific convention for generate the REST APIs that are used by external players to interact with the service itself. In order to interact with those service, users can use the polycubectl CLI tool or creates their own client programs that communicates with a given service. To simplify the creation of those programs, polycube-codegen supports the generation of client stubs in different programming languages such as golang, java, python (full list available here under the swagger-codegen project).

To do this, we can directly use the provided polycube-codegen script adding the -l option with the name of the language you want to use. For instance, in order to generate the client stub for the pcn-simplebridge service in the GO language, you can use the following command line options:

-i pcn-simplebridge.yang
-o output_folder
-l go

In its final processing step, polycube-codegen relies on the online service https://generator.swagger.io/api/gen/clients generator to create the code stub; hence this requires Internet connectivity.

Full installation (from sources)

If you don't want to use the docker, the easiest way to install this package (including all dependencies) is to use the install.sh script. If you want to install those by hands please refer to each repository to get further details.

cd polycube-codegen
git submodule update --init
./install.sh

The command line is similar to the docker, such as:

$ polycube-codegen [-h] [-i input_yang] [-o output_folder] [-s output_swagger_file] [-l client_language]
Polycube code generator that translates a YANG file into an polycube C++ service stub