openstack
/
blazar
Code Issues Proposed changes

Add openstackclient command examples in CLI pages 

This adds examples next to the existing blazar command examples, for the
commands added implementing blueprint openstackclient-support.

Change-Id: I211de88f5d0f8f6fe54660c904692db975d663bd
This commit is contained in:
Mark Powers 2021-06-17 16:55:59 -05:00 committed by Pierre Riteau
parent 63d94170b5
commit 21c015264c
4 changed files with 81 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/source/cli/floatingip-reservation.rst
View File

@ -31,16 +31,24 @@ The floating IP plugin should be enabled in ``blazar.conf``:
.. sourcecode:: console
# Using the blazar CLI
blazar floatingip-create 81fabec7-00ae-497a-b485-72f4bf187d3e 172.24.4.2
# Using the openstack CLI
openstack reservation floatingip create 81fabec7-00ae-497a-b485-72f4bf187d3e 172.24.4.2
..
2. Check reservable floating IPs:
.. sourcecode:: console
# Using the blazar CLI
blazar floatingip-list
# Using the openstack CLI
openstack reservation floatingip list
..
Result:
@ -69,8 +77,12 @@ Result:
.. sourcecode:: console
# Using the blazar CLI
blazar lease-create --reservation 'resource_type=virtual:floatingip,network_id=81fabec7-00ae-497a-b485-72f4bf187d3e,amount=2,required_floatingips=["172.24.4.2","172.24.4.3"]' fip-lease
# Using the openstack CLI
openstack reservation lease create --reservation 'resource_type=virtual:floatingip,network_id=81fabec7-00ae-497a-b485-72f4bf187d3e,amount=2,required_floatingips=["172.24.4.2","172.24.4.3"]' fip-lease
..
Result:
@ -144,8 +156,11 @@ Result:
.. sourcecode:: console
# Using the blazar CLI
blazar lease-list
# Using the openstack CLI
openstack reservation lease list
..
Result:
@ -174,8 +189,12 @@ Result:
.. sourcecode:: console
# Using the blazar CLI
blazar lease-update --reservation 'id=e80033e6-5279-461d-9573-dec137233434,amount=3,required_floatingips=[]' fip-lease
# Using the openstack CLI
openstack reservation lease update --reservation 'id=e80033e6-5279-461d-9573-dec137233434,amount=3,required_floatingips=[]' fip-lease
..
Result:
@ -190,8 +209,12 @@ Result:
.. sourcecode:: console
# Using the openstack CLI
blazar lease-show fip-lease
# Using the openstack CLI
openstack reservation lease show fip-lease
..
Result:

29
doc/source/cli/host-reservation.rst
View File

@ -19,7 +19,11 @@ The following packages should be installed:
.. sourcecode:: console
blazar host-create compute-1
# Using the blazar CLI
blazar host-create compute-1
# Using the openstack CLI
openstack reservation host create compute-1
..
@ -27,7 +31,11 @@ The following packages should be installed:
.. sourcecode:: console
blazar host-list
# Using the blazar CLI
blazar host-list
# Using the openstack CLI
openstack reservation host list
..
@ -50,10 +58,19 @@ Result:
.. sourcecode:: console
blazar lease-create --physical-reservation min=1,max=1,hypervisor_properties='[">=", "$vcpus", "2"]' --start-date "2020-06-08 12:00" --end-date "2020-06-09 12:00" lease-1
# Using the blazar CLI
blazar lease-create --physical-reservation min=1,max=1,hypervisor_properties='[">=", "$vcpus", "2"]' --start-date "2020-06-08 12:00" --end-date "2020-06-09 12:00" lease-1
# Using the openstack CLI
openstack reservation lease create --reservation resource_type=physical:host,min=1,max=1,hypervisor_properties='[">=", "$vcpus", "2"]' --start-date "2020-06-08 12:00" --end-date "2020-06-09 12:00" lease-1
..
.. note::
The :code:`--physical-reservation` flag is not available in the openstack
client, instead use :code:`--reservation resource_type=physical:host` as
shown above.
Result:
.. sourcecode:: console
@ -90,7 +107,11 @@ Result:
.. sourcecode:: console
blazar lease-list
# Using the blazar CLI
blazar lease-list
# Using the openstack CLI
openstack reservation lease list
..

13
doc/source/cli/index.rst
View File

@ -7,3 +7,16 @@ Command-Line Interface Reference
host-reservation
instance-reservation
floatingip-reservation
Two command-line interfaces exist: one as a standalone ``blazar`` client and
another integrated with the ``openstack`` client. Examples are given for both
where applicable, as shown below:
.. sourcecode:: console
# Using the blazar CLI
blazar lease-list
# Using the openstack CLI
openstack reservation lease list
..

24
doc/source/cli/instance-reservation.rst
View File

@ -22,7 +22,11 @@ The following four scheduler filters should be configured in nova.conf:
.. sourcecode:: console
blazar host-create compute-1
# Using the blazar CLI
blazar host-create compute-1
# Using the openstack CLI
openstack reservation host create compute-1
..
@ -30,7 +34,11 @@ The following four scheduler filters should be configured in nova.conf:
.. sourcecode:: console
blazar host-list
# Using the blazar CLI
blazar host-list
# Using the openstack CLI
openstack reservation host list
..
@ -53,7 +61,11 @@ Result:
.. sourcecode:: console
blazar lease-create --reservation resource_type=virtual:instance,vcpus=1,memory_mb=1024,disk_gb=20,amount=1 --start-date "2020-07-24 20:00" --end-date "2020-08-09 21:00" lease-1
# Using the blazar CLI
blazar lease-create --reservation resource_type=virtual:instance,vcpus=1,memory_mb=1024,disk_gb=20,amount=1 --start-date "2020-07-24 20:00" --end-date "2020-08-09 21:00" lease-1
# Using the openstack CLI
openstack reservation lease create --reservation resource_type=virtual:instance,vcpus=1,memory_mb=1024,disk_gb=20,amount=1 --start-date "2020-07-24 20:00" --end-date "2020-08-09 21:00" lease-1
..
@ -98,7 +110,11 @@ Result:
.. sourcecode:: console
blazar lease-list
# Using the blazar CLI
blazar lease-list
# Using the openstack CLI
openstack reservation lease list
..