From 2a94c1634891272b9f1070808bf315f5897c87d0 Mon Sep 17 00:00:00 2001 From: Ilya Shakhat Date: Tue, 24 Mar 2015 19:21:32 +0300 Subject: [PATCH] Update readme file Change-Id: I82ecc63effd708216f022595fea3e9bb7af4e83b --- README.rst | 22 ++++++---------------- setup.cfg | 2 +- 2 files changed, 7 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index c79afc6..1cbda34 100644 --- a/README.rst +++ b/README.rst @@ -24,21 +24,11 @@ How to run ---------- 1. ``shaker --server-endpoint : --scenario --report `` -During the run the tool deploys topology linked into scenario, spawns instances, distributes +During the run the tool deploys topology, spawns instances, distributes tasks among instances and generates report in HTML format. -All server parameters ---------------------- - - * ``server_endpoint = `` - Address for server connections (host:port) (string value) - * ``os_auth_url`` - Authentication URL, defaults to env[OS_AUTH_URL]. (string value) - * ``os_tenant_name`` - Authentication tenant name, defaults to env[OS_TENANT_NAME]. (string value) - * ``os_username`` - Authentication username, defaults to env[OS_USERNAME]. (string value) - * ``os_password`` - Authentication password, defaults to env[OS_PASSWORD]. (string value) - * ``os_region_name = RegionOne`` - Authentication region name, defaults to env[OS_REGION_NAME]. (string value) - * ``external_net`` - Name or ID of external network. If not set the network is chosen randomly. (string value) - * ``image_name = shaker-image`` - Name of image to use. The default is created by shaker-image-builder (string value) - * ``flavor_name = shaker-flavor`` - Name of image flavor. The default is created by shaker-image-builder (string value) - * ``scenario = `` - Scenario file name (string value) - * ``report = `` - Report file name. If not specified print to stdout (string value) - * ``report_template = shaker/engine/report.template`` - Report template file name (Jinja format) (string value) +Links +----- + * Launchpad - https://launchpad.net/shaker/ + * Docs - http://shaker-docs.readthedocs.org/ + * PyPi - https://pypi.python.org/pypi/pyshaker/ diff --git a/setup.cfg b/setup.cfg index 5c41abb..6daf420 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [metadata] -name = shaker +name = pyshaker summary = Distributed data-plane performance testing tool description-file = README.rst