Merge "api-ref: cleanup os-server-groups 'policies' parameter description"

This commit is contained in:
Jenkins 2017-02-23 22:49:29 +00:00 committed by Gerrit Code Review
commit 4d33ec2954
2 changed files with 19 additions and 5 deletions

View File

@ -3558,11 +3558,20 @@ personality:
type: string
policies:
description: |
A list of one or more policy names to associate with the server group. The list
must contain at least one policy name. The current valid policy names are ``anti-affinity``
, ``affinity``, ``soft-anti-affinity`` and ``soft-affinity``, the latter two were
added in microversion 2.15. Each policy name must be a non-empty string with
no leading or trailing spaces. Maximum length is 255 characters.
A list of exactly one policy name to associate with the server group. The
current valid policy names are:
- ``anti-affinity`` - servers in this group must be scheduled to
different hosts.
- ``affinity`` - servers in this group must be scheduled to the same host.
- ``soft-anti-affinity`` - servers in this group should be scheduled to
different hosts if possible, but if not possible then they should still
be scheduled instead of resulting in a build failure. This policy was
added in microversion 2.15.
- ``soft-affinity`` - servers in this group should be scheduled to the same
host if possible, but if not possible then they should still be scheduled
instead of resulting in a build failure. This policy was added in
microversion 2.15.
in: body
required: true
type: array

View File

@ -26,6 +26,11 @@ create = {
'properties': {
'name': parameter_types.name,
'policies': {
# This allows only a single item and it must be one of the
# enumerated values. So this is really just a single string
# value, but for legacy reasons is an array. We could
# probably change the type from array to string with a
# microversion at some point but it's very low priority.
'type': 'array',
'items': [{'enum': ['anti-affinity', 'affinity']}],
'uniqueItems': True,