Renamed Climate references to Blazar in the docs

References to climate in the docs have been renamed to blazar reflect the new name and enable uploadig docs to readthedocs. Also updated the docs to reference the new architecture image.

Change-Id: I594849afb6268892a03cc716a1707dcde835fa52
Closes-Bug: 1324581
This commit is contained in:
Harsh Shah 2014-06-27 12:43:20 -07:00
parent c90faabb04
commit 12547fec67
17 changed files with 103 additions and 107 deletions

View File

@ -1,11 +1,11 @@
Climate Style Commandments
Blazar Style Commandments
==========================
- Step 1: Read the OpenStack Style Commandments
http://docs.openstack.org/developer/hacking/
- Step 2: Read on
Climate Specific Commandments
Blazar Specific Commandments
-----------------------------
None so far

View File

@ -1,4 +1,4 @@
Climate
Blazar
=======
Overview

View File

@ -2,17 +2,17 @@
Devstack Integration
====================
This directory contains the files necessary to integrate Climate with devstack.
This directory contains the files necessary to integrate Blazar with devstack.
To install:
$ DEVSTACK_DIR=.../path/to/devstack
$ cp lib/climate ${DEVSTACK_DIR}/lib
$ cp extras.d/70-climate.sh ${DEVSTACK_DIR}/extras.d
$ cp lib/blazar ${DEVSTACK_DIR}/lib
$ cp extras.d/70-blazar.sh ${DEVSTACK_DIR}/extras.d
To configure devstack to run climate:
To configure devstack to run blazar:
$ cd ${DEVSTACK_DIR}
$ echo "enable_service climate" >> localrc
$ echo "enable_service climate-a" >> localrc
$ echo "enable_service climate-m" >> localrc
$ echo "enable_service blazar" >> localrc
$ echo "enable_service blazar-a" >> localrc
$ echo "enable_service blazar-m" >> localrc

View File

@ -1,23 +1,23 @@
This directory contains the files necessary for tempest to cover Climate project.
This directory contains the files necessary for tempest to cover Blazar project.
To install:
$ TEMPEST_DIR=/path/to/tempest
$ CLIMATE_DIR=/path/to/climate
$ cp -R ${CLIMATE_DIR}/contrib/tempest/tempest/* ${TEMPEST_DIR}/tempest/
$ BLAZAR_DIR=/path/to/blazar
$ cp -R ${BLAZAR_DIR}/contrib/tempest/tempest/* ${TEMPEST_DIR}/tempest/
For example:
$ cp -R /opt/stack/climate/contrib/tempest/tempest/* /opt/stack/tempest/tempest/
$ cp -R /opt/stack/blazar/contrib/tempest/tempest/* /opt/stack/tempest/tempest/
To run all the climate tests, add the following to the tox.ini file located at TEMPEST_DIR:
To run all the blazar tests, add the following to the tox.ini file located at TEMPEST_DIR:
[testenv:climate]
[testenv:blazar]
sitepackages = True
commands =
bash tools/pretty_tox.sh '(^tempest\.(api|scenario|thirdparty|cli)\.test_resource_reservation) {posargs}'
Then, inside the TEMPEST_DIR, run:
$ tox -eclimate
$ tox -eblazar
To debug tests with pdb or ipdb debuggers, run the following:
$ python -m testtools.run tempest."modules_to_your_test_file"."test_file_name"."your_test_suite_name"

View File

@ -1,4 +1,4 @@
<h3>Useful Links</h3>
<ul>
<li><a href="https://launchpad.net/climate">Climate @ Launchpad</a></li>
<li><a href="https://launchpad.net/blazar">Blazar @ Launchpad</a></li>
</ul>

View File

@ -1,32 +1,32 @@
Climate architecture
Blazar architecture
====================
Climate design can be described by following diagram:
Blazar design can be described by following diagram:
.. image:: images/climate-architecture.png
.. image:: images/blazar-architecture.png
:width: 700 px
:scale: 99 %
:align: left
**climate-client** - provides the opportunity to communicate with Climate via
*REST API* (climate-api service).
**blazar-client** - provides the opportunity to communicate with Blazar via
*REST API* (blazar-api service).
**climate-api** - waits for the REST calls from the outside world to redirect
them to the manager. climate-api communicates with climate-manager via RPC.
**blazar-api** - waits for the REST calls from the outside world to redirect
them to the manager. blazar-api communicates with blazar-manager via RPC.
Runs as a separated process.
**climate-manager** - implements all logic and operations with leases,
reservations and events. Communicates with Climate DB and stores there data
**blazar-manager** - implements all logic and operations with leases,
reservations and events. Communicates with Blazar DB and stores there data
structure of connected leases, reservations (both physical and virtual) and
events. climate-manager service is responsible for running events created for
events. blazar-manager service is responsible for running events created for
lease and process all actions that should be done this moment. Manager uses
resource-plugins to work with concrete resources (instances, volumes, compute
hosts). climate-manager uses Keystone trusts to commit actions on behalf of
hosts). blazar-manager uses Keystone trusts to commit actions on behalf of
user who has created lease before.
**resource-plugin** - responsible for exact actions to do with reserved
resources (VMs, volumes, etc.) When working knows only about resource ID and
token to use. All resource plugins work in the same process as climate-manager.
token to use. All resource plugins work in the same process as blazar-manager.
Virtual instance reservation
----------------------------
@ -34,7 +34,7 @@ Virtual instance reservation
Virtual instance reservation mostly looks like usual instance booting for user
- he/she only passes special hints to Nova containing information about future
lease - lease start and end dates, its name, etc. Special Nova API extensions
parse these parameter and use them to call Climate, passing to it ID of just
parse these parameter and use them to call Blazar, passing to it ID of just
created instance. If there is a need to reserve all instances in cloud (like in
developer labs to automate process of resource reclaiming), default reservation
extension might be used. By default it starts lease at the moment of request
@ -66,5 +66,5 @@ hosts. The time lease starts, user may use reserved compute capacity to run
his/her instances on it passing special scheduler hint to Nova. When host is
reserved, its not used for usual instance running, it might be used only when
lease starts and only by passing reservation ID to Nova. That is implemented
using special Nova Scheduler filter, that passes reservation ID to Climate and
using special Nova Scheduler filter, that passes reservation ID to Blazar and
checks if user really can use reserved compute capacity.

View File

@ -52,7 +52,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Climate'
project = u'Blazar'
copyright = u'2013, Mirantis Inc.;2014, Bull.'
# The version info for the project you're documenting, acts as replacement for
@ -117,7 +117,7 @@ html_theme = '_theme'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'Climate'
html_title = 'Blazar'
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
@ -184,7 +184,7 @@ html_sidebars = {
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'ClimateDoc'
htmlhelp_basename = 'BlazarDoc'
# -- Options for LaTeX output --------------------------------------------------
@ -203,7 +203,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'climatedoc.tex', u'Climate',
('index', 'blazardoc.tex', u'Blazar',
u'Mirantis Inc.', 'manual'),
]
@ -233,7 +233,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'climate', u'Climate',
('index', 'blazar', u'Blazar',
[u'Mirantis Inc.'], 1)
]
@ -247,8 +247,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Climate', u'Climate',
u'Mirantis Inc.', 'Climate', 'Climate',
('index', 'Blazar', u'Blazar',
u'Mirantis Inc.', 'Blazar', 'Blazar',
'Miscellaneous'),
]

View File

@ -5,7 +5,7 @@ Coding Guidelines
-----------------
`PEP8 <http://legacy.python.org/dev/peps/pep-0008/>`_ checking should pass for
all Climate code. You may check it using the following command:
all Blazar code. You may check it using the following command:
.. sourcecode:: console
@ -28,7 +28,7 @@ before sending your change on review.
Testing Guidelines
------------------
Climate repositories have unit tests that are run on all submitted code, and it
Blazar repositories have unit tests that are run on all submitted code, and it
is recommended for developers to execute them themselves to catch regressions
early. Developers are also expected to keep the test suite up-to-date with any
submitted code changes.
@ -48,13 +48,9 @@ for Python 2.7 and Python 2.6 accordingly.
Documentation Guidelines
------------------------
Currently Climate docs are partially written on `OpenStack wiki
<https://wiki.openstack.org/wiki/Climate>`_ pages, and partially using
Sphinx / RST located in the main repo in *doc* directory. In future all of them
will be moved to Sphinx / RST (now these docs cannot be published on
readthedocs.org, because there is already existing *climate* project created on
it. Now Climate ATCs are voting to choose new name for Climate project and then
all docs will be moved to new readthedocs project).
Currently Blazar docs are partially written on `OpenStack wiki
<https://wiki.openstack.org/wiki/Blazar>`_ pages, and partially using
Sphinx / RST located in the main repo in *doc* directory.
To build Sphinx / RST docs locally run the following command:

View File

@ -4,7 +4,7 @@ How to contribute
Getting started
---------------
* Create `Github <https://github.com/stackforge/climate>`_ account if you don't
* Create `Github <https://github.com/stackforge/blazar>`_ account if you don't
have one
* Make sure you have git options *user.name* and *user.email* set in git by
typing:
@ -15,7 +15,7 @@ Getting started
..
* Create `Launchpad <https://launchpad.net/climate>`_ account if you don't have
* Create `Launchpad <https://launchpad.net/blazar>`_ account if you don't have
one
* Create `OpenStack profile <https://www.openstack.org/profile/>`_
* Login to `OpenStack Gerrit <https://review.openstack.org/>`_ using your
@ -26,13 +26,13 @@ Getting started
* Check that your email is listed in `Gerrit identities
<https://review.openstack.org/#/settings/web-identities>`_
* Subscribe to Climate-related projects on
* Subscribe to Blazar-related projects on
`OpenStack Gerrit <https://review.openstack.org/>`_. Go to your
settings and in the watched projects add *stackforge/climate*,
*stackforge/climate-nova* and *stackforge/python-climateclient*
settings and in the watched projects add *stackforge/blazar*,
*stackforge/blazar-nova* and *stackforge/python-blazarclient*
As all bugs/blueprints are listed in `Climate Launchpad
<https://launchpad.net/climate/>`_, you may keep track on them and choose some
As all bugs/blueprints are listed in `Blazar Launchpad
<https://launchpad.net/blazar/>`_, you may keep track on them and choose some
to work on.
How to keep in touch with community
@ -42,17 +42,17 @@ How to keep in touch with community
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack>`_ or to
`OpenStack development mailing list
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>`_, do
that. Climate-related emails must be send with **[climate]** in its subject.
* All questions may be asked on our IRC channel #openstack-climate on
that. Blazar-related emails must be send with **[blazar]** in its subject.
* All questions may be asked on our IRC channel #openstack-blazar on
`freenode <http://freenode.net>`_
* We also have weekly meetings on #openstack-meeting
`freenode IRC channel <https://wiki.openstack.org/wiki/Meetings/Climate>`_
`freenode IRC channel <https://wiki.openstack.org/wiki/Meetings/Blazar>`_
Your first commit to Climate
Your first commit to Blazar
----------------------------
* Checkout corresponding Climate repository from `Github
<https://github.com/stackforge/climate>`_
* Checkout corresponding Blazar repository from `Github
<https://github.com/stackforge/blazar>`_
* Take a look on how `Gerrit review process
<https://wiki.openstack.org/wiki/Gerrit_Workflow>`_ goes on in OpenStack
(read carefully `committing changes

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@ -1,7 +1,7 @@
Welcome to Climate!
Welcome to Blazar!
===================
Climate is an OpenStack service to provide resource reservations in the
Blazar is an OpenStack service to provide resource reservations in the
OpenStack cloud for different resource types - both virtual (instances,
volumes, stacks) and physical (hosts).
@ -13,7 +13,7 @@ Overview
introduction
architecture
Roadmap <https://wiki.openstack.org/wiki/Climate/Roadmap>
Roadmap <https://wiki.openstack.org/wiki/Blazar/Roadmap>
User guide
----------

View File

@ -1,14 +1,14 @@
Introduction
============
Idea of creating Climate originated with two different use cases:
Idea of creating Blazar originated with two different use cases:
* Compute host reservation (when user with admin privileges can reserve
hardware resources that are dedicated to the sole use of a project)
* Virtual machine (instance) reservation (when user may ask reservation service
to provide him working VM not necessary now, but also in the future)
Now these ideas have been transformed to more general view: with Climate user
Now these ideas have been transformed to more general view: with Blazar user
can request the resources of cloud environment to be provided (“leased”) to his
project for specific amount on time, immediately or in future.
@ -38,7 +38,7 @@ instances and volumes), but also complex ones - like Heat stacks and Savanna
clusters. Reservation is characterized by status, resource type and identifier
and lease it belongs to.
**Lease** is a negotiation agreement between the provider (Climate, using OpenStack
**Lease** is a negotiation agreement between the provider (Blazar, using OpenStack
resources) and the consumer (user) where the former agrees to make some kind of
resources (both virtual and physical) available to latter, based on a set of
lease terms presented by the consumer. Here lease may be described as contract
@ -54,7 +54,7 @@ might describe lease start and lease end. Also it might be notification to user
Rationale
---------
Climate is created to:
Blazar is created to:
* manage cloud resources not only right now, but also in the future;
* have dedicated recourses on certain amount of time;
@ -80,26 +80,26 @@ Lease types (concepts)
scavenger hunt trying to find resources for reservations. For compute hosts
reservation that makes much sense, because in case there are instances
belonging to other project on eligible hosts, and without them there will be
possible to reserve these hosts, Climate may start instances migration.
possible to reserve these hosts, Blazar may start instances migration.
This operation can be timely and fairly complex and so different strategies
may be applied depending on heuristic factors such as the number, type and
state of the instances to be migrated. Also Climate should assert that there
state of the instances to be migrated. Also Blazar should assert that there
are at least enough potential candidates for the migration prior to starting
the actual migration. If Climate decides to start migration, it returns
the actual migration. If Blazar decides to start migration, it returns
**success** state and marks lease as **in_progress**, otherwise -
**failure**. If this 'hunting' ends successfully before configurable
timeout has passed, lease should be marked as **active**, otherwise its
status is set to **timedout**.
* **Delayed resource acquiring** or **scheduled reservation**. In this
reservation type lease is created successfully if Climate thinks there will
reservation type lease is created successfully if Blazar thinks there will
be enough resources to process provisioning later (otherwise this request
returns **failure** status). Lease is marked as **inactive** till all
resources will be actually provisioned. That works pretty nice and
predictable speaking about compute hosts reservation (because hosts as
resources are got not from common cloud pool, but from admin defined pool).
So Climate is possible to predict these physical resources usage and use that
So Blazar is possible to predict these physical resources usage and use that
information during lease creation. If we speak about virtual reservations,
here situation is more complicated, because all resources are got from common
cloud resources pool, and Climate cannot guarantee there will be enough
cloud resources pool, and Blazar cannot guarantee there will be enough
resources to provision them. In this failure case lease state will be marked
as **error** with appropriate explanation.

View File

@ -1,7 +1,7 @@
Climate REST API docs
Blazar REST API docs
*********************
This page includes documentation for Climate APIs.
This page includes documentation for Blazar APIs.
.. toctree::
:maxdepth: 1

View File

@ -1,13 +1,13 @@
Climate REST API v1.0
Blazar REST API v1.0
*********************
1 General API information
=========================
This section contains base information about the Climate REST API design,
including operations with different Climate resource types and examples of
possible requests and responses. Climate supports JSON data serialization
This section contains base information about the Blazar REST API design,
including operations with different Blazar resource types and examples of
possible requests and responses. Blazar supports JSON data serialization
format, which means that requests with non empty body have to contain
"application/json" Content-Type header or it should be added ".json" extension
to the resource name in the request.
@ -31,7 +31,7 @@ or
**Description**
Lease is the main abstraction for the user in the Climate case. Lease means
Lease is the main abstraction for the user in the Blazar case. Lease means
some kind of contract where start time, end time and resources to be reserved
are mentioned.
@ -40,7 +40,7 @@ are mentioned.
+--------+-----------------------+-------------------------------------------------------------------------------+
| Verb | URI | Description |
+========+=======================+===============================================================================+
| GET | /v1/leases | Lists all leases registered in Climate. |
| GET | /v1/leases | Lists all leases registered in Blazar. |
+--------+-----------------------+-------------------------------------------------------------------------------+
| POST | /v1/leases | Create new lease with passed parameters. |
+--------+-----------------------+-------------------------------------------------------------------------------+
@ -376,10 +376,10 @@ are mentioned.
**Description**
Host is the main abstraction for a Nova Compute host. It is necessary to
enroll compute hosts in Climate so that the host becomes dedicated to Climate,
enroll compute hosts in Blazar so that the host becomes dedicated to Blazar,
and won't accept other VM creation requests but the ones asked subsequently by
leases requests for dedicated hosts within Climate. If no extra arguments but
the name are passed when creating a host, Climate will take Nova
leases requests for dedicated hosts within Blazar. If no extra arguments but
the name are passed when creating a host, Blazar will take Nova
specifications, like VCPUs, RAM or cpu_info. There is a possibility to add what
we call arbitrary extra parameters (not provided within the Nova model) like
number of GPUs, color of the server or anything that needs to be filtered for a
@ -390,7 +390,7 @@ user query.
+--------+------------------------+---------------------------------------------------------------------------------+
| Verb | URI | Description |
+========+========================+=================================================================================+
| GET | /v1/os-hosts | Lists all hosts registered in Climate. |
| GET | /v1/os-hosts | Lists all hosts registered in Blazar. |
+--------+------------------------+---------------------------------------------------------------------------------+
| POST | /v1/os-hosts | Create new host with possibly extra parameters. |
+--------+------------------------+---------------------------------------------------------------------------------+
@ -651,4 +651,4 @@ not implemented, listed below examples are their possible view.
**Plugin ops**
**TBD** - https://blueprints.launchpad.net/climate/+spec/create-plugin-api-endpoint
**TBD** - https://blueprints.launchpad.net/blazar/+spec/create-plugin-api-endpoint

View File

@ -1,13 +1,13 @@
Climate REST API v2
Blazar REST API v2
*********************
1 General API information
=========================
This section contains base information about the Climate REST API design,
including operations with different Climate resource types and examples of
possible requests and responses. Climate supports JSON data serialization
This section contains base information about the Blazar REST API design,
including operations with different Blazar resource types and examples of
possible requests and responses. Blazar supports JSON data serialization
format, which means that requests with non empty body have to contain
"application/json" Content-Type header or it should be added ".json" extension
to the resource name in the request.
@ -31,7 +31,7 @@ or
**Description**
Lease is the main abstraction for the user in the Climate case. Lease means
Lease is the main abstraction for the user in the Blazar case. Lease means
some kind of contract where start time, end time and resources to be reserved
are mentioned.
@ -47,7 +47,7 @@ are mentioned.
**Description**
Host is the abstraction for a computehost in the Climate case. Host means
Host is the abstraction for a computehost in the Blazar case. Host means
a specific type of resource to be allocated.
.. rest-controller:: climate.api.v2.controllers.extensions.host:HostsController

View File

@ -1,7 +1,7 @@
Installation using Devstack
===========================
This section includes instructions for Climate installation using Devstack.
This section includes instructions for Blazar installation using Devstack.
1. Download Devstack:
@ -11,7 +11,7 @@ This section includes instructions for Climate installation using Devstack.
..
2. Download Climate:
2. Download Blazar:
.. sourcecode:: console
@ -19,7 +19,7 @@ This section includes instructions for Climate installation using Devstack.
..
3. Add climate files to Devstack:
3. Add blazar files to Devstack:
.. sourcecode:: console
@ -30,7 +30,7 @@ This section includes instructions for Climate installation using Devstack.
..
4. Configure devstack to run climate by adding climate, climate api and climate
4. Configure devstack to run blazar by adding blazar, blazar api and blazar
manager to the localrc file:
.. sourcecode:: console
@ -53,15 +53,15 @@ This section includes instructions for Climate installation using Devstack.
Installation without Devstack
=============================
This section includes instructions for Climate installation.
This section includes instructions for Blazar installation.
Download all Climate related repos:
Download all Blazar related repos:
.. sourcecode:: console
git clone https://github.com/stackforge/climate.git
git clone https://github.com/stackforge/climate-nova.git
git clone https://github.com/stackforge/python-climateclient.git
git clone https://github.com/stackforge/blazar.git
git clone https://github.com/stackforge/blazar-nova.git
git clone https://github.com/stackforge/python-blazarclient.git
..
@ -81,7 +81,7 @@ or
..
Next you need to configure Climate and Nova. Define */etc/climate/climate.conf*
Next you need to configure Blazar and Nova. Define */etc/climate/climate.conf*
file using the following example:
.. sourcecode:: console
@ -112,7 +112,7 @@ file using the following example:
..
Here *os_admin_** flags refer to Climate service user. *climate_** ones - to
Here *os_admin_** flags refer to Blazar service user. *climate_** ones - to
admin user created specially to work with physical reservations. If you have no
these users, create them via Keystone:
@ -149,7 +149,7 @@ If you want to use physical reservations add these ones:
Restart nova-api and nova-scheduler to use new configuration file.
Climate uses Keystone trusts to commit actions on behalf of user created lease.
Blazar uses Keystone trusts to commit actions on behalf of user created lease.
Thats why we need to create identityv3 service with appropriate endpoints:
.. sourcecode:: console
@ -169,7 +169,7 @@ endpoints:
..
To start Climate services use:
To start Blazar services use:
.. sourcecode:: console
@ -178,5 +178,5 @@ To start Climate services use:
..
Now you can use python-climateclient to communicate with Climate.
Now you can use python-blazarclient to communicate with Blazar.