2.1. Introduction

Welcome to Yardstick’s documentation !

Yardstick is an OPNFV Project.

The project’s goal is to verify infrastructure compliance, from the perspective of a Virtual Network Function (VNF).

The Project’s scope is the development of a test framework, Yardstick, test cases and test stimuli to enable Network Function Virtualization Infrastructure (NFVI) verification.

Yardstick is used in OPNFV for verifying the OPNFV infrastructure and some of the OPNFV features. The Yardstick framework is deployed in several OPNFV community labs. It is installer, infrastructure and application independent.

See also

Pharos for information on OPNFV community labs and this Presentation for an overview of Yardstick

2.1.1. About This Document

This document consists of the following chapters:

  • Chapter Introduction provides a brief introduction to Yardstick project’s background and describes the structure of this document.

  • Chapter Methodology describes the methodology implemented by the Yardstick Project for NFVI verification.

  • Chapter Architecture provides information on the software architecture of Yardstick.

  • Chapter Yardstick Installation provides instructions to install Yardstick.

  • Chapter Yardstick Usage provides information on how to use Yardstick to run and create testcases.

  • Chapter Installing a plug-in into Yardstick provides information on how to integrate other OPNFV testing projects into Yardstick.

  • Chapter Store Other Project’s Test Results in InfluxDB provides inforamtion on how to run plug-in test cases and store test results into community’s InfluxDB.

  • Chapter Grafana dashboard provides inforamtion on Yardstick grafana dashboard and how to add a dashboard into Yardstick grafana dashboard.

  • Chapter Yardstick Restful API provides inforamtion on Yardstick ReST API and how to use Yardstick API.

  • Chapter Yardstick User Interface provides inforamtion on how to use yardstick report CLI to view the test result in table format and also values pinned on to a graph

  • Chapter Network Services Benchmarking (NSB) describes the methodology implemented by the Yardstick - Network service benchmarking to test real world usecase for a given VNF.

  • Chapter NSB Installation provides instructions to install Yardstick - Network Service Benchmarking (NSB) testing.

  • Chapter Yardstick - NSB Testing - Operation provides information on running NSB

  • Chapter Yardstick Test Cases includes a list of available Yardstick test cases.

2.1.2. Contact Yardstick

Feedback? Contact us