59 Commits

Author SHA1 Message Date
Jenkins
6f2fd943fa Merge "Add documentation for service catalog format" 2015-11-11 11:58:48 +00:00
ghanshyam
571dfacd18 Add documentation for service catalog format
Tempest does not serve all kind of fancy service cataog format.
Service catalog should be in some standard and consistant format.

This patch adds those in doc to clarify the expected format of catalogs.

Change-Id: I5fb94510c019cca2e81112fb8cf123a3dfab8daf
2015-10-31 13:10:59 +09:00
Marc Koderer
66210aa05f Add plugin cookiecutter in documentation
Since we have a official cookiecutter project we should
rely on it in the documentation. All titles are moved a bit
since only the usage of the cookiecutter and the entry point
is needed to create a working test project. All other information
is just additional and not mandatory for plugin creation.

Change-Id: Ia04d2ea747f19d7b1d272bd7664ff05f61c7c88c
2015-10-26 10:52:32 +01:00
YAMAMOTO Takashi
cb2ac6eeb8 plugin.rst: Fix a typo in an example code fragment
Change-Id: Ib003702533397a2f0f3efc68f75662cad2208301
2015-10-19 15:54:42 +09:00
Jenkins
e13fbc0bb3 Merge "Rename isolated creds to dynamic creds" 2015-10-09 09:52:54 +00:00
Jenkins
e146bfdc21 Merge "Fix init command" 2015-10-09 07:53:50 +00:00
Andrea Frittoli (andreaf)
17209bb083 Rename isolated creds to dynamic creds
Renaming the isolated_creds module to dynamic_creds module, and rename
the IsolatedCreds class to DynamicCredentialProvider in preparation
to migration to tempest-lib.

Partially implements bp tempest-library

Change-Id: I78a4884e980ef7d0103639cb3792a54c69fb7761
2015-10-06 15:02:01 +01:00
Jenkins
c920ba8187 Merge "Deprecate credential config options" 2015-10-06 08:59:30 +00:00
David Paterson
0bf52d497b Fix init command
Init command was not working properly as it could not locate the
configuration sample file.
Steps taken:
- Move config-generator.tempest.conf to etc so it will be installed
with pbr.
- Update all files with new path to config-generator-tempest.conf as
needed.
- Refactor init command so if it detects we are not in a virtual
environment, try to find the global config directory /etc/tempest.
If that fails fallback to [sys.prefix]/etc/tempest.

Closes-Bug: #1491058
Closes-Bug: #1490670
Change-Id: I960bc711ff78ac2b0441ef63dff8ec4fb268fd3a
2015-09-23 09:42:07 -04:00
Matthew Treinish
16cf1e558c
Deprecate credential config options
This commit deprecates the original configuration options for
providing credentials. This mechanism of providing tempest with
credentials to run with has a lot of drawbacks and has been
superseded by using an accounts.yaml file. It has been planned
for deprecation once we had a periodic/experimental CI job setup
to run with test accounts enabled. Now that this has been done
we can start the deprecation cycle for the old options.

Change-Id: Ia5132c5cb32355d6f26b8acdd92a0e55a2c19f41
2015-09-10 11:05:23 -04:00
Jenkins
0da49e92df Merge "Use the oslo.config sphinx module to generate sample" 2015-09-10 05:03:52 +00:00
Matthew Treinish
f45ba2e604
Cleanup tempest docs a bit
This commit fixes a few things in the tempest docs. First it fixes all
of the sphinx warnings and enables fail on warn to ensure we're using
valid sphinx everywhere. It also adds a link from the configuration
guide to the sample config file.

Change-Id: I3ad645a6bbfa46b4498e1732410743e46d6eb0cb
2015-09-02 11:06:44 -04:00
Matthew Treinish
1719dfeb69 Use the oslo.config sphinx module to generate sample
This commit switches to using the oslo.config sphinx extension to
generate a sample config instead of doing it manually in the docs'
conf.py module.

Change-Id: I7032cb4f56c728911ffa5c6911eb504f53bc80af
2015-08-25 14:21:43 +00:00
Matthew Treinish
9392a83fdc
Add plugin docs section on configuration options
This commit adds a subsubsection to the plugin interface docs to
elaborate a bit on how to deal with configuration options. Previously,
how to use them in a plugin was implied, but nothing was explicitly
stated. This corrects that to make it clear on how to deal with
configuration.

Change-Id: Id3afc9657c5419cfba61acb3c84ccfea104d1b20
2015-08-24 10:33:47 -04:00
Jenkins
ded6e4bc7e Merge "Fix typo in tempest configuration page" 2015-08-24 10:29:29 +00:00
Toru Tanami
32f4518e09 Fix typo in tempest configuration guide
The indefinite article of the word "alternate" had became "a".
Fix it to "an".

Closes-Bug #1486786

Change-Id: I8d66d066f218fdb3cb70e45ebbcc6be6ae2e5925
2015-08-21 01:23:57 +00:00
Brandon Palm
304bfdd8fb Fix typo in tempest configuration page
Removes an extra 'what' from the string.

Change-Id: I5c84ea627c84721ed333514ec5c3a62358ab7585
Closes-Bug: #1485843
2015-08-18 16:04:55 +00:00
Matthew Treinish
13ed69fffc
Bake in oslo sample config generation to sphinx build
The expectation from users is that to build docs locally all you need
to do is run build_sphinx on the repo and the docs will be fully
created. When we added the sample config to the tempest docs we ignored
this and just added the sample config generation to the docs tox job.
This commit fixes this by baking in the sample config generation to
the sphinx conf.py file which should ensure we have the sample config
generated every time that we call build_sphinx.

Change-Id: Ifd570707847f52592f5bc9bc743b8d3c98512639
2015-08-11 10:13:03 -04:00
Jenkins
8a5a3e7582 Merge "Include sample configuration in dev docs" 2015-08-05 00:53:03 +00:00
Matthew Treinish
3a851dc08b
Add plugin interface documentation
This commit starts the docs section on creating and using tempest
plugins. It describes how to create a plugin class, an entrypoint, and
a recommended dir structure. As well notes how to use tempest and
tempest-lib in creating a plugin. It'll likely be expanded in the
future as the plugin interface evolves.

Partially Implements bp external-plugin-interface

Change-Id: If2e0c47d0a719d869a3301ddbca07495c81cc498
2015-08-04 12:31:59 -04:00
Mathew Odden
b389faa22f Include sample configuration in dev docs
Since including the sample configuration in tree is
becoming difficult to maintain, lets try moving it to
the developer docs. We still have the ability to view it
easily for users, and it can be auto-generated on doc build,
so it should also always be up to date.

Change-Id: I7ec2d76448feef5ecb9af7c238bbd12619fa31d8
2015-08-04 10:59:38 -04:00
Atsushi SAKAI
0a183b8c6a Fix two typos on tempest documentation
specifing => specifying
secion => section

Change-Id: Ie5c2ddb03586c780e4f338ba9dd2a8adbf824c6e
Closes-Bug: #1478941
2015-07-28 21:53:11 +09:00
Jenkins
507e39b53e Merge "Added documentation to tempest-account-generator" 2015-06-10 10:17:13 +00:00
liuchenhong
aa4aa69740 Fix spell error in configuration.rst
It should be 'location of your accounts.yaml', rather than
'location of you accounts.yaml'.

Change-Id: I2c3abf9fd3eefccb6dbbe8d3a7865a1c4966c4dd
2015-06-10 13:00:03 +08:00
Jane Zadorozhna
00fc3dc40c Added documentation to tempest-account-generator
Added docstring to cmd/account_generator.py.
Fixed help messages.
Added sphinx documentation for tempest-account-generator utility.

Change-Id: I6640ba8a0eaaea187cf38582ab537394dec020b6
2015-06-03 18:17:06 +03:00
Matthew Treinish
2219d3828b Add config option to disable network isolation
This commit adds a new config option to the auth section,
create_isolated_networks, to disable tenant isolation from attempting
to create an isolated network stack on each created tenant. This is
needed because in certain neutron configurations the extra resource
creations are not need or not allowed.

Change-Id: I0899a43709a0cb2967376e914248d2ad4a37773a
Closes-Bug: #1447829
2015-05-27 22:14:44 +00:00
Fei Long Wang
7fee78771a Fix doc issue of lock test accounts
When using the lock testing accounts, allow_tenant_isolation
should be set as False. Now it's missing in the document.
This patch will add it.

Closes-Bug: #1454001

Change-Id: I3e1e7a31ea4c1c8b25e821df545c8674a8de38da
2015-05-14 09:13:46 +12:00
Matthew Treinish
464d287f5b
Remove CLI testing once and for all
The cli tests have been marked for removal for ~6 months and the
framework was the first thing included in tempest lib. There has
been more than enough time for all the projects to pick this up
in the client repos. So let's remove it all!

As part of this a couple of missing entries for tempest's
requirements.txt were found. These dependencies were being installed
by the clients so the fact they were missing was never noticed prior
to this. This commit also adds these missing entries back into the
requirements file.

Change-Id: I4f8638f1c048bbdb598dd181f4af272ef9923806
2015-05-07 14:17:44 -04:00
Matthew Treinish
9329985d47
Cleanup some details about the accounts files
This commit cleans up some details in the accounts.yaml sample file
and the tempest configuration guide to provide missing details about
how to create and use an accounts file. Specifically it adds more
detailed comments to the sample file about each section, and in the
config guide it removes obsolete sections and adds some missing
details.

Change-Id: Ic11335fe1215ab0625ea2308ccc75d22a284c432
Closes-Bug: #1447851
2015-04-24 09:58:18 -04:00
Matthew Treinish
57092136c7 Fix non-locking test accounts doc section
This commit fixes several issues with the non-locking cred provider
section in the tempest config guide. It was in a state stuck between
refactors and didn't accurately describe how it should be used anymore.

Change-Id: Ibc6ca1816f6673e2c8dbd6ae3451e03914f04137
2015-04-21 23:41:16 +00:00
Matthew Treinish
4fae4723df Add a paragraph on the use of tempest_roles option
This commit adds a paragraph to the tempest configuration guide on how
to use the tempest_roles option. This was previously missing from the
tenant isolation section.

Change-Id: I1ef1649186edbeb51e1ced1bbb361b78eaef3721
2015-04-21 23:41:12 +00:00
Matthew Treinish
f96ab3a861
Add section to config guide for setting up services
This commit adds a section to the config guide on how to configure
the available services and the corresponding entries in the service
catalog for those services.

Change-Id: I70d7feb47b2df4b6caf9d38d8e79b59bb30fb894
2015-04-21 19:40:52 -04:00
Matthew Treinish
3220cadc51
Add config guide section on service feature enabled sections
This commit adds another section to the tempest config guide outlining
how the service feature enabled sections should be configured.

Change-Id: Iaedf744068b3f91f72144efcaab5d9eaeb9adb0c
2015-04-21 10:35:50 -04:00
Matthew Treinish
7909e12f39 Add configuration guide sections for more required options
This commit adds additional sections to the tempest configuration guide
to elaborate on the details of several required options when configuring
tempest. Specifically this covers how to set the keystone connection
info, flavors to use for testing, and image setup.

Change-Id: I5a72443a3b05e39eba2eac1c4c9a4d6eef26797d
2015-04-20 18:55:54 +00:00
Matthew Treinish
2b7f048465 Start a tempest config guide networking section
This commit adds a networking section to the tempest configuration
guide to start explaining the various facets of networking
configuration. Right now it only contains a guide around how to
configure tempest to provide a network on server creation. Additional
subsections will be added later on.

Change-Id: Ibdfd8becce18de0ef414027d5e7c580f852607a7
2015-04-20 14:53:57 -04:00
Matthew Treinish
fc7cd8f577 Only use accounts.yaml with locking provider
This commit removes support for using an accounts.yaml file with the
non-locking provider. There is no reason the non-locking provider
would ever need to be used with an accounts.yaml file because the
locking provider supports running serially just fine. (which would be
the sole use case for accounts file with the non-locking provider)
Doing this relegates the non-locking provider to just handle the
legacy config options for providing credentials.

Removing this code path provides the advantage of removing a double
maintenance burden for the non-locking provider, in addition to
simplifying the config and user story around the cred providers. It
also turns out this config permutation was never properly tested and
didn't actually work.

Change-Id: I8088d75897589203264ae29326fe9901c3457cc3
2015-03-30 13:18:22 -04:00
Jenkins
7b47b778be Merge "Add section to the config guide on lock_path" 2015-03-16 08:40:51 +00:00
Matthew Treinish
a970d65486 Cleanup the tempest readme
This commit makes several needed cleanups and improvements to the
tempest readme to make things clearer and elaborate on some sections.
Also as the readme is intended to be a tempest users guide, this moves
sections which are more developer focused to the hacking guide.

Change-Id: I4180ce18268443873fe7d8d5e7d0aaebc2cd1e08
2015-03-12 10:03:11 -04:00
Matthew Treinish
f640f665df Add section to the config guide on lock_path
This commit adds a section to the tempest configuration guide on
configuring the lock_path for running tempest and explains why it
is needed.

Change-Id: I73913797d96f9f833e02e5b37be9c0c85b3ae959
2015-03-11 17:12:38 -04:00
Matthew Treinish
0fd69e467b Update auth section of the configuration guide
This commit updates the auth/credentials section of the tempest
configuration guide to reflect recent changes made to the credential
providers and config file.

Change-Id: I4633ff14be1c33f780b671f0ac0c98884ecc94bc
2015-03-06 00:40:51 -05:00
Matthew Treinish
bc1b15b800 Add tempest config guide doc
This commit adds a new doc page to the tempest documentation to
provide a guide to configuring tempest. It currently contains one
section to elaborate on the credentials and auth options in the config
file. This doc will be expanded in the future to add details around
other pieces of tempest configuration.

Change-Id: Iaf7cefc6a5e508437e4b4620ba5bfaa221f3611b
2015-02-24 11:24:18 -05:00
Joe H. Rahme
61469fd194 Adds documentation for Javelin
I followed what's done for the cleanup.py script and re-used parts of
what was described in the javelin spec.

Change-Id: I57adc3764e75784d4614b6c03996433a4ee4332f
2014-12-18 20:06:48 +02:00
Jenkins
bea1b3c1a2 Merge "Add tempest post-run cleanup script" 2014-10-04 00:05:10 +00:00
Christian Berendt
bf48dafdb3 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: Icdb04bbe9eb931b07e7363ebb852fa9e73b088ea
Related-Bug: #1368910
2014-09-25 10:06:42 +02:00
David Paterson
ce781498cf Add tempest post-run cleanup script
Implemented all features defined in blueprint.

Change-Id: If3c9b82f85095eeb22bbf32841be534024213567
Implements: blueprint post-run-cleanup
2014-09-19 01:58:58 -04:00
Matthew Treinish
16dd51b50f Add REVIEWING.rst
This commit adds a file to outline what to look for as a tempest code
reviewer.

Change-Id: I945469842183d0e5022cd41f823d4892adff333f
2014-08-21 20:54:10 -04:00
Jenkins
9d63c38e98 Merge "cleaning up index.rst file" 2014-07-17 08:45:06 +00:00
Matthew Treinish
077a563bb2 Fix warnings from build_sphinx
This commit fixes a couple of issues with build_sphinx in the tempest
docs.

Change-Id: Id8572455616e9be94a8c5794328eb9c1791db5b3
2014-06-04 11:45:14 -04:00
Christian Berendt
7e571e6eea cleaning up index.rst file
Removed notes about the generation of the file.

Change-Id: I70bf5438a8fea9ca4f785313db4975b328f3a749
2014-05-29 17:15:36 +02:00
Dirk Mueller
82ba4286e0 Switch over to oslosphinx
oslosphinx is the new name of oslo.sphinx

Closes-Bug: #1277168
Change-Id: Ibfb9e59fbb3ef51a821b4f412601e26cb7f703f4
2014-02-14 18:16:53 +01:00