Add Functest CNTT-specific containers in release notes
[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  * neutron-tempest-plugin-api
39  * tempest_cinder
40  * tempest_keystone
41  * rally_sanity
42  * refstack_compute
43  * refstack_object
44  * refstack_platform
45  * tempest_full
46  * tempest_scenario
47  * tempest_slow
48  * patrole
49  * barbican
50  * neutron_trunk
51  * networking-bgpvpn
52  * networking-sfc
53  * octavia
54  * rally_full
55  * rally_jobs
56  * vmtp
57  * shaker
58  * cloudify
59  * cloudify_ims
60  * heat_ims
61  * vyos_vrouter
62  * juju_epc
63
64 Kubernetes
65 ----------
66
67 The internal test cases are:
68
69  * k8s_smoke
70  * xrally_kubernetes
71  * k8s_conformance
72
73 Release Data
74 ============
75
76 +--------------------------------------+--------------------------------------+
77 | **Project**                          | functest                             |
78 +--------------------------------------+--------------------------------------+
79 | **Repository branch**                | master                               |
80 +--------------------------------------+--------------------------------------+
81
82 Deliverables
83 ============
84
85 Software
86 --------
87
88  Functest Docker images (OpenStack):
89
90  * https://hub.docker.com/r/opnfv/functest-healthcheck
91  * https://hub.docker.com/r/opnfv/functest-smoke
92  * https://hub.docker.com/r/opnfv/functest-benchmarking
93  * https://hub.docker.com/r/opnfv/functest-vnf
94  * https://hub.docker.com/r/opnfv/functest-smoke-cntt
95  * https://hub.docker.com/r/opnfv/functest-benchmarking-cntt
96
97  Functest Docker images (Kubernetes):
98
99  * https://hub.docker.com/r/opnfv/functest-kubernetes-healthcheck
100  * https://hub.docker.com/r/opnfv/functest-kubernetes-smoke
101
102 Docker tag for master: latest
103
104 Documents
105 ---------
106
107  * Functest Guides: https://functest.readthedocs.io/en/latest/
108  * API Docs: https://functest-api.readthedocs.io/en/latest/
109
110 Version change
111 ==============
112
113 Key changes
114 -----------
115
116  * update testcases and containers to `OpenStack master`_ and to
117    `Kubernetes master`_
118
119 .. _`OpenStack master`: https://github.com/openstack/requirements/blob/master/upper-constraints.txt
120 .. _`Kubernetes master`: https://github.com/kubernetes/kubernetes
121
122 Key benefits
123 ------------
124
125  * the enduser can easily deploy its own `Functest toolchains`_ in few commands
126  * everyone can pick stable Functest rolling releases (latest included)
127  * Functest can verify VIM in production even on `Raspberry PI`_
128  * all testcases can run in parallel (tested with 4 executors in our gates)
129  * no remaining resources detected in our gates after multiple runs
130
131 .. _`Functest toolchains`: https://wiki.opnfv.org/pages/viewpage.action?pageId=32015004
132 .. _`Raspberry PI`: https://wiki.opnfv.org/display/functest/Run+Functest+containers+on+Raspberry+PI
133
134 Code quality
135 ------------
136
137  * pylint: 10.00/10
138  * code coverage: 70%
139
140 Useful links
141 ============
142
143  * wiki project page: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
144  * Functest git repository: https://github.com/opnfv/functest
145  * Functest CI dashboard: https://build.opnfv.org/ci/view/functest/
146  * JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611
147  * Functest IRC channel: #opnfv-functest
148  * Reporting page: http://testresults.opnfv.org/reporting/master/functest/functest.html