openstack
/
sahara-tests
Code Issues Proposed changes

Improve documentation 

Current official doc doesn't have any content, so this change improves
it by moving the content from README files, editing it to conform with
doc8 validations and also changing its look to use OpenStack docs
layout.

Change-Id: I326fe572354b2e9d7c512b9f6f2b09228384b4e2
This commit is contained in:
Raissa Sarmento 2016-07-29 10:17:55 -03:00
parent 29b7d29e2b
commit cd2d236c39
6 changed files with 655 additions and 457 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -13,8 +13,6 @@ In sahara_tests folder we have next tools:
- Sahara-scenario framework
- Sahara tempest tests
For more details see README.rst file in the chosen directory
* License: Apache License, Version 2.0
* `PyPi`_ - package installation
* `Launchpad project`_ - release management

3
doc/source/conf.py
View File

@ -25,7 +25,8 @@ import sys, os
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []
extensions = ['oslosphinx',
'reno.sphinxext']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

35
doc/source/index.rst
View File

@ -1,17 +1,38 @@
.. sahara-tests documentation master file, created by
sphinx-quickstart on Mon Dec 21 21:22:00 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to sahara-tests's documentation!
===========================================
Contents:
Tests for the
`Sahara project
<http://docs.openstack.org/developer/sahara/>`_.
It provides Sahara scenario tests framework and tempest tests.
User guide
----------
**Scenario Tests**
.. toctree::
:maxdepth: 2
:maxdepth: 1
scenario
Source
------
* License: Apache License, Version 2.0
* `PyPi`_ - package installation
* `Launchpad project`_ - release management
* `Blueprints`_ - feature specifications
* `Source`_
* `Specs`_
* :doc:`releasenotes`
.. _PyPi: https://pypi.python.org/pypi/sahara-tests
.. _Launchpad project: https://launchpad.net/sahara-tests
.. _Blueprints: https://blueprints.launchpad.net/sahara-tests
.. _Source: https://git.openstack.org/cgit/openstack/sahara-tests
.. _Specs: http://specs.openstack.org/openstack/sahara-specs/
Indices and tables
==================

5
doc/source/releasenotes.rst Normal file
View File

@ -0,0 +1,5 @@
=============
Release Notes
=============
.. release-notes::

620
doc/source/scenario.rst Normal file
View File

@ -0,0 +1,620 @@
System(scenario) tests for Sahara project
=========================================
How to run
----------
Information about authentication can be found in section `Authentication`_.
Scenario framework has default templates for testing Sahara. For
use them, need to specify plugin and version (for transient check and
fake plugin, version is not necessary):
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -p vanilla -v 2.7.1
..
Create the YAML and/or the YAML mako template files for scenario tests
``etc/scenario/simple-testcase.yaml``.
You can take a look at sample YAML files `How to write scenario files`_.
If you want to run scenario tests for one plugin, you should use the
YAML files with a scenario for the specific plugin:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario etc/scenario/simple-testcase.yaml
..
or, if the file is a YAML Mako template:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -V templatevars.ini sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako
..
where templatevars.ini contains the values of the variables referenced
by ``vanilla-2.7.1.yaml.mako``.
For example, you want to run tests for the Vanilla plugin with the Hadoop
version 2.7.1 In this case you should create ``templatevars.ini`` with
the appropriate values (see the section `Variables and defaults templates`_)
and use the following tox env:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -V templatevars.ini sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako
..
If you want to run scenario tests for a few plugins or their versions, you
should use the several YAML and/or YAML Mako template files:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -V templatevars.ini sahara_tests/scenario/defaults/cdh-5.4.0.yaml.mako sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako ...
..
Here are a few more examples.
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -V templatevars.ini sahara_tests/scenario/defaults/credentials.yaml.mako sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako
..
will run tests for Vanilla plugin with the Hadoop version 2.7.1 and credential
located in ``sahara_tests/scenario/defaults/credentials.yaml.mako``,
replacing the variables
included into ``vanilla-2.7.1.yaml.mako`` with the values defined into
``templatevars.ini``.
For more information about writing scenario YAML files, see the section
section `How to write scenario files`_.
``tox -e venv -- sahara-scenario sahara_tests/scenario/defaults`` will run
tests from the test directory.
Also, you can validate your yaml-files using flag ``--validate`` via command:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario --validate -V templatevars.ini sahara_tests/scenario/defaults/credantials.yaml.mako sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako
..
For generating report use flag `--report`.
_`Authentication`
-----------------
You can set authentication variables in two ways:
1. Use environment variables(like openrc in devstack)
.. sourcecode:: console
List of variables:
- OS_USERNAME
- OS_PASSWORD
- OS_TENANT_NAME
- OS_AUTH_URL
..
2. Use flags in run-commad
.. sourcecode:: console
List of flags:
--os-username
--os-password
--os-project-name
--os-auth-url
..
See default values for these variables in `How to write scenario files`_
in the `Credentials` section.
Template variables
------------------
The variables used in the Mako template files are replaced with
the values from a config file, whose name is passed to the test
runner through the ``-V`` parameter.
The format of the config file is an INI-style file, as accepted by the Python
ConfigParser module. The key/values must be specified in the DEFAULT section.
Example of template variables file:
.. sourcecode:: ini
[DEFAULT]
network_type: neutron
network_private_name: private
...
..
Variables and defaults templates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following variables are currently used by defaults templates:
+-----------------------------+--------+-------------------------+
| Variable | Type | Value |
+=============================+========+=========================+
| network_type | string | neutron or nova-network |
+-----------------------------+--------+-------------------------+
| network_private_name | string | private network name |
| | | for OS_TENANT_NAME |
+-----------------------------+--------+-------------------------+
| network_public_name | string | public network name |
+-----------------------------+--------+-------------------------+
| <plugin_name_version>_name | string | name of the image to be |
| | | used for the specific |
| | | plugin/version |
+-----------------------------+--------+-------------------------+
| {ci,medium,large}_flavor_id | string | IDs of flavor with |
| | | different size |
+-----------------------------+--------+-------------------------+
_`How to write scenario files`
==============================
You can write all sections in one or several files, which can
be simple YAML files or YAML-based Mako templates (.yaml.mako
or yml.mako).
Field "concurrency"
-------------------
This field has integer value, and set concurrency for run tests
For example:
``concurrency: 2``
For parallel testing use flag ``--count`` in run command and
setup ``cuncurrency`` value
Section "credentials"
---------------------
This section is dictionary-type.
+---------------------+--------+----------+----------------+----------------+
| Fields | Type | Required | Default | Value |
+=====================+========+==========+================+================+
| sahara_service_type | string | | data-processing| service type |
| | | | | for sahara |
+---------------------+--------+----------+----------------+----------------+
| sahara_url | string | | None | url of sahara |
+---------------------+--------+----------+----------------+----------------+
| ssl_cert | string | | None | ssl certificate|
| | | | | for all clients|
+---------------------+--------+----------+----------------+----------------+
| ssl_verify | boolean| | False | enable verify |
| | | | | ssl for sahara |
+---------------------+--------+----------+----------------+----------------+
Section "network"
-----------------
This section is dictionary-type.
+---------------------------+-------+----------+---------+-------------------+
| Fields | Type | Required | Default | Value |
+===========================+=======+==========+=========+===================+
| private_network |string | True | private | name or id of |
| | | | | private network |
+---------------------------+-------+----------+---------+-------------------+
| public_network |string | True | public | name or id of |
| | | | | private network |
+---------------------------+-------+----------+---------+-------------------+
| type |string | | neutron | "neutron" or |
| | | | | "nova-network" |
+---------------------------+-------+----------+---------+-------------------+
|auto_assignment_floating_ip|boolean| | False | |
+---------------------------+-------+----------+---------+-------------------+
Section "clusters"
------------------
This sections is an array-type.
.. list-table::
:header-rows: 1
* - Fields
- Type
- Required
- Default
- Value
* - plugin_name
- string
- True
-
- name of plugin
* - plugin_version
- string
- True
-
- version of plugin
* - image
- string
- True
-
- name or id of image
* - image_username
- string
-
-
- username for registering image
* - existing_cluster
- string
-
-
- cluster name or id for testing
* - key_name
- string
-
-
- name of registered ssh key for testing cluster
* - node_group_templates
- object
-
-
- see `section "node_group_templates"`_
* - cluster_template
- object
-
-
- see `section "cluster_template"`_
* - cluster
- object
-
-
- see `section "cluster"`_
* - scaling
- object
-
-
- see `section "scaling"`_
* - timeout_check_transient
- integer
-
- 300
- timeout for checking transient
* - timeout_poll_jobs_status
- integer
-
- 1800
- timeout for polling jobs state
* - timeout_delete_resource
- integer
-
- 300
- timeout for delete resource
* - timeout_poll_cluster_status
- integer
-
- 3600
- timeout for polling cluster state
* - scenario
- array
-
- ['run_jobs', 'scale', 'run_jobs']
- array of checks
* - edp_jobs_flow
- string
-
-
- name of edp job flow
* - retain_resources
- boolean
-
- False
-
Section "node_group_templates"
------------------------------
This section is an array-type.
.. list-table::
:header-rows: 1
* - Fields
- Type
- Required
- Default
- Value
* - name
- string
- True
-
- name for node group template
* - flavor
- string or object
- True
-
- name or id of flavor, or see `section "flavor"`_
* - node_processes
- string
- True
-
- name of process
* - description
- string
-
- Empty
- description for node group
* - volumes_per_node
- integer
-
- 0
- minimum 0
* - volumes_size
- integer
-
- 0
- minimum 0
* - auto_security_group
- boolean
-
- True
-
* - security_group
- array
-
-
- security group
* - node_configs
- object
-
-
- name_of_config_section: config: value
* - availability_zone
- string
-
-
-
* - volumes_availability_zone
- string
-
-
-
* - volume_type
- string
-
-
-
* - is_proxy_gateway
- boolean
-
- False
- use this node as proxy gateway
* - edp_batching
- integer
-
- count jobs
- use for batching jobs
Section "flavor"
----------------
This section is an dictionary-type.
+----------------+---------+----------+---------------+-----------------+
| Fields | Type | Required | Default | Value |
+================+=========+==========+===============+=================+
| name | string | | auto-generate | name for flavor |
+----------------+---------+----------+---------------+-----------------+
| id | string | | auto-generate | id for flavor |
+----------------+---------+----------+---------------+-----------------+
| vcpus | integer | | 1 | number of VCPUs |
| | | | | for the flavor |
+----------------+---------+----------+---------------+-----------------+
| ram | integer | | 1 | memory in MB for|
| | | | | the flavor |
+----------------+---------+----------+---------------+-----------------+
| root_disk | integer | | 0 | size of local |
| | | | | disk in GB |
+----------------+---------+----------+---------------+-----------------+
| ephemeral_disk | integer | | 0 | ephemeral space |
| | | | | in MB |
+----------------+---------+----------+---------------+-----------------+
| swap_disk | integer | | 0 | swap space in MB|
+----------------+---------+----------+---------------+-----------------+
Section "cluster_template"
--------------------------
This section is dictionary-type.
.. list-table::
:header-rows: 1
* - Fields
- Type
- Required
- Default
- Value
* - name
- string
- True
-
- name for cluster template
* - description
- string
-
- Empty
- description
* - cluster_configs
- object
-
-
- name_of_config_section: config: value
* - node_group_templates
- object
- True
-
- name_of_node_group: count
* - anti_affinity
- array
-
- Empty
- array of roles
Section "cluster"
-----------------
This section is dictionary-type.
+--------------+---------+----------+---------+------------------+
| Fields | Type | Required | Default | Value |
+==============+=========+==========+=========+==================+
| name | string | True | Empty | name for cluster |
+--------------+---------+----------+---------+------------------+
| description | string | | Empty | description |
+--------------+---------+----------+---------+------------------+
| is_transient | boolean | | False | value |
+--------------+---------+----------+---------+------------------+
Section "scaling"
-----------------
This section is an array-type.
+------------+---------+----------+-----------+--------------------+
| Fields | Type | Required | Default | Value |
+============+=========+==========+===========+====================+
| operation | string | True | | "add" or "resize" |
+------------+---------+----------+-----------+--------------------+
| node_group | string | True | Empty | name of node group |
+------------+---------+----------+-----------+--------------------+
| size | integer | True | Empty | count node group |
+------------+---------+----------+-----------+--------------------+
Section "edp_jobs_flow"
-----------------------
This section has an object with a name from the `section "clusters"`_
field "edp_jobs_flows"
Object has sections of array-type.
Required: type
.. list-table::
:header-rows: 1
* - Fields
- Type
- Required
- Default
- Value
* - type
- string
- True
-
- "Pig", "Java", "MapReduce", "MapReduce.Streaming", "Hive", "Spark", "Shell"
* - input_datasource
- object
-
-
- see `section "input_datasource"`_
* - output_datasource
- object
-
-
- see `section "output_datasource"`_
* - main_lib
- object
-
-
- see `section "main_lib"`_
* - additional_libs
- object
-
-
- see `section "additional_libs"`_
* - configs
- dict
-
- Empty
- config: value
* - args
- array
-
- Empty
- array of args
Section "input_datasource"
--------------------------
Required: type, source
This section is dictionary-type.
+---------------+--------+----------+-----------+---------------------------+
| Fields | Type | Required | Default | Value |
+===============+========+==========+===========+===========================+
| type | string | True | | "swift", "hdfs", "maprfs" |
+---------------+--------+----------+-----------+---------------------------+
| hdfs_username | string | | | username for hdfs |
+---------------+--------+----------+-----------+---------------------------+
| source | string | True | | uri of source |
+---------------+--------+----------+-----------+---------------------------+
Section "output_datasource"
---------------------------
Required: type, destination
This section is dictionary-type.
+-------------+--------+----------+-----------+---------------------------+
| Fields | Type | Required | Default | Value |
+=============+========+==========+===========+===========================+
| type | string | True | | "swift", "hdfs", "maprfs" |
+-------------+--------+----------+-----------+---------------------------+
| destination | string | True | | uri of source |
+-------------+--------+----------+-----------+---------------------------+
Section "main_lib"
------------------
Required: type, source
This section is dictionary-type.
+--------+--------+----------+-----------+----------------------+
| Fields | Type | Required | Default | Value |
+========+========+==========+===========+======================+
| type | string | True | | "swift or "database" |
+--------+--------+----------+-----------+----------------------+
| source | string | True | | uri of source |
+--------+--------+----------+-----------+----------------------+
Section "additional_libs"
-------------------------
Required: type, source
This section is an array-type.
+--------+--------+----------+-----------+----------------------+
| Fields | Type | Required | Default | Value |
+========+========+==========+===========+======================+
| type | string | True | | "swift or "database" |
+--------+--------+----------+-----------+----------------------+
| source | string | True | | uri of source |
+--------+--------+----------+-----------+----------------------+

447
sahara_tests/scenario/README.rst
View File

@ -1,449 +1,2 @@
System(scenario) tests for Sahara project
=========================================
How to run
----------
Information about authentication can be found in section `Authentication`_.
Scenario framework has default templates for testing Sahara. For
use them, need to specify plugin and version (for transient check and
fake plugin, version is not necessary):
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -p vanilla -v 2.7.1
..
Create the YAML and/or the YAML mako template files for scenario tests
``etc/scenario/simple-testcase.yaml``.
You can take a look at sample YAML files `How to write scenario files`_.
If you want to run scenario tests for one plugin, you should use the
YAML files with a scenario for the specific plugin:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario etc/scenario/simple-testcase.yaml
..
or, if the file is a YAML Mako template:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -V templatevars.ini sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako
..
where templatevars.ini contains the values of the variables referenced
by ``vanilla-2.7.1.yaml.mako``.
For example, you want to run tests for the Vanilla plugin with the Hadoop
version 2.7.1 In this case you should create ``templatevars.ini`` with
the appropriate values (see the section `Variables and defaults templates`_)
and use the following tox env:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -V templatevars.ini sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako
..
If you want to run scenario tests for a few plugins or their versions, you
should use the several YAML and/or YAML Mako template files:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -V templatevars.ini sahara_tests/scenario/defaults/cdh-5.4.0.yaml.mako sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako ...
..
Here are a few more examples.
.. sourcecode:: console
$ tox -e venv -- sahara-scenario -V templatevars.ini sahara_tests/scenario/defaults/credentials.yaml.mako sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako
..
will run tests for Vanilla plugin with the Hadoop version 2.7.1 and credential
located in ``sahara_tests/scenario/defaults/credentials.yaml.mako``, replacing the variables
included into ``vanilla-2.7.1.yaml.mako`` with the values defined into
``templatevars.ini``.
For more information about writing scenario YAML files, see the section
section `How to write scenario files`_.
``tox -e venv -- sahara-scenario sahara_tests/scenario/defaults`` will run tests from the test directory.
Also, you can validate your yaml-files using flag ``--validate`` via command:
.. sourcecode:: console
$ tox -e venv -- sahara-scenario --validate -V templatevars.ini sahara_tests/scenario/defaults/credantials.yaml.mako sahara_tests/scenario/defaults/vanilla-2.7.1.yaml.mako
..
For generating report use flag `--report`.
_`Authentication`
-----------------
You can set authentication variables in two ways:
1. Use environment variables(like openrc in devstack)
.. sourcecode:: console
List of variables:
- OS_USERNAME
- OS_PASSWORD
- OS_TENANT_NAME
- OS_AUTH_URL
..
2. Use flags in run-commad
.. sourcecode:: console
List of flags:
--os-username
--os-password
--os-project-name
--os-auth-url
..
See default values for these variables in `How to write scenario files`_ in the `Credentials` section.
Template variables
------------------
The variables used in the Mako template files are replaced with the values from a
config file, whose name is passed to the test runner through the ``-V`` parameter.
The format of the config file is an INI-style file, as accepted by the Python
ConfigParser module. The key/values must be specified in the DEFAULT section.
Example of template variables file:
.. sourcecode:: ini
[DEFAULT]
network_type: neutron
network_private_name: private
...
..
Variables and defaults templates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following variables are currently used by defaults templates:
+-----------------------------+--------+--------------------------------------------------------------+
| Variable | Type | Value |
+=============================+========+==============================================================+
| network_type | string | neutron or nova-network |
+-----------------------------+--------+--------------------------------------------------------------+
| network_private_name | string | private network name for OS_TENANT_NAME |
+-----------------------------+--------+--------------------------------------------------------------+
| network_public_name | string | public network name |
+-----------------------------+--------+--------------------------------------------------------------+
| <plugin_name_version>_name | string | name of the image to be used for the specific plugin/version |
+-----------------------------+--------+--------------------------------------------------------------+
| {ci,medium,large}_flavor_id | string | IDs of flavor with different size |
+-----------------------------+--------+--------------------------------------------------------------+
_`How to write scenario files`
==============================
You can write all sections in one or several files, which can be simple YAML files
or YAML-based Mako templates (.yaml.mako or yml.mako).
Field "concurrency"
-------------------
This field has integer value, and set concurrency for run tests
For example:
``concurrency: 2``
For parallel testing use flag ``--count`` in run command and
setup ``cuncurrency`` value
Section "credentials"
---------------------
This section is dictionary-type.
+---------------------+--------+----------+------------------------------+---------------------------------+
| Fields | Type | Required | Default | Value |
+=====================+========+==========+==============================+=================================+
| sahara_service_type | string | | data-processing | service type for sahara |
+---------------------+--------+----------+------------------------------+---------------------------------+
| sahara_url | string | | None | url of sahara |
+---------------------+--------+----------+------------------------------+---------------------------------+
| ssl_cert | string | | None | ssl certificate for all clients |
+---------------------+--------+----------+------------------------------+---------------------------------+
| ssl_verify | boolean| | False | enable verify ssl for sahara |
+---------------------+--------+----------+------------------------------+---------------------------------+
Section "network"
-----------------
This section is dictionary-type.
+-----------------------------+---------+----------+----------+-------------------------------+
| Fields | Type | Required | Default | Value |
+=============================+=========+==========+==========+===============================+
| private_network | string | True | private | name or id of private network |
+-----------------------------+---------+----------+----------+-------------------------------+
| public_network | string | True | public | name or id of private network |
+-----------------------------+---------+----------+----------+-------------------------------+
| type | string | | neutron | "neutron" or "nova-network" |
+-----------------------------+---------+----------+----------+-------------------------------+
| auto_assignment_floating_ip | boolean | | False | |
+-----------------------------+---------+----------+----------+-------------------------------+
Section "clusters"
------------------
This sections is an array-type.
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| Fields | Type | Required | Default | Value |
+=============================+=========+==========+===================================+================================================+
| plugin_name | string | True | | name of plugin |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| plugin_version | string | True | | version of plugin |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| image | string | True | | name or id of image |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| image_username | string | | | username for registering image |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| existing_cluster | string | | | cluster name or id for testing |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| key_name | string | | | name of registered ssh key for testing cluster |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| node_group_templates | object | | | see `section "node_group_templates"`_ |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| cluster_template | object | | | see `section "cluster_template"`_ |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| cluster | object | | | see `section "cluster"`_ |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| scaling | object | | | see `section "scaling"`_ |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| timeout_check_transient | integer | | 300 | timeout for checking transient |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| timeout_poll_jobs_status | integer | | 1800 | timeout for polling jobs state |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| timeout_delete_resource | integer | | 300 | timeout for delete resource |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| timeout_poll_cluster_status | integer | | 3600 | timeout for polling cluster state |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| scenario | array | | ['run_jobs', 'scale', 'run_jobs'] | array of checks |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| edp_jobs_flow | string | | | name of edp job flow |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
| retain_resources | boolean | | False | |
+-----------------------------+---------+----------+-----------------------------------+------------------------------------------------+
Section "node_group_templates"
------------------------------
This section is an array-type.
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| Fields | Type | Required | Default | Value |
+===========================+==================+==========+============+==================================================+
| name | string | True | | name for node group template |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| flavor | string or object | True | | name or id of flavor, or see `section "flavor"`_ |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| node_processes | string | True | | name of process |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| description | string | | Empty | description for node group |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| volumes_per_node | integer | | 0 | minimum 0 |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| volumes_size | integer | | 0 | minimum 0 |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| auto_security_group | boolean | | True | |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| security_group | array | | | security group |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| node_configs | object | | | name_of_config_section: config: value |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| availability_zone | string | | | |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| volumes_availability_zone | string | | | |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| volume_type | string | | | |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| is_proxy_gateway | boolean | | False | use this node as proxy gateway |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
| edp_batching | integer | | count jobs | use for batching jobs |
+---------------------------+------------------+----------+------------+--------------------------------------------------+
Section "flavor"
----------------
This section is an dictionary-type.
+----------------+---------+----------+---------------+--------------------------------+
| Fields | Type | Required | Default | Value |
+================+=========+==========+===============+================================+
| name | string | | auto-generate | name for flavor |
+----------------+---------+----------+---------------+--------------------------------+
| id | string | | auto-generate | id for flavor |
+----------------+---------+----------+---------------+--------------------------------+
| vcpus | integer | | 1 | number of VCPUs for the flavor |
+----------------+---------+----------+---------------+--------------------------------+
| ram | integer | | 1 | memory in MB for the flavor |
+----------------+---------+----------+---------------+--------------------------------+
| root_disk | integer | | 0 | size of local disk in GB |
+----------------+---------+----------+---------------+--------------------------------+
| ephemeral_disk | integer | | 0 | ephemeral space in MB |
+----------------+---------+----------+---------------+--------------------------------+
| swap_disk | integer | | 0 | swap space in MB |
+----------------+---------+----------+---------------+--------------------------------+
Section "cluster_template"
--------------------------
This section is dictionary-type.
+----------------------+--------+----------+-----------+---------------------------------------+
| Fields | Type | Required | Default | Value |
+======================+========+==========+===========+=======================================+
| name | string | True | | name for cluster template |
+----------------------+--------+----------+-----------+---------------------------------------+
| description | string | | Empty | description |
+----------------------+--------+----------+-----------+---------------------------------------+
| cluster_configs | object | | | name_of_config_section: config: value |
+----------------------+--------+----------+-----------+---------------------------------------+
| node_group_templates | object | True | | name_of_node_group: count |
+----------------------+--------+----------+-----------+---------------------------------------+
| anti_affinity | array | | Empty | array of roles |
+----------------------+--------+----------+-----------+---------------------------------------+
Section "cluster"
-----------------
This section is dictionary-type.
+--------------+---------+----------+---------+------------------+
| Fields | Type | Required | Default | Value |
+==============+=========+==========+=========+==================+
| name | string | True | Empty | name for cluster |
+--------------+---------+----------+---------+------------------+
| description | string | | Empty | description |
+--------------+---------+----------+---------+------------------+
| is_transient | boolean | | False | value |
+--------------+---------+----------+---------+------------------+
Section "scaling"
-----------------
This section is an array-type.
+------------+---------+----------+-----------+--------------------+
| Fields | Type | Required | Default | Value |
+============+=========+==========+===========+====================+
| operation | string | True | | "add" or "resize" |
+------------+---------+----------+-----------+--------------------+
| node_group | string | True | Empty | name of node group |
+------------+---------+----------+-----------+--------------------+
| size | integer | True | Empty | count node group |
+------------+---------+----------+-----------+--------------------+
Section "edp_jobs_flow"
-----------------------
This section has an object with a name from the `section "clusters"`_ field "edp_jobs_flows"
Object has sections of array-type.
Required: type
+-------------------+--------+----------+-----------+-----------------------------------------------------------------------------+
| Fields | Type | Required | Default | Value |
+===================+========+==========+===========+=============================================================================+
| type | string | True | | "Pig", "Java", "MapReduce", "MapReduce.Streaming", "Hive", "Spark", "Shell" |
+-------------------+--------+----------+-----------+-----------------------------------------------------------------------------+
| input_datasource | object | | | see `section "input_datasource"`_ |
+-------------------+--------+----------+-----------+-----------------------------------------------------------------------------+
| output_datasource | object | | | see `section "output_datasource"`_ |
+-------------------+--------+----------+-----------+-----------------------------------------------------------------------------+
| main_lib | object | | | see `section "main_lib"`_ |
+-------------------+--------+----------+-----------+-----------------------------------------------------------------------------+
| additional_libs | object | | | see `section "additional_libs"`_ |
+-------------------+--------+----------+-----------+-----------------------------------------------------------------------------+
| configs | dict | | Empty | config: value |
+-------------------+--------+----------+-----------+-----------------------------------------------------------------------------+
| args | array | | Empty | array of args |
+-------------------+--------+----------+-----------+-----------------------------------------------------------------------------+
Section "input_datasource"
--------------------------
Required: type, source
This section is dictionary-type.
+---------------+--------+----------+-----------+---------------------------+
| Fields | Type | Required | Default | Value |
+===============+========+==========+===========+===========================+
| type | string | True | | "swift", "hdfs", "maprfs" |
+---------------+--------+----------+-----------+---------------------------+
| hdfs_username | string | | | username for hdfs |
+---------------+--------+----------+-----------+---------------------------+
| source | string | True | | uri of source |
+---------------+--------+----------+-----------+---------------------------+
Section "output_datasource"
---------------------------
Required: type, destination
This section is dictionary-type.
+-------------+--------+----------+-----------+---------------------------+
| Fields | Type | Required | Default | Value |
+=============+========+==========+===========+===========================+
| type | string | True | | "swift", "hdfs", "maprfs" |
+-------------+--------+----------+-----------+---------------------------+
| destination | string | True | | uri of source |
+-------------+--------+----------+-----------+---------------------------+
Section "main_lib"
------------------
Required: type, source
This section is dictionary-type.
+--------+--------+----------+-----------+----------------------+
| Fields | Type | Required | Default | Value |
+========+========+==========+===========+======================+
| type | string | True | | "swift or "database" |
+--------+--------+----------+-----------+----------------------+
| source | string | True | | uri of source |
+--------+--------+----------+-----------+----------------------+
Section "additional_libs"
-------------------------
Required: type, source
This section is an array-type.
+--------+--------+----------+-----------+----------------------+
| Fields | Type | Required | Default | Value |
+========+========+==========+===========+======================+
| type | string | True | | "swift or "database" |
+--------+--------+----------+-----------+----------------------+
| source | string | True | | uri of source |
+--------+--------+----------+-----------+----------------------+