openstack/blazar
Code Issues Proposed changes

Merge "Adapt documentation structure to the new standard"

Browse Source
This commit is contained in:
Zuul 2017-11-15 04:20:57 +00:00 committed by Gerrit Code Review
commit 9a08d37e5c
33 changed files with 379 additions and 199 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -24,17 +24,19 @@ Please see the following resources to learn more.
API
---
See `Blazar API reference <http://blazar.readthedocs.io/en/latest/restapi/rest_api_v1.0.html>`__.
See `Blazar API reference <https://docs.openstack.org/blazar/latest/restapi/>`__.
Operators
---------
To learn how to deploy and configure Blazar, see `the installation guide <http://blazar.readthedocs.io/en/latest/userdoc/installation.guide.html>`__.
To learn how to deploy and configure Blazar,
see `the installation guide <https://docs.openstack.org/blazar/latest/install/>`__
and `the configuration reference <https://docs.openstack.org/blazar/latest/configuration/>`__.
Developers
----------
To learn how to contribute to Blazar, see `the contribution guide <http://blazar.readthedocs.io/en/latest/devref/how.to.contribute.html>`__.
To learn how to contribute to Blazar, see `the contributor guide <https://docs.openstack.org/blazar/latest/contributor/>`__.
Other Resources
---------------
@ -47,4 +49,4 @@ Other Resources
* `Dashboard (Horizon plugin) <https://git.openstack.org/cgit/openstack/blazar-dashboard>`__
* Blueprints/Bugs: https://launchpad.net/blazar
* Documentation: https://blazar.readthedocs.io/en/latest/
* Documentation: https://docs.openstack.org/blazar/latest/

11
doc/source/admin/index.rst Normal file
View File

@ -0,0 +1,11 @@
===================
Administrator Guide
===================
.. toctree::
:maxdepth: 2
../install/index
../configuration/index
../cli/index
../restapi/index

1
doc/source/architecture.rst
View File

@ -1,3 +1,4 @@
====================
Blazar architecture
====================

49
doc/source/userdoc/using.host-reservation.rst → doc/source/cli/host-reservation.rst
View File

@ -1,14 +1,15 @@
Using Host Reservation
======================
================
Host Reservation
================
Prerequisites
-------------
The following packages should be installed:
* blazar
* blazar-nova
* python-blazarclient
* blazar
* blazar-nova
* python-blazarclient
1. Add hosts into the freepool
@ -16,21 +17,23 @@ The following packages should be installed:
1. Add hosts into the Blazar freepool using the host-create command:
.. sourcecode:: console
.. sourcecode:: console
blazar host-create compute-1
..
..
2. Check hosts in the freepool:
.. sourcecode:: console
.. sourcecode:: console
blazar host-list
..
..
Result::
Result:
.. sourcecode:: console
+----+---------------------+-------+-----------+----------+
| id | hypervisor_hostname | vcpus | memory_mb | local_gb |
@ -38,19 +41,22 @@ The following packages should be installed:
| 1 | compute-1 | 2 | 3951 | 38 |
+----+---------------------+-------+-----------+----------+
..
2. Create a lease
-----------------
1. Create a lease (compute host reservation) using lease-create command:
.. sourcecode:: console
.. 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
..
..
Result::
Result:
.. sourcecode:: console
+---------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| Field | Value |
@ -78,15 +84,20 @@ The following packages should be installed:
| user_id | |
+---------------+---------------------------------------------------------------------------------------------------------------------------------------------+
..
2. Check leases:
.. sourcecode:: console
.. sourcecode:: console
blazar lease-list
..
..
Result::
Result:
.. sourcecode:: console
+--------------------------------------+---------+----------------------------+----------------------------+
| id | name | start_date | end_date |
@ -94,13 +105,15 @@ The following packages should be installed:
| 6638c31e-f6c8-4982-9b98-d2ca0a8cb646 | lease-1 | 2020-06-08T12:00:00.000000 | 2020-06-09T12:00:00.000000 |
+--------------------------------------+---------+----------------------------+----------------------------+
..
3. Use the leased resources
---------------------------
1. Create a server: Please specify the reservation id as a scheduler hint.
.. sourcecode:: console
.. sourcecode:: console
openstack server create --flavor <flavor> --image <image> --network <network> --hint reservation=4d3dd68f-0e3f-4f6b-bef7-617525c74ccb <server-name>
..
..

8
doc/source/cli/index.rst Normal file
View File

@ -0,0 +1,8 @@
================================
Command-Line Interface Reference
================================
.. toctree::
host-reservation
instance-reservation

66
doc/source/userdoc/using.instance-reservation.rst → doc/source/cli/instance-reservation.rst
View File

@ -1,42 +1,45 @@
Using Instance Reservation
==========================
====================
Instance Reservation
====================
Prerequisites
-------------
The following packages should be installed:
* blazar
* blazar-nova
* python-blazarclient
* blazar
* blazar-nova
* python-blazarclient
The following four scheduler filters should be configured in nova.conf:
* AggregateInstanceExtraSpecsFilter
* AggregateMultiTenancyIsolation
* ServerGroupAffinityFilter
* BlazarFilter
* AggregateInstanceExtraSpecsFilter
* AggregateMultiTenancyIsolation
* ServerGroupAffinityFilter
* BlazarFilter
1. Add hosts into the freepool
------------------------------
1. Add hosts into the Blazar freepool using the host-create command:
.. sourcecode:: console
.. sourcecode:: console
blazar host-create compute-1
..
..
2. Check hosts in the freepool:
.. sourcecode:: console
.. sourcecode:: console
blazar host-list
..
..
Result::
Result:
.. sourcecode:: console
+----+---------------------+-------+-----------+----------+
| id | hypervisor_hostname | vcpus | memory_mb | local_gb |
@ -44,19 +47,22 @@ The following four scheduler filters should be configured in nova.conf:
| 1 | compute-1 | 2 | 3951 | 38 |
+----+---------------------+-------+-----------+----------+
..
2. Create a lease
-----------------
1. Create a lease (instance reservation) using lease-create command:
.. sourcecode:: console
.. sourcecode:: console
blazar lease-create --reservation resource_type=virtual:instance,vcpus=1,memory_mb=1024,disk_gb=20,amount=1,affinity=False --start-date "2020-07-24 20:00" --end-date "2020-08-09 21:00" lease-1
..
..
Result::
Result:
.. sourcecode:: console
+---------------+--------------------------------------------------------------------------------------------------------------------------+
| Field | Value |
@ -89,15 +95,19 @@ The following four scheduler filters should be configured in nova.conf:
| user_id | |
+---------------+--------------------------------------------------------------------------------------------------------------------------+
..
2. Check leases:
.. sourcecode:: console
.. sourcecode:: console
blazar lease-list
..
..
Result::
Result:
.. sourcecode:: console
+--------------------------------------+---------+----------------------------+----------------------------+
| id | name | start_date | end_date |
@ -105,18 +115,22 @@ The following four scheduler filters should be configured in nova.conf:
| becf2f3b-0177-4c0f-a7e7-0123370849a3 | lease-1 | 2020-07-24T20:00:00.000000 | 2020-08-09T21:00:00.000000 |
+--------------------------------------+---------+----------------------------+----------------------------+
..
3. Use the leased resources
---------------------------
While the reservation you created is active you can see and use the flavor of your reservation.
.. sourcecode:: condole
.. sourcecode:: console
openstack flavor list
..
..
Result::
Result:
.. sourcecode:: console
+--------------------------------------+--------------------------------------------------+-----------+------+-----------+------+-------+-------------+-----------+
| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public |
@ -134,10 +148,12 @@ While the reservation you created is active you can see and use the flavor of yo
| db83d6fd-c69c-4259-92cf-012db2e55a58 | reservation:db83d6fd-c69c-4259-92cf-012db2e55a58 | 1024 | 20 | 0 | | 1 | 1.0 | False |
+--------------------------------------+--------------------------------------------------+-----------+------+-----------+------+-------+-------------+-----------+
..
1. Create a server: Please specify the flavor of the reservation and group_id as a scheduler hint.
.. sourcecode:: console
.. sourcecode:: console
openstack server create --flavor db83d6fd-c69c-4259-92cf-012db2e55a58 --image <image> --network <network> --hint group=ba03ebb4-e55c-4da4-9d39-87e13354f3b7 <server-name>
..
..

6
doc/source/conf.py
View File

@ -37,6 +37,8 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'wsmeext.sphinxext',
'openstackdocstheme',
'oslo_config.sphinxext',
'oslo_config.sphinxconfiggen',
]
# openstackdocstheme options
@ -44,6 +46,10 @@ repository_name = 'openstack/blazar'
bug_project = 'blazar'
bug_tag = ''
# oslo_config.sphinxconfiggen options
config_generator_config_file = '../../etc/blazar/blazar-config-generator.conf'
sample_config_basename = '_static/blazar'
wsme_protocols = ['restjson', 'restxml']
# The suffix of source filenames.

6
doc/source/configuration/blazar-conf.rst Normal file
View File

@ -0,0 +1,6 @@
===========
blazar.conf
===========
.. show-options::
:config-file: etc/blazar/blazar-config-generator.conf

5
doc/source/configuration/blazar-policy.rst Normal file
View File

@ -0,0 +1,5 @@
========
Policies
========
Please see a sample policy file: :doc:`/configuration/samples/blazar-policy`.

39
doc/source/configuration/index.rst Normal file
View File

@ -0,0 +1,39 @@
==============================
Blazar Configuration Reference
==============================
Configuration
-------------
Reference
^^^^^^^^^
.. toctree::
blazar-conf.rst
nova-conf.rst
Sample Files
^^^^^^^^^^^^
.. toctree::
samples/blazar-conf.rst
Policy
------
Reference
^^^^^^^^^
.. toctree::
blazar-policy.rst
Sample Files
^^^^^^^^^^^^
.. toctree::
samples/blazar-policy.rst

14
doc/source/configuration/nova-conf.rst Normal file
View File

@ -0,0 +1,14 @@
=========
nova.conf
=========
Please add the following lines to the nova.conf configuration file:
.. sourcecode:: console
[filter_scheduler]
available_filters = nova.scheduler.filters.all_filters
available_filters = blazarnova.scheduler.filters.blazar_filter.BlazarFilter
enabled_filters=RetryFilter,AvailabilityZoneFilter,RamFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,AggregateInstanceExtraSpecsFilter,AggregateMultiTenancyIsolation,ServerGroupAntiAffinityFilter,BlazarFilter
..

7
doc/source/configuration/samples/blazar-conf.rst Normal file
View File

@ -0,0 +1,7 @@
==================
Sample blazar.conf
==================
The following is a sample blazar configuration.
.. literalinclude:: ../../_static/blazar.conf.sample

7
doc/source/configuration/samples/blazar-policy.rst Normal file
View File

@ -0,0 +1,7 @@
==================
Sample Policy File
==================
The following is a sample policy file.
.. literalinclude:: ../../../../etc/policy.json

29
doc/source/devref/how.to.contribute.rst → doc/source/contributor/contribution.rst
View File

@ -1,3 +1,4 @@
=================
How to contribute
=================
@ -9,7 +10,7 @@ Getting started
* Login to `OpenStack Gerrit <https://review.openstack.org/>`_ using your
Launchpad ID
* Sign up your `OpenStack Individual Contributor License Agreement
* Sign the `OpenStack Individual Contributor License Agreement
<https://review.openstack.org/#/settings/agreements>`_
* Check that your email is listed in `Gerrit identities
<https://review.openstack.org/#/settings/web-identities>`_
@ -17,7 +18,8 @@ Getting started
* Subscribe to Blazar-related projects on
`OpenStack Gerrit <https://review.openstack.org/>`_. Go to your
settings and in the watched projects add *openstack/blazar*,
*openstack/blazar-nova* and *openstack/python-blazarclient*
*openstack/blazar-nova*, *openstack/python-blazarclient* and
*openstack/blazar-dashboard*.
As all bugs/blueprints are listed in `Blazar Launchpad
<https://launchpad.net/blazar/>`_, you may keep track on them and choose some
@ -26,26 +28,27 @@ to work on.
How to keep in touch with community
-----------------------------------
* If you're not subscribed to `OpenStack general mailing list
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack>`_ or to
* If you're not yet subscribed to the `OpenStack general mailing list
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack>`_ or to the
`OpenStack development mailing list
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>`_, do
that. Blazar-related emails must be send with **[blazar]** in its subject
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>`_, please
do. Blazar-related emails must be send with **[blazar]** in the subject.
* All questions may be asked on our IRC channel #openstack-blazar on
`freenode <http://freenode.net>`_
`freenode <http://freenode.net>`_.
* We also have weekly meetings on #openstack-meeting-alt. Please check
`meeting details <https://wiki.openstack.org/wiki/Meetings/Blazar>`_
`meeting details <https://wiki.openstack.org/wiki/Meetings/Blazar>`_.
Your first commit to Blazar
----------------------------
* Read the `OpenStack development workflow documentation
<https://docs.openstack.org/infra/manual/developers.html#development-workflow>`_
* Checkout corresponding Blazar repository:
* Clone the corresponding Blazar repository:
`blazar <https://git.openstack.org/openstack/blazar>`_,
`blazar-nova <https://git.openstack.org/openstack/blazar-nova>`_,
`client <https://git.openstack.org/openstack/python-blazarclient>`_
`client <https://git.openstack.org/openstack/python-blazarclient>`_,
`blazar-dashboard <https://git.openstack.org/openstack/blazar-dashboard>`_
* Apply and commit your changes
* Make sure all code checkings and tests have passed
* Send your patch to the review
* Monitor status of your change on https://review.openstack.org/#/
* Make sure all code checks and tests have passed
* Send your patch for review
* Monitor the status of your change on https://review.openstack.org/

16
doc/source/devref/development.guidelines.rst → doc/source/contributor/development.rst
View File

@ -1,10 +1,11 @@
======================
Development guidelines
======================
Coding Guidelines
-----------------
`PEP8 <http://legacy.python.org/dev/peps/pep-0008/>`_ checking should pass for
`PEP8 <http://legacy.python.org/dev/peps/pep-0008/>`_ checks should pass for
all Blazar code. You may check it using the following command:
.. sourcecode:: console
@ -13,7 +14,7 @@ all Blazar code. You may check it using the following command:
..
Also you should keep your code clear using more code style checkings via
Also you should keep your code clear using more code style checks via
`pylint <http://www.pylint.org>`_:
.. sourcecode:: console
@ -22,8 +23,8 @@ Also you should keep your code clear using more code style checkings via
..
If you see any pep8/pylint errors in your code, it's mandatory to fix them
before sending your change on review.
If you see any pep8/pylint errors in your code, it is mandatory to fix them
before sending your change for review.
Testing Guidelines
------------------
@ -43,7 +44,7 @@ via the commands:
..
for Python 2.7, Python 3.4, and Python 3.5 accordingly.
for Python 2.7 and Python 3.5 accordingly.
Note that the Blazar code base is not yet compatible with Python 3, so tests
will be failing.
@ -66,6 +67,5 @@ To build Sphinx / RST docs locally run the following command:
..
After it you can access generated docs in *doc/build/* directory, for example,
main page - *doc/build/html/index.html*.
Then you can access generated docs in the *doc/build/* directory, for example,
the main page would be *doc/build/html/index.html*.

8
doc/source/contributor/index.rst Normal file
View File

@ -0,0 +1,8 @@
=================
Contributor Guide
=================
.. toctree::
contribution
development

86
doc/source/index.rst
View File

@ -1,5 +1,5 @@
Welcome to Blazar!
===================
Blazar, the OpenStack Reservation Service
=========================================
Blazar is an OpenStack service to provide resource reservations in the
OpenStack cloud for different resource types - both virtual (instances,
@ -14,47 +14,55 @@ Overview
introduction
architecture
User guide
----------
**Installation**
.. toctree::
:maxdepth: 1
userdoc/installation.guide
**APIs**
.. toctree::
:maxdepth: 1
restapi/index
**Using Blazar**
.. toctree::
:maxdepth: 1
userdoc/using.host-reservation
userdoc/using.instance-reservation
Development guide
-----------------
.. toctree::
:maxdepth: 1
devref/how.to.contribute
devref/development.guidelines
Installation Guide
------------------
.. toctree::
:maxdepth: 2
devref/spec
install/index
Release note
------------
Configuration Reference
-----------------------
.. toctree::
:maxdepth: 2
`Release note <https://wiki.openstack.org/wiki/Blazar/Release_Notes>`_
configuration/index
CLI Reference
-------------
.. toctree::
:maxdepth: 2
cli/index
API Reference
-------------
.. toctree::
:maxdepth: 2
restapi/index
For Contributors
----------------
.. toctree::
:maxdepth: 2
contributor/index
Specs
-----
.. toctree::
:maxdepth: 2
specs/index
Indices and tables
------------------
* :ref:`genindex`
* :ref:`search`

8
doc/source/install/index.rst Normal file
View File

@ -0,0 +1,8 @@
=========================
Blazar Installation Guide
=========================
.. toctree::
install-using-devstack.rst
install-without-devstack.rst

57
doc/source/install/install-using-devstack.rst Normal file
View File

@ -0,0 +1,57 @@
===========================
Installation using DevStack
===========================
This section includes instructions for Blazar installation using DevStack.
DevStack configures both the host reservation and the instance reservation.
1. Download DevStack:
.. sourcecode:: console
git clone https://git.openstack.org/openstack-dev/devstack.git
..
2. Create a local.conf file in the devstack directory. You can use the
following sample local.conf:
.. sourcecode:: console
[[local|localrc]]
ADMIN_PASSWORD=password
DATABASE_PASSWORD=$ADMIN_PASSWORD
RABBIT_PASSWORD=$ADMIN_PASSWORD
SERVICE_PASSWORD=$ADMIN_PASSWORD
DEST=/opt/stack/
LOGFILE=$DEST/logs/stack.sh.log
HOST_IP=127.0.0.1
GIT_BASE=https://git.openstack.org/
RECLONE=yes
enable_plugin blazar https://git.openstack.org/openstack/blazar
..
3. Run DevStack as the stack user:
.. sourcecode:: console
./stack.sh
..
4. Source the admin credentials:
.. sourcecode:: console
. openrc admin admin
..
5. Now you can add hosts to Blazar:
.. sourcecode:: console
blazar host-create hostname
..

66
doc/source/userdoc/installation.guide.rst → doc/source/install/install-without-devstack.rst
View File

@ -1,60 +1,4 @@
Installation using DevStack
===========================
This section includes instructions for Blazar installation using DevStack.
DevStack configures both the host reservation and the instance reservation.
1. Download DevStack:
.. sourcecode:: console
git clone https://git.openstack.org/openstack-dev/devstack.git
..
2. Create a local.conf file in the devstack directory. You can use the
following sample local.conf:
.. sourcecode:: console
[[local|localrc]]
ADMIN_PASSWORD=password
DATABASE_PASSWORD=$ADMIN_PASSWORD
RABBIT_PASSWORD=$ADMIN_PASSWORD
SERVICE_PASSWORD=$ADMIN_PASSWORD
DEST=/opt/stack/
LOGFILE=$DEST/logs/stack.sh.log
HOST_IP=127.0.0.1
GIT_BASE=https://git.openstack.org/
RECLONE=yes
enable_plugin blazar https://git.openstack.org/openstack/blazar
..
3. Run DevStack as the stack user:
.. sourcecode:: console
./stack.sh
..
4. Source the admin credentials:
.. sourcecode:: console
. openrc admin admin
..
5. Now you can add hosts to Blazar:
.. sourcecode:: console
blazar host-create hostname
..
=============================
Installation without DevStack
=============================
@ -157,9 +101,10 @@ Next you need to configure Nova. Please add the following lines to nova.conf fil
.. sourcecode:: console
scheduler_available_filters = nova.scheduler.filters.all_filters
scheduler_available_filters = blazarnova.scheduler.filters.blazar_filter.BlazarFilter
scheduler_default_filters=RetryFilter,AvailabilityZoneFilter,RamFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,AggregateInstanceExtraSpecsFilter,AggregateMultiTenancyIsolation,ServerGroupAntiAffinityFilter,BlazarFilter
[filter_scheduler]
available_filters = nova.scheduler.filters.all_filters
available_filters = blazarnova.scheduler.filters.blazar_filter.BlazarFilter
enabled_filters=RetryFilter,AvailabilityZoneFilter,RamFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,AggregateInstanceExtraSpecsFilter,AggregateMultiTenancyIsolation,ServerGroupAntiAffinityFilter,BlazarFilter
..
@ -213,4 +158,3 @@ To start Blazar services use:
..
Now you can use python-blazarclient to communicate with Blazar.

1
doc/source/introduction.rst
View File

@ -1,3 +1,4 @@
============
Introduction
============

5
doc/source/reference/index.rst Normal file
View File

@ -0,0 +1,5 @@
==========
References
==========
None

32
doc/source/restapi/rest_api_v1.0.rst → doc/source/restapi/api-v1.rst
View File

@ -1,9 +1,9 @@
====================
Blazar REST API v1.0
*********************
====================
1 General API information
=========================
-------------------------
This section contains base information about the Blazar REST API design,
including operations with different Blazar resource types and examples of
@ -27,7 +27,7 @@ or
2 Leases
========
--------
**Description**
@ -52,7 +52,7 @@ are mentioned.
+--------+-----------------------+-------------------------------------------------------------------------------+
2.1 List all leases
-------------------
^^^^^^^^^^^^^^^^^^^
.. http:get:: /v1/leases
@ -141,7 +141,7 @@ are mentioned.
}
2.2 Create new lease
--------------------
^^^^^^^^^^^^^^^^^^^^
.. http:post:: /v1/leases
@ -250,7 +250,7 @@ are mentioned.
2.3 Show info about lease
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^
.. http:get:: /v1/leases/{lease_id}
@ -338,7 +338,7 @@ are mentioned.
}
2.4 Update existing lease
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^
.. http:put:: /v1/leases/{lease_id}
@ -439,7 +439,7 @@ are mentioned.
}
2.5 Delete existing lease
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^
.. http:delete:: /v1/leases/{lease_id}
@ -462,7 +462,7 @@ are mentioned.
3 Hosts
=======
-------
**Description**
@ -493,7 +493,7 @@ user query.
+--------+------------------------+---------------------------------------------------------------------------------+
3.1 List all hosts
------------------
^^^^^^^^^^^^^^^^^^
.. http:get:: /v1/os-hosts
@ -569,7 +569,7 @@ user query.
}
3.2 Create host
---------------
^^^^^^^^^^^^^^^
.. http:post:: /v1/os-hosts
@ -628,7 +628,7 @@ user query.
}
3.3 Show info about host
------------------------
^^^^^^^^^^^^^^^^^^^^^^^^
.. http:get:: /v1/os-hosts/{host_id}
@ -681,7 +681,7 @@ user query.
}
3.4 Update existing host
------------------------
^^^^^^^^^^^^^^^^^^^^^^^^
.. http:put:: /v1/os-hosts/{host_id}
@ -737,7 +737,7 @@ user query.
}
3.5 Delete existing host
------------------------
^^^^^^^^^^^^^^^^^^^^^^^^
.. http:delete:: /v1/os-hosts/{host_id}
@ -759,7 +759,7 @@ user query.
Content-Type: application/json
4 Plugins
=========
---------
**Description**

12
doc/source/restapi/rest_api_v2.rst → doc/source/restapi/api-v2.rst
View File

@ -1,9 +1,11 @@
Blazar REST API v2
*********************
===============================
Blazar REST API v2 (deprecated)
===============================
**NOTE**: This version is deprecated. Please use the Blazar REST API v1.
1 General API information
=========================
-------------------------
This section contains base information about the Blazar REST API design,
including operations with different Blazar resource types and examples of
@ -27,7 +29,7 @@ or
2 Leases
=======
--------
**Description**
@ -43,7 +45,7 @@ are mentioned.
3 Hosts
=======
-------
**Description**

9
doc/source/restapi/index.rst
View File

@ -1,10 +1,9 @@
====================
Blazar REST API docs
*********************
This page includes documentation for Blazar APIs.
====================
.. toctree::
:maxdepth: 1
rest_api_v1.0
rest_api_v2
api-v1
api-v2

5
doc/source/devref/spec.rst → doc/source/specs/index.rst
View File

@ -1,3 +1,4 @@
============
Blazar Specs
============
@ -11,7 +12,7 @@ This section has a list of specs for Queens release.
:maxdepth: 1
:glob:
specs/queens/*
queens/*
Pike
----
@ -23,4 +24,4 @@ This section has a list of specs for Pike release.
:maxdepth: 1
:glob:
specs/pike/*
pike/*

6
doc/source/devref/specs/pike/new-instance-reservation.rst → doc/source/specs/pike/new-instance-reservation.rst
View File

@ -355,7 +355,7 @@ Request Example:
"memory_mb": 4096,
"disk_gb": 10,
"amount": 5,
"affinity": False
"affinity": false
}
],
"start": "2017-05-17 09:07"
@ -369,7 +369,7 @@ Response Example:
.. sourcecode:: json
{
"leases": {
"lease": {
"reservations": [
{
"id": "reservation-id",
@ -381,7 +381,7 @@ Response Example:
"memory_mb": 4096,
"disk_gb": 10,
"amount": 5,
"affinity": False,
"affinity": false,
"created_at": "2017-05-01 10:00:00",
"updated_at": "2017-05-01 11:00:00",
}],

0
doc/source/devref/specs/pike/on-end-options.rst → doc/source/specs/pike/on-end-options.rst
View File

0
doc/source/devref/specs/pike/pike-template.rst → doc/source/specs/pike/pike-template.rst
View File

0
doc/source/devref/specs/pike/terminate-lease-at-anytime.rst → doc/source/specs/pike/terminate-lease-at-anytime.rst
View File

0
doc/source/devref/specs/pike/update-reserved-capacity.rst → doc/source/specs/pike/update-reserved-capacity.rst
View File

0
doc/source/devref/specs/queens/queens-template.rst → doc/source/specs/queens/queens-template.rst
View File

9
doc/source/user/index.rst Normal file
View File

@ -0,0 +1,9 @@
==========
User Guide
==========
.. toctree::
:maxdepth: 2
../cli/index
../restapi/index