Source code for yardstick.main

#!/usr/bin/env python

##############################################################################
# Copyright (c) 2015 Ericsson AB and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################

""" yardstick - command line tool for managing benchmarks

    Example invocation:
    $ yardstick task start samples/ping.yaml

    Servers are the same as VMs (Nova calls them servers in the API)

    Many tests use a client/server architecture. A test client is configured
    to use a specific test server e.g. using an IP address. This is true for
    example iperf. In some cases the test server is included in the kernel
    (ping, pktgen) and no additional software is needed on the server. In other
    cases (iperf) a server process needs to be installed and started.

    One server is required to host the test client program (such as ping or
    iperf). In the task file this server is called host.

    A server can be the _target_ of a test client (think ping destination
    argument). A target server is optional but needed in most test scenarios.
    In the task file this server is called target. This is probably the same
    as DUT in existing terminology.

    Existing terminology:
    https://www.ietf.org/rfc/rfc1242.txt (throughput/latency)
    https://www.ietf.org/rfc/rfc2285.txt (DUT/SUT)

    New terminology:
    NFV TST

"""
import sys

from yardstick.cmd.cli import YardstickCLI


[docs]def main(): '''yardstick main''' YardstickCLI().main(sys.argv[1:])
if __name__ == '__main__': main()