openstack/octavia
Code Issues Proposed changes

Merge "Add availability-zone to loadbalancer object docs"

Browse Source
This commit is contained in:
Zuul 2020-04-09 13:04:27 +00:00 committed by Gerrit Code Review
commit ee30c1f7c9
10 changed files with 34 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api-ref/source/parameters.yaml
View File

@ -232,12 +232,6 @@ api_version_status:
in: body
required: true
type: string
availability-zone:
description: |
An availability zone object.
in: body
required: true
type: object
availability-zone-capabilities:
description: |
The provider availability zone capabilities dictonary object.
@ -268,6 +262,18 @@ availability-zone-data-optional:
in: body
required: false
type: string
availability-zone-name:
description: |
An availability zone name.
in: body
required: true
type: object
availability-zone-name-optional:
description: |
An availability zone name.
in: body
required: false
type: object
availability-zone-profile:
description: |
An ``availability zone profile`` object.
@ -292,6 +298,12 @@ availability-zones:
in: body
required: true
type: array
availability_zone:
description: |
An availability zone object.
in: body
required: true
type: object
backup:
description: |
Is the member a backup? Backup members only receive traffic when all

10
api-ref/source/v2/availabilityzone.inc
View File

@ -91,7 +91,7 @@ Request
- description: description-optional
- enabled: enabled-optional
- availability_zone: availability-zone
- availability_zone: availability_zone
- availability_zone_profile_id: availability-zone-profile-id
- name: name
@ -115,7 +115,7 @@ Response Parameters
- description: description
- enabled: enabled
- availability_zone_profile_id: availability-zone-profile-id
- availability_zone: availability-zone
- availability_zone: availability_zone
- name: name
Response Example
@ -172,7 +172,7 @@ Response Parameters
- description: description
- enabled: enabled
- availability_zone_profile_id: availability-zone-profile-id
- availability_zone: availability-zone
- availability_zone: availability_zone
- name: name
Response Example
@ -212,7 +212,7 @@ Request
- description: description-optional
- enabled: enabled-optional
- availability_zone: availability-zone
- availability_zone: availability_zone
- availability_zone_name: path-availability-zone-name
Request Example
@ -235,7 +235,7 @@ Response Parameters
- description: description
- enabled: enabled
- availability_zone_profile_id: availability-zone-profile-id
- availability_zone: availability-zone
- availability_zone: availability_zone
- name: name
Response Example

2
api-ref/source/v2/examples/loadbalancer-create-curl
View File

@ -1 +1 @@
curl -X POST -H "Content-Type: application/json" -H "X-Auth-Token: <token>" -d '{"loadbalancer": {"description": "My favorite load balancer", "admin_state_up": true, "project_id": "e3cd678b11784734bc366148aa37580e", "flavor_id": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04", "vip_subnet_id": "d4af86e1-0051-488c-b7a0-527f97490c9a", "vip_address": "203.0.113.50", "provider": "octavia", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", "tags": ["test_tag"]}}' http://198.51.100.10:9876/v2/lbaas/loadbalancers
curl -X POST -H "Content-Type: application/json" -H "X-Auth-Token: <token>" -d '{"loadbalancer": {"description": "My favorite load balancer", "admin_state_up": true, "project_id": "e3cd678b11784734bc366148aa37580e", "flavor_id": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04", "vip_subnet_id": "d4af86e1-0051-488c-b7a0-527f97490c9a", "vip_address": "203.0.113.50", "provider": "octavia", "name": "best_load_balancer", "vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3", "availability_zone": "my_az", "tags": ["test_tag"]}}' http://198.51.100.10:9876/v2/lbaas/loadbalancers

1
api-ref/source/v2/examples/loadbalancer-create-request.json
View File

@ -8,6 +8,7 @@
"provider": "octavia",
"name": "best_load_balancer",
"vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3",
"availability_zone": "my_az",
"tags": ["test_tag"]
}
}

1
api-ref/source/v2/examples/loadbalancer-create-response.json
View File

@ -16,6 +16,7 @@
"operating_status": "OFFLINE",
"name": "best_load_balancer",
"vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3",
"availability_zone": "my_az",
"tags": ["test_tag"]
}
}

1
api-ref/source/v2/examples/loadbalancer-full-create-request.json
View File

@ -85,6 +85,7 @@
"provider": "octavia",
"name": "best_load_balancer",
"vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3",
"availability_zone": "my_az",
"tags": ["test_tag"]
}
}

1
api-ref/source/v2/examples/loadbalancer-full-create-response.json
View File

@ -175,6 +175,7 @@
"operating_status": "ONLINE",
"name": "best_load_balancer",
"vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3",
"availability_zone": "my_az",
"tags": ["test_tag"]
}
}

1
api-ref/source/v2/examples/loadbalancer-show-response.json
View File

@ -16,6 +16,7 @@
"operating_status": "ONLINE",
"name": "best_load_balancer",
"vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3",
"availability_zone": "my_az",
"tags": []
}
}

1
api-ref/source/v2/examples/loadbalancers-list-response.json
View File

@ -27,6 +27,7 @@
"operating_status": "ONLINE",
"name": "best_load_balancer",
"vip_qos_policy_id": "ec4f78ca-8da8-4e99-8a1a-e3b94595a7a3",
"availability_zone": "my_az",
"tags": []
}
]

4
api-ref/source/v2/loadbalancer.inc
View File

@ -46,6 +46,7 @@ Response Parameters
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up
- availability_zone: availability-zone-name
- created_at: created_at
- description: description
- flavor_id: flavor-id
@ -162,6 +163,7 @@ Request
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up-default-optional
- availability_zone: availability-zone-name-optional
- description: description-optional
- flavor_id: flavor-id-optional
- listeners: listeners-optional
@ -194,6 +196,7 @@ Response Parameters
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up
- availability_zone: availability-zone-name
- created_at: created_at
- description: description
- flavor_id: flavor-id
@ -287,6 +290,7 @@ Response Parameters
.. rest_parameters:: ../parameters.yaml
- admin_state_up: admin_state_up
- availability_zone: availability-zone-name
- created_at: created_at
- description: description
- flavor_id: flavor-id