x/mogan
Code Issues Proposed changes

[DOC] Add flavor manage and customize instructions

Browse Source 
Change-Id: I9efd310f9e8cf752ec8063b939575e5fb56aeae7
This commit is contained in:
Zhenguo Niu 2017-09-12 19:20:32 +08:00
parent f26a5e6b3a
commit 81c47673aa
2 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
doc/source/admin/flavors.rst Normal file
View File

@ -0,0 +1,54 @@
=======
Flavors
=======
Admin users can use the :command:`openstack baremetalcompute flavor` command to
customize and manage flavors. To see information for this command, run:
.. code-block:: console
$ openstack baremetalcompute flavor [TAB]
create delete list set show unset
Flavors define these elements:
+---------------------+-------------------------------------------------------+
| Element | Description |
+=====================+=======================================================+
| Name | A descriptive name. |
+---------------------+-------------------------------------------------------+
| Description | Typically used to put hardware specs and aggregates |
| | informations. |
+---------------------+-------------------------------------------------------+
| Resources | Key and value pairs that corresponds to placement |
| | resource classes and amounts, like ``baremetal=1``. |
+---------------------+-------------------------------------------------------+
| Resource Aggregates | Key and value pairs that corresponds to node |
| | aggregates metadata. |
+---------------------+-------------------------------------------------------+
| Is Public | Boolean value, whether flavor is available to all |
| | users or private to the project it was created in. |
| | Defaults to ``True``. |
+---------------------+-------------------------------------------------------+
| Disabled | Boolean value, whether flavor is available for new |
| | servers creation. It is intended to be used when |
| | phasing out flavors. Defaults to ``False``. |
+---------------------+-------------------------------------------------------+
.. note::
Flavors are not allowed to be deleted if there are still live servers
associated with it. You should disable it instead in such situation.
Is Public
~~~~~~~~~
Flavors can be assigned to particular projects. By default, a flavor is public
and available to all projects. Private flavors are only accessible to those on
the access list and are invisible to other projects. To create and assign a
private flavor to a project, run this command:
.. code-block:: console
$ openstack baremetalcompute flavor create --private p1.gold --description "gold" \
--resources gold=1

1
doc/source/index.rst
View File

@ -67,6 +67,7 @@ Administrator Guide
.. toctree::
:maxdepth: 1
admin/flavors
admin/gmr