Add linters for normalized formatting
This aligns with the stx-specs repo and fixes existing issues with the current doc set. Change-Id: Iefb1e70481ada6c2cd0e2d037e7bd525af862c7b Signed-off-by: Robert Church <robert.church@windriver.com>
This commit is contained in:
parent
6536f9cdb0
commit
d00f27a6d9
|
@ -1,3 +1,4 @@
|
||||||
|
---
|
||||||
- project:
|
- project:
|
||||||
templates:
|
templates:
|
||||||
- build-openstack-docs-pti
|
- build-openstack-docs-pti
|
||||||
|
|
|
@ -2,17 +2,20 @@
|
||||||
GNOCCHI
|
GNOCCHI
|
||||||
=======
|
=======
|
||||||
|
|
||||||
Gnocchi is an open-source time series database, the problem that Gnocchi solves is the storage and
|
Gnocchi is an open-source time series database, the problem that Gnocchi solves
|
||||||
indexing of time series data and resources at a large scale. This is useful in modern cloud
|
is the storage and indexing of time series data and resources at a large scale.
|
||||||
platforms which are not only huge but also are dynamic and potentially multi-tenant. Gnocchi takes
|
This is useful in modern cloud platforms which are not only huge but also are
|
||||||
all of that into account. Gnocchi has been designed to handle large amounts of aggregates being
|
dynamic and potentially multi-tenant. Gnocchi takes all of that into account.
|
||||||
stored while being performant, scalable and fault-tolerant. While doing this, the goal was to be
|
Gnocchi has been designed to handle large amounts of aggregates being stored
|
||||||
sure to not build any hard dependency on any complex storage system.
|
while being performant, scalable and fault-tolerant. While doing this, the goal
|
||||||
Gnocchi takes a unique approach to time series storage: rather than storing raw data points, it
|
was to be sure to not build any hard dependency on any complex storage system.
|
||||||
aggregates them before storing them. This built-in feature is different from most other time series
|
Gnocchi takes a unique approach to time series storage: rather than storing raw
|
||||||
databases, which usually support this mechanism as an option and compute aggregation
|
data points, it aggregates them before storing them. This built-in feature is
|
||||||
(average, minimum, etc.) at query time. Because Gnocchi computes all the aggregations at ingestion
|
different from most other time series databases, which usually support this
|
||||||
getting the data back is extremely fast, as it just needs to read back the pre-computed results.
|
mechanism as an option and compute aggregation (average, minimum, etc.) at
|
||||||
|
query time. Because Gnocchi computes all the aggregations at ingestion getting
|
||||||
|
the data back is extremely fast, as it just needs to read back the pre-computed
|
||||||
|
results.
|
||||||
|
|
||||||
|
|
||||||
--------------------
|
--------------------
|
||||||
|
@ -35,7 +38,8 @@ Gnocchi_01
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
|
|
||||||
:Test ID: Gnocchi_01
|
:Test ID: Gnocchi_01
|
||||||
:Test Title: Logs - gnocchi api.log reports listening (address and port in gnocchi-api.conf)
|
:Test Title: Logs - gnocchi api.log reports listening (address and port in
|
||||||
|
gnocchi-api.conf)
|
||||||
:Tags: Gnocchi
|
:Tags: Gnocchi
|
||||||
|
|
||||||
++++++++++++++
|
++++++++++++++
|
||||||
|
@ -55,7 +59,8 @@ Environment setup
|
||||||
Test Steps
|
Test Steps
|
||||||
++++++++++
|
++++++++++
|
||||||
|
|
||||||
1. Confirm the address corresponds to what is defined in the gnocchi-api.conf file
|
1. Confirm the address corresponds to what is defined in the gnocchi-api.conf
|
||||||
|
file
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -66,7 +71,8 @@ Test Steps
|
||||||
[2018-08-13 14:16:14 +0000] [194853] [INFO] Using worker: sync
|
[2018-08-13 14:16:14 +0000] [194853] [INFO] Using worker: sync
|
||||||
[2018-08-13 14:16:14 +0000] [195045] [INFO] Booting worker with pid: 195045
|
[2018-08-13 14:16:14 +0000] [195045] [INFO] Booting worker with pid: 195045
|
||||||
|
|
||||||
2. Confirm new gnocchi-api and metricd files exist on the controllers in the following location
|
2. Confirm new gnocchi-api and metricd files exist on the controllers in the
|
||||||
|
following location
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -75,7 +81,8 @@ Test Steps
|
||||||
-rwxrwxr-x. 1 root root ... gnocchi-metricd
|
-rwxrwxr-x. 1 root root ... gnocchi-metricd
|
||||||
|
|
||||||
|
|
||||||
3. Confirm the new gnocchi config files and py files are in the /usr/share/gnocchi location
|
3. Confirm the new gnocchi config files and py files are in the
|
||||||
|
/usr/share/gnocchi location
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -86,7 +93,8 @@ Test Steps
|
||||||
gnocchi-api.pyc
|
gnocchi-api.pyc
|
||||||
gnocchi-api.pyo
|
gnocchi-api.pyo
|
||||||
|
|
||||||
4. The gnocchi log & config file locations are specified in the /etc/init.d/gnocchi-api file.
|
4. The gnocchi log & config file locations are specified in the
|
||||||
|
/etc/init.d/gnocchi-api file.
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -101,7 +109,8 @@ Test Steps
|
||||||
|
|
||||||
eg. default folder #log_dir is /var/log/gnocchi
|
eg. default folder #log_dir is /var/log/gnocchi
|
||||||
|
|
||||||
6. Confirm new gnocchi log folder and logs have been created at /var/log/gnocchi/
|
6. Confirm new gnocchi log folder and logs have been created at
|
||||||
|
/var/log/gnocchi/
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -113,7 +122,8 @@ Expected Behavior
|
||||||
|
|
||||||
1. Address corresponds to what is defined in the gnocchi-api.conf file
|
1. Address corresponds to what is defined in the gnocchi-api.conf file
|
||||||
2. Files gnocchi-api and metricd should appear under /etc/init.d
|
2. Files gnocchi-api and metricd should appear under /etc/init.d
|
||||||
3. New gnocchi config files and py files are in place at /usr/share/gnocchi
|
3. New gnocchi config files and py files are in place at /usr/share/gnocchi
|
||||||
4. Gnocchi log & config file locations should be specified in the /etc/init.d/gnocchi-api file
|
4. Gnocchi log & config file locations should be specified in the
|
||||||
|
/etc/init.d/gnocchi-api file
|
||||||
5. Folder should be confirmed in gnocchi-dist.conf
|
5. Folder should be confirmed in gnocchi-dist.conf
|
||||||
6. New gnocchi log folder and logs have been created
|
6. New gnocchi log folder and logs have been created
|
||||||
|
|
|
@ -20,7 +20,8 @@ HEAT_HOT_Template_01
|
||||||
Testcase Objective
|
Testcase Objective
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
This test case verify that HEAT can create a cinder volume successfully with HOT template.
|
This test case verify that HEAT can create a cinder volume successfully with
|
||||||
|
HOT template.
|
||||||
|
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
Test Pre-Conditions
|
Test Pre-Conditions
|
||||||
|
@ -30,17 +31,17 @@ a) An image with the name of cirros available
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
Export openstack_helm authentication - go to [0] for details.
|
Export openstack_helm authentication - go to [0] for details.
|
||||||
|
|
||||||
$ wget http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img
|
$ wget http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img
|
||||||
|
|
||||||
$ openstack image create --file cirros-0.4.0-x86_64-disk.img --disk-format qcow2 --public cirros
|
$ openstack image create --file cirros-0.4.0-x86_64-disk.img --disk-format qcow2 --public cirros
|
||||||
|
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
Test Steps
|
Test Steps
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
|
|
||||||
1. Create Heat stack using <cinder_volume.yaml>
|
1. Create Heat stack using <cinder_volume.yaml>
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -48,18 +49,18 @@ Test Steps
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
i.e.
|
i.e.
|
||||||
+---------------------+--------------------------------------+
|
+---------------------+--------------------------------------+
|
||||||
| Field | Value |
|
| Field | Value |
|
||||||
+---------------------+--------------------------------------+
|
+---------------------+--------------------------------------+
|
||||||
| id | caa42023-0669-4825-a024-28ebcbf0e3e2 |
|
| id | caa42023-0669-4825-a024-28ebcbf0e3e2 |
|
||||||
| stack_name | Volumefer | | description | Launch a cinder volume cirros image. |
|
| stack_name | Volumefer | | description | Launch a cinder volume cirros image. |
|
||||||
| creation_time | 2019-02-22T15:18:23Z |
|
| creation_time | 2019-02-22T15:18:23Z |
|
||||||
| updated_time | None | | stack_status | CREATE_IN_PROGRESS |
|
| updated_time | None | | stack_status | CREATE_IN_PROGRESS |
|
||||||
| stack_status_reason | Stack CREATE started |
|
| stack_status_reason | Stack CREATE started |
|
||||||
+---------------------+--------------------------------------+
|
+---------------------+--------------------------------------+
|
||||||
|
|
||||||
2.Delete the stack
|
2.Delete the stack
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -69,36 +70,37 @@ Test Steps
|
||||||
Expected Behavior
|
Expected Behavior
|
||||||
~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
1. Verify 1GB cinder volume is successfully created.
|
1. Verify 1GB cinder volume is successfully created.
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
$ openstack stack show <volume_name>
|
$ openstack stack show <volume_name>
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
i.e.
|
i.e.
|
||||||
$ openstack stack show Volumefer
|
$ openstack stack show Volumefer
|
||||||
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Field | Value |
|
| Field | Value |
|
||||||
+========================+===========================================================================================================================================+
|
+========================+===========================================================================================================================================+
|
||||||
| id | c0a18394-d5fc-441c-bcd9-2f3bb3fb6592 |
|
| id | c0a18394-d5fc-441c-bcd9-2f3bb3fb6592 |
|
||||||
| stack_name | Volumefer |
|
| stack_name | Volumefer |
|
||||||
| description | Launch a cinder volume cirros image. |
|
| description | Launch a cinder volume cirros image. |
|
||||||
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| ... | ... |
|
| ... | ... |
|
||||||
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| outputs | description: Volume |
|
| outputs | description: Volume |
|
||||||
| output_key: volume_size| |
|
| output_key: volume_size| |
|
||||||
| output_value: '1' | |
|
| output_value: '1' | |
|
||||||
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| ... | ... |
|
| ... | ... |
|
||||||
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
2. Verify the STACK and the resources is deleted Openstack stack list (STACK should not be there in the list)
|
2. Verify the STACK and the resources is deleted Openstack stack list (STACK
|
||||||
|
should not be there in the list)
|
||||||
|
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
<cinder_volume.yaml>
|
<cinder_volume.yaml>
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
::
|
::
|
||||||
|
@ -131,43 +133,44 @@ HEAT_HOT_Template_12
|
||||||
Testcase Objective
|
Testcase Objective
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
This test case verify that HEAT can create a Nova Server successfully with HOT template.
|
This test case verify that HEAT can create a Nova Server successfully with HOT
|
||||||
|
template.
|
||||||
|
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
Test Pre-Conditions
|
Test Pre-Conditions
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
a) An image with the name of cirros available
|
a) An image with the name of cirros available
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
i.e.
|
i.e.
|
||||||
Export openstack_helm authentication
|
Export openstack_helm authentication
|
||||||
$ export OS_CLOUD=openstack_helm
|
$ export OS_CLOUD=openstack_helm
|
||||||
REMARK: go to [0] for details.
|
REMARK: go to [0] for details.
|
||||||
|
|
||||||
$ wget http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img
|
$ wget http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img
|
||||||
|
|
||||||
$ openstack image create --file cirros-0.4.0-x86_64-disk.img --disk-format qcow2 --public cirros
|
$ openstack image create --file cirros-0.4.0-x86_64-disk.img --disk-format qcow2 --public cirros
|
||||||
|
|
||||||
b) A flavor with the name flavor_name.type available.
|
b) A flavor with the name flavor_name.type available.
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
i.e.
|
i.e.
|
||||||
$ openstack flavor create --public --id 1 --ram 512 --vcpus 1 --disk 4 flavor_name.type
|
$ openstack flavor create --public --id 1 --ram 512 --vcpus 1 --disk 4 flavor_name.type
|
||||||
REMARK: go to [1] for type of flavors.
|
REMARK: go to [1] for type of flavors.
|
||||||
|
|
||||||
c) A network available
|
c) A network available
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
i.e.
|
i.e.
|
||||||
$ openstack network create net
|
$ openstack network create net
|
||||||
|
|
||||||
$ openstack subnet create --network net --ip-version 4 --subnet-range 192.168.0.0/24 --dhcp net-subnet1
|
$ openstack subnet create --network net --ip-version 4 --subnet-range 192.168.0.0/24 --dhcp net-subnet1
|
||||||
|
|
||||||
d) Execute the following command to take the network id
|
d) Execute the following command to take the network id
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -184,7 +187,7 @@ Test Steps
|
||||||
|
|
||||||
$ openstack stack create --template nova_server.yaml stack_demo --parameter "NetID=$NET_ID"
|
$ openstack stack create --template nova_server.yaml stack_demo --parameter "NetID=$NET_ID"
|
||||||
|
|
||||||
2. Delete the stack
|
2. Delete the stack
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -194,11 +197,11 @@ Test Steps
|
||||||
Expected Behavior
|
Expected Behavior
|
||||||
~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
1. Verify Stack is successfully created and new nova instance is created.
|
1. Verify Stack is successfully created and new nova instance is created.
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
$ openstack stack list
|
$ openstack stack list
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@ -209,21 +212,21 @@ Expected Behavior
|
||||||
|380bb224-4c41-4b25-b4e8-7291bb1f3129 | stack_demo | 3cfea8788a9c4323937e730e1a7cbf18 | CREATE_COMPLETE | 2019-02-22T11:36:17Z | 2019-02-22T11:36:25Z |
|
|380bb224-4c41-4b25-b4e8-7291bb1f3129 | stack_demo | 3cfea8788a9c4323937e730e1a7cbf18 | CREATE_COMPLETE | 2019-02-22T11:36:17Z | 2019-02-22T11:36:25Z |
|
||||||
+--------------------------------------+------------+----------------------------------+-----------------+----------------------+----------------------+
|
+--------------------------------------+------------+----------------------------------+-----------------+----------------------+----------------------+
|
||||||
|
|
||||||
2. Verify the STACK and the resources is deleted $ openstack stack list
|
2. Verify the STACK and the resources is deleted $ openstack stack list
|
||||||
|
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
<nova_server.yaml>
|
<nova_server.yaml>
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
heat_template_version: 2015-10-15
|
heat_template_version: 2015-10-15
|
||||||
description: Launch a basic instance with CirrOS image using the ``demo1.tiny`` flavor, ``mykey`` key, and one network.
|
description: Launch a basic instance with CirrOS image using the ``demo1.tiny`` flavor, ``mykey`` key, and one network.
|
||||||
parameters:
|
parameters:
|
||||||
NetID:
|
NetID:
|
||||||
type: string
|
type: string
|
||||||
description: Network ID to use for the instance.
|
description: Network ID to use for the instance.
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
server:
|
server:
|
||||||
type: OS::Nova::Server
|
type: OS::Nova::Server
|
||||||
|
@ -233,7 +236,7 @@ Expected Behavior
|
||||||
key_name:
|
key_name:
|
||||||
networks:
|
networks:
|
||||||
- network: { get_param: NetID }
|
- network: { get_param: NetID }
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
instance_name:
|
instance_name:
|
||||||
description: Name of the instance
|
description: Name of the instance
|
||||||
|
@ -242,7 +245,7 @@ Expected Behavior
|
||||||
description: IP address of the instance.
|
description: IP address of the instance.
|
||||||
value: { get_attr: [ server, first_address ] }
|
value: { get_attr: [ server, first_address ] }
|
||||||
|
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
References:
|
References:
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
[0] - [https://wiki.openstack.org/wiki/StarlingX/Containers/Installation]
|
[0] - [https://wiki.openstack.org/wiki/StarlingX/Containers/Installation]
|
||||||
|
|
|
@ -2,7 +2,9 @@
|
||||||
HEAT
|
HEAT
|
||||||
====
|
====
|
||||||
|
|
||||||
HEAT is a service to orchestrate composite cloud applications using a declarative template format through an OpenStack-native REST API. This test suite validates the basics of HEAT service by using HOT templates.
|
HEAT is a service to orchestrate composite cloud applications using a
|
||||||
|
declarative template format through an OpenStack-native REST API. This test
|
||||||
|
suite validates the basics of HEAT service by using HOT templates.
|
||||||
|
|
||||||
-----------------
|
-----------------
|
||||||
Test Requirements
|
Test Requirements
|
||||||
|
|
|
@ -2,10 +2,10 @@
|
||||||
NETWORKING
|
NETWORKING
|
||||||
==========
|
==========
|
||||||
|
|
||||||
Networking contains all the testcases according with connectivity and addressing
|
Networking contains all the testcases according with connectivity and
|
||||||
int the cloud. It handles the creation and management of a virtual networking
|
addressing int the cloud. It handles the creation and management of a virtual
|
||||||
infrastructure, including networks, switches, subnets, and routers for devices
|
networking infrastructure, including networks, switches, subnets, and routers
|
||||||
managed fy the OpenStack Compute service.
|
for devices managed fy the OpenStack Compute service.
|
||||||
|
|
||||||
-----------------
|
-----------------
|
||||||
Test Requirements
|
Test Requirements
|
||||||
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
PyYAML>=3.1.0
|
||||||
|
yamllint>=0.5.2
|
||||||
|
doc8
|
11
tox.ini
11
tox.ini
|
@ -10,6 +10,7 @@ setenv = VIRTUAL_ENV={envdir}
|
||||||
OS_STDERR_CAPTURE=1
|
OS_STDERR_CAPTURE=1
|
||||||
OS_TEST_TIMEOUT=60
|
OS_TEST_TIMEOUT=60
|
||||||
PYTHONDONTWRITEBYTECODE=True
|
PYTHONDONTWRITEBYTECODE=True
|
||||||
|
deps = -r{toxinidir}/test-requirements.txt
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
|
@ -19,6 +20,16 @@ commands =
|
||||||
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
|
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
|
||||||
whitelist_externals = rm
|
whitelist_externals = rm
|
||||||
|
|
||||||
|
[testenv:linters]
|
||||||
|
basepython = python3
|
||||||
|
whitelist_externals = bash
|
||||||
|
commands =
|
||||||
|
bash -c "find {toxinidir} \
|
||||||
|
\( -name .tox -prune \) \
|
||||||
|
-o -type f -name '*.yaml' \
|
||||||
|
-print0 | xargs -0 yamllint"
|
||||||
|
doc8 doc/source
|
||||||
|
|
||||||
[testenv:releasenotes]
|
[testenv:releasenotes]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
deps = -r{toxinidir}/doc/requirements.txt
|
deps = -r{toxinidir}/doc/requirements.txt
|
||||||
|
|
Loading…
Reference in New Issue