openstack/openstack-helm
Code Issues Proposed changes

Remove reference to basic_launch.sh

Browse Source 
After a handful of restructuring of the project, basic_launch.sh
was removed and replaced by series of launch script. However, the
documentation was never updated to reflect this change resulting
in broken link and outdated references.  This patch set provides
the update for the documentation.

Change-Id: Iee809c1e6660f9d3c44241b58ceea2788654a304
Signed-off-by: Tin Lam <tin@irrational.io>
This commit is contained in:
Tin Lam 2018-02-26 08:47:47 -06:00
parent 9d4f9862ca
commit 621e070053
2 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/gates.rst
View File

@ -91,9 +91,10 @@ Adding Services
As charts for additional services are added to OpenStack-Helm, they should be As charts for additional services are added to OpenStack-Helm, they should be
included in the gates. Adding new services to the gates allows a chart included in the gates. Adding new services to the gates allows a chart
developer and the review team to identify any potential issues associated with developer and the review team to identify any potential issues associated with
a new service. All services are currently launched in the gate via a new service. All services are currently launched in the gate via
basic_launch.sh. Any new services are added to this file, and the required a series of launch scripts of the format ``NNN-service-name.sh`` where ``NNN``
format for a basic service is: dictates the order these scripts are launched. The script should contain
an installation command like:
:: ::
@ -119,11 +120,11 @@ Adding Tests
As new charts are developed and the services are added to the gate, an As new charts are developed and the services are added to the gate, an
associated Helm test should be introduced to the gates. The appropriate place associated Helm test should be introduced to the gates. The appropriate place
for executing these tests is in basic_launch.sh, and must be placed after the for executing these tests is in the respective service's launch script, and
entry for installing the service and any associated overrides. Any tests that must be placed after the entry for installing the service and any associated
use the Rally testing framework should leverage the helm_test_deployment overrides. Any tests that use the Rally testing framework should leverage the
function in the aforementioned funcs/helm.sh file. For example, a Helm test for helm_test_deployment function in the aforementioned funcs/helm.sh file. For
Mistral might look like: example, a Helm test for Mistral might look like:
:: ::
@ -139,6 +140,6 @@ This results in the gate running the following:
kubectl delete -n openstack pod mistral-rally-test kubectl delete -n openstack pod mistral-rally-test
Any tests that do not use the Rally testing framework would need to be handled Any tests that do not use the Rally testing framework would need to be handled
in the appropriate manner in basic_launch.sh. This would ideally result in new in the appropriate manner in launch script. This would ideally result in new
functions that could be reused, or expansion of the gate scripts to include functions that could be reused, or expansion of the gate scripts to include
scenarios beyond basic service launches. scenarios beyond basic service launches.

7
doc/source/testing.rst
View File

@ -55,7 +55,8 @@ Adding Tests
------------ ------------
All tests should be added to the gates during development, and are required for All tests should be added to the gates during development, and are required for
any new service charts prior to merging. All Helm tests are added to the gates any new service charts prior to merging. All Helm tests should be included as
in the basic_launch.sh_ file. part of the deployment script. An example of this can be seen in
this script_.
.. _basic_launch.sh: https://github.com/openstack/openstack-helm/blob/master/tools/gate/basic_launch.sh .. _script: https://github.com/openstack/openstack-helm/blob/9d4f9862ca07f08005f9bdb4e6d58ad770fa4178/tools/deployment/multinode/080-keystone.sh#L32