vnf-api-golang¶

VNF HTTP rest API with basic operations. This VNF is meant for the OAI artefact.

Installation¶

The installation procedure is detailed for development purposes. In case you are interested in the deployment only, have a look at the section Examples.

The VNF HTTP rest API depends on libraries present in the file glide.yml. The glide program is a dependencies management program for golang. The glide.yml file contains the dependencies and the installed version.

Configuration¶

The configuration of the VNF and its API is handled with the help of Viper. The configuration can be set through different streams: cli flags, environment, file, defaults. These options are ordered by priority in case of multiple configuration streams.

CLI options accessible -h or --help on the app¶

    --logging.file.path string               logging path if file output is chosen for your API logging (default "./log/vnf.log")
    --logging.level string                   logging level for your API (debug, info, warn, error, fatal, panic (default "info")
    --logging.logstash.host string           Logstash hostname (default is Logaas server) (default "laas-in-prod-ow-pl.itn.ftgroup")
    --logging.logstash.port int              Logstash server port (default 443)
    --logging.logstash.protocol string       Logstash server net protocol (default "tcp")
    --logging.output string                  logging output for your API (stdout, file, logstash) (default "stdout")
    --logging.project_id string              Project ID given by the Logaas application (mandatory if you use logstash with Logaas option) (default "328cce52738c9ab")
    --options.documentation.enabled          Enable or disable the openAPI (aka swagger) documentation on your API (default true)
    --options.documentation.version string   version (tag) of the openAPI (aka swagger) documentation on your API (more: https://github.com/swagger-api/swagger-ui) (default "v2.2.10")
    --server.host string                     server hostname (default "127.0.0.1")
    --server.port int                        server listening port (default 1337)
    --storage.file.path string               storage database location path (storage is a file) (default "./vnf_db")
    --storage.postgres.db string             postgres storage server database (default "vnf_db")
    --storage.postgres.host string           postgres storage server hostname (default "127.0.0.1")
    --storage.postgres.password string       postgres storage server password (default "myScretPassword")
    --storage.postgres.port int              postgres storage server port (default 5432)
    --storage.postgres.user string           postgres storage server username (default "postgres")
    --storage.type string                    storage database type (file, postgres) (default "file")
    --templates.path string                  templates for VNF configuration path (default "./templates")
    --templates.version string               templates for VNF configuration version (default "v1")

Environement variables¶

They should be prefixed with "VNF". Examples:

1
2
3

export VNF_SERVER_HOST=192.18.21.45
export VNF_LOGGING_OUTPUT=stdout
export VNF_LOGGING_OUTPUT=logstash

Configuration file¶

This is a configuration file. You can write your own in any Viper supported formats: JSON, TOML, YAML, HCL, or Java properties. Configuration file config (whatever extension you chose) is expected in one of these locations: /etc/vnf-api-golang/, $HOME/.vnf-api/, or ./config/

{
    "server":{"host": "0.0.0.0", "port": 1337},
    "storage": {
        "type": "file",
        "file":{"path": "./vnf_db"},
        "postgres":{"host": "127.0.0.1", "port": 5432, "user":"postgres", "password": "mysecretpassword", "db": "vnf_db"}
    },
    "scheduler":{
        "type": "system",
        "docker": {"host": "", "cert_path": "", "api_version": ""}
    },
    "templates": {
        "path": "./templates",
        "version": "1"
    },
    "runtime": {"path": "./runtime"},
    "logging": {
        "level": "info",
        "output": "stdout",
        "file": {"path": "/var/log/vnf.log"},
        "project_id": "328cce52738c9ab",
        "logstash": {"host":"laas-in-prod-ow-pl.itn.ftgroup", "port": 443, "protocol":"tcp"}
    },
    "options": {
        "documentation": { "enabled": true, "version": "v2.2.10"}
    }
}

Storage¶

This section defines the storage driver to use with the VNF API. Options are file or postgres. If the file is chosen a path must be set, otherwise the default will be used. If a postgres database is used, the correct configuration parameters need to be set accordingly.

Scheduler¶

This sections describes which scheduler does the VNF manager uses to deploy your vnf. It can be either "system" or "docker". The system scheduler will exec the binary in the same environment as the API itself. The docker scheduler will instantiate the docker image of your VNF with the given host configuration.

Templates¶

This will generate the configuration files according to the JSON sent through the API. The JSON configuration will then be compiled in the template given according to the version requested in the JSON. A version can also be configured by default.

Logging¶

This section handles the logging of the VNF using logrus. The output can be stdout, file, logstash. If you use Logaas, the project_id references your project tag delivered when you register your application. This is mandatory if you choose to use the logstash output. The default values for Logaas's logstash are set above. You can of course chose to log into the output file and deliver your files using filebeat as currently recommended by Logaas. In the latter case, you have to write your own filebeat.yml following the recommendations.

Options¶

This currently turn on or off the documentation using swagger v2. You can chose to turn off documentation in production environments or for security reasons, for example. We recommend to turn it on in development environments by setting the option to true.