Adjust documentation for PDF
This change wraps lines when needed and tunes the configuration for PDF generation. It also adds a note about disk requirements. Change-Id: I0104f24a4b908c6ad87b20fd76d20c26438fc4b6
This commit is contained in:
parent
fa3a9a2754
commit
e89b1db388
|
@ -25,3 +25,8 @@ latex_documents = [
|
|||
('index', 'ElasticsearchKibana.tex', u'The Elasticsearch-Kibana plugin for Fuel Documentation',
|
||||
u'Mirantis Inc.', 'manual'),
|
||||
]
|
||||
|
||||
# make latex stop printing blank pages between sections
|
||||
# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
|
||||
latex_elements = {'classoptions': ',openany,oneside', 'babel':
|
||||
'\\usepackage[english]{babel}'}
|
||||
|
|
|
@ -13,7 +13,8 @@ Catalog, you need to follow these steps:
|
|||
|
||||
2. Copy the RPM file to the Fuel Master node::
|
||||
|
||||
[root@home ~]# scp elasticsearch_kibana-0.8-0.8.0-0.noarch.rpm root@<Fuel Master node IP address>:
|
||||
[root@home ~]# scp elasticsearch_kibana-0.8-0.8.0-0.noarch.rpm \
|
||||
root@<Fuel Master node IP address>:
|
||||
|
||||
3. Install the plugin using the `Fuel CLI <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#using-fuel-cli>`_::
|
||||
|
||||
|
@ -61,7 +62,8 @@ if you need further instructions about how to build the Fuel Plugin Builder.
|
|||
|
||||
4. Clone the plugin git repository::
|
||||
|
||||
[root@home ~] git clone git@github.com:stackforge/fuel-plugin-elasticsearch-kibana.git
|
||||
[root@home ~] git clone \
|
||||
git@github.com:openstack/fuel-plugin-elasticsearch-kibana.git
|
||||
|
||||
5. Check that the plugin is valid::
|
||||
|
||||
|
@ -73,7 +75,8 @@ if you need further instructions about how to build the Fuel Plugin Builder.
|
|||
|
||||
7. Now that you have created the RPM file, you can install the plugin using the `fuel plugins --install` command::
|
||||
|
||||
[root@fuel ~] fuel plugins --install ./fuel-plugin-elasticsearch-kibana/elasticsearch_kibana-0.8-0.8.0-1.noarch.rpm
|
||||
[root@fuel ~] fuel plugins --install \
|
||||
./fuel-plugin-elasticsearch-kibana/*.noarch.rpm
|
||||
|
||||
|
||||
Elasticsearch-Kibana Fuel Plugin software components
|
||||
|
|
|
@ -22,20 +22,22 @@ as shown in the figure below.
|
|||
Requirements
|
||||
------------
|
||||
|
||||
+------------------------+------------------------------------------------------------------------------------------------+
|
||||
| **Requirement** | **Version/Comment** |
|
||||
+========================+================================================================================================+
|
||||
| Fuel | Mirantis OpenStack 7.0 |
|
||||
+------------------------+------------------------------------------------------------------------------------------------+
|
||||
| Hardware configuration | The hardware configuration (RAM, CPU, disk) required by this plugin depends on the size |
|
||||
| | of your cloud and other parameters like the log level being used. |
|
||||
| | |
|
||||
| | A typical setup would at least require a quad-core server with 8GB of RAM and fast disks |
|
||||
| | (ideally, SSDs). |
|
||||
| | |
|
||||
| | It is also highly recommended to use dedicated disk(s) for your data storage. Otherwise, |
|
||||
| | Elasticsearch will use the root filesystem by default. |
|
||||
+------------------------+------------------------------------------------------------------------------------------------+
|
||||
+------------------------+------------------------------------------------------------------------------------------+
|
||||
| **Requirement** | **Version/Comment** |
|
||||
+========================+==========================================================================================+
|
||||
| Disk space | At least 55GB |
|
||||
+------------------------+------------------------------------------------------------------------------------------+
|
||||
| Fuel | Mirantis OpenStack 7.0 |
|
||||
+------------------------+------------------------------------------------------------------------------------------+
|
||||
| Hardware configuration | The hardware configuration (RAM, CPU, disk) required by this plugin depends on the size |
|
||||
| | of your cloud and other parameters like the log level being used. |
|
||||
| | |
|
||||
| | A typical setup would at least require a quad-core server with 8GB of RAM and fast disks |
|
||||
| | (ideally, SSDs). |
|
||||
| | |
|
||||
| | It is also highly recommended to use dedicated disk(s) for your data storage. Otherwise, |
|
||||
| | Elasticsearch will use the root filesystem by default. |
|
||||
+------------------------+------------------------------------------------------------------------------------------+
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
|
|
@ -108,10 +108,10 @@ The expected output should look like something like this::
|
|||
the `fuel` command line::
|
||||
|
||||
[root@fuel ~]# fuel nodes
|
||||
id | status | name | cluster | ip | mac | roles | pending_roles | online | group_id
|
||||
---|----------|------------------|---------|-----------|-------------------|----------------------|---------------|--------|---------
|
||||
14 | ready | Untitled (20:0c) | 8 | 10.20.0.8 | 08:00:27:29:20:0c | controller | | True | 8
|
||||
13 | ready | Untitled (47:b7) | 8 | 10.20.0.4 | 08:00:27:54:47:b7 | elasticsearch_kibana | | True | 8
|
||||
id | status | name | cluster | ip | ... | roles | ...
|
||||
---|----------|----------------|-----------|-----|----------------------|----
|
||||
14 | ready | ctrl | 8 | 10.20.0.8 | ... | controller | ...
|
||||
13 | ready | lma | 8 | 10.20.0.4 | ... | elasticsearch_kibana | ...
|
||||
|
||||
**Kibana**
|
||||
|
||||
|
|
Loading…
Reference in New Issue