Add tempest_telemetry
[functest.git] / docs / release / release-notes / functest-release.rst
1 .. SPDX-License-Identifier: CC-BY-4.0
2
3 ======================================
4 OPNFV master release note for Functest
5 ======================================
6
7 Abstract
8 ========
9
10 This document contains the release notes of the Functest project.
11
12 OPNFV master Release
13 ====================
14
15 Functest deals with functional testing of the OPNFV solution.
16 It includes test cases developed within the project, test cases developed in
17 other OPNFV projects and it also integrates test cases from other upstream
18 communities.
19
20 OpenStack
21 ---------
22
23 The internal test cases are:
24
25  * connection_check
26  * tenantnetwork1
27  * tenantnetwork2
28  * vmready1
29  * vmready2
30  * singlevm1
31  * singlevm2
32  * vping_ssh
33  * vping_userdata
34  * cinder_test
35  * tempest_smoke
36  * tempest_horizon
37  * odl
38  * tempest_neutron
39  * tempest_cinder
40  * tempest_keystone
41  * tempest_heat
42  * tempest_telemetry
43  * rally_sanity
44  * refstack_compute
45  * refstack_object
46  * refstack_platform
47  * tempest_full
48  * tempest_scenario
49  * tempest_slow
50  * patrole
51  * barbican
52  * neutron_trunk
53  * networking-bgpvpn
54  * networking-sfc
55  * octavia
56  * rally_full
57  * rally_jobs
58  * vmtp
59  * shaker
60  * cloudify
61  * cloudify_ims
62  * heat_ims
63  * vyos_vrouter
64  * juju_epc
65
66 Kubernetes
67 ----------
68
69 The internal test cases are:
70
71  * k8s_smoke
72  * xrally_kubernetes
73  * k8s_conformance
74
75 Release Data
76 ============
77
78 +--------------------------------------+--------------------------------------+
79 | **Project**                          | functest                             |
80 +--------------------------------------+--------------------------------------+
81 | **Repository branch**                | master                               |
82 +--------------------------------------+--------------------------------------+
83
84 Deliverables
85 ============
86
87 Software
88 --------
89
90  Functest Docker images (OpenStack):
91
92  * https://hub.docker.com/r/opnfv/functest-healthcheck
93  * https://hub.docker.com/r/opnfv/functest-smoke
94  * https://hub.docker.com/r/opnfv/functest-benchmarking
95  * https://hub.docker.com/r/opnfv/functest-vnf
96  * https://hub.docker.com/r/opnfv/functest-smoke-cntt
97  * https://hub.docker.com/r/opnfv/functest-benchmarking-cntt
98
99  Functest Docker images (Kubernetes):
100
101  * https://hub.docker.com/r/opnfv/functest-kubernetes-healthcheck
102  * https://hub.docker.com/r/opnfv/functest-kubernetes-smoke
103
104 Docker tag for master: latest
105
106 Documents
107 ---------
108
109  * Functest Guides: https://functest.readthedocs.io/en/latest/
110  * API Docs: https://functest-api.readthedocs.io/en/latest/
111
112 Version change
113 ==============
114
115 Key changes
116 -----------
117
118  * update testcases and containers to `OpenStack master`_ and to
119    `Kubernetes master`_
120
121 .. _`OpenStack master`: https://github.com/openstack/requirements/blob/master/upper-constraints.txt
122 .. _`Kubernetes master`: https://github.com/kubernetes/kubernetes
123
124 Key benefits
125 ------------
126
127  * the enduser can easily deploy its own `Functest toolchains`_ in few commands
128  * everyone can pick stable Functest rolling releases (latest included)
129  * Functest can verify VIM in production even on `Raspberry PI`_
130  * all testcases can run in parallel (tested with 4 executors in our gates)
131  * no remaining resources detected in our gates after multiple runs
132
133 .. _`Functest toolchains`: https://wiki.opnfv.org/pages/viewpage.action?pageId=32015004
134 .. _`Raspberry PI`: https://wiki.opnfv.org/display/functest/Run+Functest+containers+on+Raspberry+PI
135
136 Code quality
137 ------------
138
139  * pylint: 10.00/10
140  * code coverage: 70%
141
142 Useful links
143 ============
144
145  * wiki project page: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
146  * Functest git repository: https://github.com/opnfv/functest
147  * Functest CI dashboard: https://build.opnfv.org/ci/view/functest/
148  * JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611
149  * Functest IRC channel: #opnfv-functest
150  * Reporting page: http://testresults.opnfv.org/reporting/master/functest/functest.html