performa/shaker
Code Issues Proposed changes

Update documentation

Browse Source 
Change-Id: Id2a831e8a245778bdea508fd818b47c8ecd0f8e7
This commit is contained in:
Ilya Shakhat 2020-03-08 21:53:04 +04:00
parent 55833e5b2b
commit 737b019a3a
6 changed files with 23 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/architecture.rst
View File

@ -3,7 +3,7 @@ Architecture
============
Shaker tool consists of server and agent modules. The server is executed by ``shaker`` command
and is responsible for deployment of instances, execution of tests as specified in the scenario,
and is responsible for deployment of instances, execution of tests specified in scenario file,
for results processing and report generation. The agent is light-weight and polls tasks from
the server and replies with the results. Agents have connectivity to the server, but the server does not
(so it is easy to keep agents behind NAT).

4
doc/source/conf.py
View File

@ -1,5 +1,3 @@
# Copyright (c) 2015 Mirantis Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
@ -42,7 +40,7 @@ master_doc = 'index'
# General information about the project.
project = u'Shaker'
copyright = u'2015, Mirantis'
copyright = u'2015-2020 Shaker contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the

2
doc/source/contributing.rst
View File

@ -14,7 +14,7 @@ Start working
1. Clone the repo::
$ git clone https://git.openstack.org/openstack/shaker
$ git clone https://opendev.org/performa/shaker
2. From the root of your workspace, check out a new branch to work on::

43
doc/source/installation.rst
View File

@ -6,28 +6,10 @@ Installation in Python environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Shaker is distributed as Python package and available through PyPi (https://pypi.org/project/pyshaker/).
It is recommended to be installed inside virtualenv.
.. code::
$ virtualenv venv
$ . venv/bin/activate
$ pip install pyshaker
Installation on Ubuntu Cloud Image
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installation on fresh system requires additional libraries needed by some of dependencies.
.. code::
$ sudo apt-add-repository "deb http://nova.clouds.archive.ubuntu.com/ubuntu/ trusty multiverse"
$ sudo apt-get update
$ sudo apt-get install python-dev libzmq-dev
$ wget -O get-pip.py https://bootstrap.pypa.io/get-pip.py && sudo python get-pip.py
$ sudo pip install pbr pyshaker
$ shaker --help
$ pip install --user pyshaker
OpenStack Deployment
@ -44,23 +26,28 @@ For full features support it is advised to run Shaker by admin user. However
with some limitations it works for non-admin user - see :ref:`non_admin_mode` for details.
Build base image
^^^^^^^^^^^^^^^^
Base image
^^^^^^^^^^
Automatic build in OpenStack
----------------------------
.. note::
This method requires Glance v.1 API; the base image is downloaded directly
from Internet into Glance.
Build the master image. The process downloads Ubuntu cloud image, installs all necessary packages and stores
snapshot into Glance. This snapshot is used by ``shaker`` as base of instances.
The base image can be built using `shaker-image-builder` tool.
.. code::
$ shaker-image-builder
There are 2 modes available:
* `heat` - using Heat template (requires Glance v1 for base image upload);
* `dib` - using diskimage-builder elements (requires qemu-utils and
debootstrap to build Ubuntu-based image).
By default the mode is selected automatically preferring `heat` if Glance API v1
is available. Created image is uploaded into Glance and made available for further executions
of Shaker. For full list of parameters refer to :ref:`shaker_image_builder`.
Manual build with disk-image-builder
------------------------------------
@ -69,7 +56,7 @@ Shaker image can also be built using `diskimage-builder`_ tool.
#. Install disk-image-builder. Refer to `diskimage-builder installation`_
#. Clone Shaker repo:
``git clone https://git.openstack.org/openstack/shaker``
``git clone https://opendev.org/performa/shaker``
#. Add search path for diskimage-builder elements:
``export ELEMENTS_PATH=shaker/shaker/resources/image_elements``
#. Build the image based on Ubuntu Xenial:

3
doc/source/tools.rst
View File

@ -18,6 +18,9 @@ Executes specified scenario from the local node, stores results and generates HT
.. literalinclude:: tools/shaker-spot.txt
.. _shaker_image_builder:
shaker-image-builder
--------------------

4
tools/build_scenario_catalog.py
View File

@ -75,7 +75,7 @@ def make(src, dest):
print_info(out, info, prefix='scenario')
print('To use this scenario specify parameter ``--scenario %s``.\n'
'Scenario source is available at: '
'https://github.com/openstack/shaker/blob/master/%s' %
'https://opendev.org/performa/shaker/src/branch/master/%s' %
(info['scenario_id'], info['path']), file=out)
print('', file=out)
@ -86,7 +86,7 @@ def make(src, dest):
for info in templates:
print_info(out, info, prefix='template')
print('Template source is available at: '
'https://github.com/openstack/shaker/blob/master/%s' %
'https://opendev.org/performa/shaker/src/branch/master/%s' %
info['path'], file=out)
print('', file=out)