Commit Graph

50 Commits

Author SHA1 Message Date
Masayuki Igawa
b78b923e5a Fix indentation in docs
This commit fixes indentation in tempest docs. These indentations are
not necessary and it causes a weird html outputs.

Change-Id: I9c8714558a3327b7ad0b0ab0d3fdc7e770c3c75b
2017-11-20 07:39:09 +00:00
Jordan Pittier
74a56aba03 Doc: fix markups, capitalization and add 2 REVIEWING advices
I've been reading our entire documentation to see where it could
be improved. It's guide good actually. While reading I've fixed
some typos, added some capitalization to project names, mostly
trivial stuff.

What's worth reviewing is the 2 paragraphs I added to the REVIEWING
guidelines.

Change-Id: I977de335119f4ff7b9aedcfbed31c264ed531ea8
2017-07-11 20:26:32 +02:00
zhufl
cc0c048543 Remove the exception description of auth_version in doc
After I2601433585740030ab61433f0e8ca1a919275d9f is merged,
the exception description of auth_version is no longer
true, this is to remove it.

Change-Id: I5f9d8fb852faa92708158fca7d7bc7f5ac2fd933
2017-05-27 16:21:18 +08:00
Matthew Treinish
e8ab5f9b08
Add tempest test writing guide
This commit is the start of a new doc guide for helping people figure
out how to write good tempest tests. This is just a starting point for
the document and doesn't cover every aspect of writing a test case in
tempest. Right now it just covers the setupClass phase for writing
TestCases. It will be expanded upon in future commits to give a complete
guide to writing tests in Tempest.

Change-Id: Ie0db2079163f536ae72668c8fc9129ae4c6389e2
2017-04-03 11:53:35 -04:00
Hironori Shiina
91049ad85d Fix a few grammatical errors in docs
This patch fixes a few grammatical errors in documentation.

Change-Id: I5aa92537165aa452649f71e94d6d569011b78fa4
2016-09-28 17:28:49 +09:00
Jenkins
2a7f13b7d3 Merge "Remove non-locking accounts from the config guide" 2016-09-14 05:07:33 +00:00
Matthew Treinish
45915b0a39
Add doc section on expectations of clean tenants
Every few weeks we get people filing bugs because they're using creds
with pre-existing resources created in an accounts.yaml and list tests
start randomly failing. This adds documentation to say don't do that
because it breaks the isolation expectation of tests.

Change-Id: I6d31a8309d17c72748c4c6283fb6d014f7493463
2016-08-31 10:29:50 -04:00
Castulo J. Martinez
34329b546a Remove non-locking accounts from the config guide
Before Tempest had three different methods of providing authentication,
dynamic credentials, locking test accounts and non-locking test
accounts, currently only the first two are supported. This commit
updates a section on the configuration guide where it still mentions
three methods.

Change-Id: I532aff27a803b9fd34e994153f4183de48d91d00
Closes-Bug: 1600319
2016-07-08 10:56:52 -07:00
Jenkins
b15c5d5649 Merge "Use scope in v3 identity client" 2016-06-10 18:12:09 +00:00
Andrea Frittoli (andreaf)
100d18df69 Use scope in v3 identity client
Certain identity v3 API calls require a domain scoped token when
policy.v3cloudsample.json is used.
Introduce a new config flag to tell Tempest that keystone in the
targe cloud requires domain scoped tokens for admin actions.
Modify the v3 client managers used to obtain v3 admin identity
clients to request the domain scope when the flag is turned on.

Co-authored by: Roxana Gherle <roxana.gherle@hp.com>
Change-Id: I91ca907992428a5a14fb8d48a4fad105d2906e27
2016-06-09 00:24:09 +01:00
Matthew Treinish
275f178ab9
Cleanup wording and section for remote access config doc
This commit updates the wording and section separation for the remote
access section of the tempest configuration guide. Previously, the
details about using the validation group felt tacked on and out of
place. This attempts to correct that and make it clear what the
validation group is used for and how that's combined with the network
allocation.

Change-Id: I2f65d25e8f66944347f669dac14d77057a10975a
2016-06-07 12:23:58 -04:00
Masayuki Igawa
e63cf0fedf Fix docs errors and warnings
This commit fixes docs errors and warnings. However, 'WARNING: nonlocal
image URI found' is still remaining because it needs an ugly workaround
that is replacing it to raw html.

Change-Id: I4524c1ff4126c87979301d0fb8ac7c9eb6f2f708
2016-05-25 10:25:21 +09:00
Matthew Treinish
40847ac308
Remove deprecated legacy credentials provider
This commit removes the legacy credential provider. It's been
deprecated for over a full cycle which has been sufficient time for
users to migrate off of it. Keeping this around just causes more
confusion by having a 3rd path to configuring credentials in tempest.
The credential provider was officially marked as deprecated in change
Ia5132c5cb32355d6f26b8acdd92a0e55a2c19f41

Change-Id: I8c24cd17f643083dde71ab2bd2a38417c54aeccb
2016-05-20 18:32:15 -04:00
Andrea Frittoli (andreaf)
dd25070fb1 Update configuration docs wrt admin credentials
Configuration docs are slightly dated now wrt admin credentials
and credential configurations in general. Fixing that.

Change-Id: Id176202d73683ef3adbcd93a77d90be6a5206f37
2016-04-29 20:33:47 +00:00
Sean Dague
ed6e586b9f deprecate use of tenant in configs
OpenStack has settled (a very long time ago) on project to represent
the container which has users. We should make tempest configs always
use project versions of these names. This deprecates the old tenant
versions of these names, and makes project version the prefered
option.

Change-Id: Ied68c0326cf891a4e6eb3db51dc5f43241e4b8d2
2016-04-06 22:26:18 +01:00
lanoux
63bb903ce9 Update the docs on ssh validation
This change updates to configuration documentation on ssh validation.

Partially implements: blueprint ssh-auth-strategy

Change-Id: Ie6521d77b8ab3b61e7dfa140c7b395c06cf16eeb
2016-03-22 08:58:58 +00:00
John Warren
c276478e8f Add Identity v3 account configuration information
Updated documentation to include information about how to configure
Identity-v3-specific account settings using the Legacy Credentials
configuration options.

Change-Id: I55abf9629ed8f8436ce4497e9790feea05669407
2016-02-26 14:32:09 -05:00
Eric Fried
e0cfc3e4fd Typos and consistency in configuration.rst
This patch set updates the configuration.rst file to:

- Fix a few minor typographical and grammatical errors
- Make case consistent (e.g. "tempest" vs. "Tempest")
- Make style consistent (e.g. make references to config file keywords
  consistently monospace)
- Spell out numbers less than ten
- Fix a couple of minor content issues as suggested by @mtreinish.

No change in meaning or content is intended.

Change-Id: I5a23e2c39c57eec1e6dbc2a5a076b933c930f78e
2016-01-05 10:00:30 -06:00
Jenkins
17c65d144a Merge "Correct wrong message in configuration doc" 2016-01-05 10:14:06 +00:00
Felix Li
cf586102e6 Correct wrong message in configuration doc
In latest version, admin user infos are removed to auth section.
Correct this in the configuration doc

Change-Id: I75a605e025bb1ee8690455361e3efbc81ead8a55
2016-01-04 12:07:50 -05:00
Jenkins
7ffaf08a5f Merge "Add a note about using a full path for test accounts option" 2016-01-04 13:11:57 +00:00
Matthew Treinish
84c6d29085 Add a note about using a full path for test accounts option
This commit adds a note to the tempest configuration guide about
using a full path for the test accounts configuration option. Using
a relative path can result in the file not being found and things
failing.

Change-Id: I87901026b5865399469e5e20e5f8c6cf7336784a
2016-01-04 11:51:48 +00:00
Matthew Treinish
7715a38e3e Drop lock_path section from config guide
This commit drops the lock_path section from the tempest config guide.
Previously setting this was required there was no default value from
the oslo lib. However, tempest recently switched to overriding the
default to use the system temp dir. So additional configuration by the
end user should not be required here anymore.

Change-Id: Ia594745ad4d8e6b701c799cbf5ac5e555c598e3f
2015-12-17 16:16:38 +00:00
Jenkins
bf57df1c4f Merge "Factor up config dependent credential classes" 2015-11-18 13:55:20 +00:00
Andrea Frittoli (andreaf)
290b3e1383 Factor up config dependent credential classes
Separate helpers methods to build credentials, credential providers and
client managers that depend on configuration. They are all moved to
the common.credentials module to achieve two objectives:
- prepare credential provider module to move to tempest-lib
- avoid circular dependencies

There are still dependencies to CONF in the credential providers,
removing all of them would make the patch too large; but there is
with this patch a single place where all relevant CONF parameters can
be looked up and passed into the credential providers.

Partially-implements: bp tempest-library
Change-Id: I351f86f0570070105bbf24f2d904e917feea6e57
2015-11-13 11:08:54 +01: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
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
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
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
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
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
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
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
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