Codebase list cinder-tempest-plugin / 7006aa8
Fix wrong links in Cinder Some docs links have changed. We should update the wrong links in our codes. Change-Id: I5046be23703192ed6fad805355c8c50b9b4a71c8 yanghuichan authored 8 years ago Sean McGinnis committed 8 years ago
22 changed file(s) with 1 addition(s) and 420 deletion(s). Raw diff Collapse all Expand all
+1
-1
cinder/tests/tempest/README.rst less more
44 This directory contains additional Cinder tempest tests.
55
66 See the tempest plugin docs for information on using it:
7 http://docs.openstack.org/developer/tempest/plugin.html#using-plugins
7 https://docs.openstack.org/tempest/latest/plugin.html#using-plugins
88
99 To run all tests from this plugin, install cinder into your environment. Then
1010 from the tempest directory run::
+0
-5
doc/source/admin/index.rst less more
0 ====================
1 Administrators guide
2 ====================
3
4 Administrators guide of cinder_tempest_plugin.
+0
-5
doc/source/cli/index.rst less more
0 ================================
1 Command line interface reference
2 ================================
3
4 CLI reference of cinder_tempest_plugin.
+0
-81
doc/source/conf.py less more
0 # -*- coding: utf-8 -*-
1 # Licensed under the Apache License, Version 2.0 (the "License");
2 # you may not use this file except in compliance with the License.
3 # You may obtain a copy of the License at
4 #
5 # http://www.apache.org/licenses/LICENSE-2.0
6 #
7 # Unless required by applicable law or agreed to in writing, software
8 # distributed under the License is distributed on an "AS IS" BASIS,
9 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10 # implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13
14 import os
15 import sys
16
17 sys.path.insert(0, os.path.abspath('../..'))
18 # -- General configuration ----------------------------------------------------
19
20 # Add any Sphinx extension module names here, as strings. They can be
21 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
22 extensions = [
23 'sphinx.ext.autodoc',
24 'openstackdocstheme',
25 #'sphinx.ext.intersphinx',
26 ]
27
28 # autodoc generation is a bit aggressive and a nuisance when doing heavy
29 # text edit cycles.
30 # execute "export SPHINX_DEBUG=1" in your terminal to disable
31
32 # The suffix of source filenames.
33 source_suffix = '.rst'
34
35 # The master toctree document.
36 master_doc = 'index'
37
38 # General information about the project.
39 project = u'cinder-tempest-plugin'
40 copyright = u'2017, OpenStack Developers'
41
42 # openstackdocstheme options
43 repository_name = 'cinder_tempest_plugin/cinder_tempest_plugin'
44 bug_project = 'cinder_tempest_plugin'
45 bug_tag = ''
46
47 # If true, '()' will be appended to :func: etc. cross-reference text.
48 add_function_parentheses = True
49
50 # If true, the current module name will be prepended to all description
51 # unit titles (such as .. function::).
52 add_module_names = True
53
54 # The name of the Pygments (syntax highlighting) style to use.
55 pygments_style = 'sphinx'
56
57 # -- Options for HTML output --------------------------------------------------
58
59 # The theme to use for HTML and HTML Help pages. Major themes that come with
60 # Sphinx are currently 'default' and 'sphinxdoc'.
61 # html_theme_path = ["."]
62 # html_theme = '_theme'
63 # html_static_path = ['static']
64 html_theme = 'openstackdocs'
65
66 # Output file base name for HTML help builder.
67 htmlhelp_basename = '%sdoc' % project
68
69 # Grouping the document tree into LaTeX files. List of tuples
70 # (source start file, target name, title, author, documentclass
71 # [howto/manual]).
72 latex_documents = [
73 ('index',
74 '%s.tex' % project,
75 u'%s Documentation' % project,
76 u'OpenStack Developers', 'manual'),
77 ]
78
79 # Example configuration for intersphinx: refer to the Python standard library.
80 #intersphinx_mapping = {'http://docs.python.org/': None}
+0
-5
doc/source/configuration/index.rst less more
0 =============
1 Configuration
2 =============
3
4 Configuration of cinder_tempest_plugin.
+0
-4
doc/source/contributor/contributing.rst less more
0 ============
1 Contributing
2 ============
3 .. include:: ../../../CONTRIBUTING.rst
+0
-9
doc/source/contributor/index.rst less more
0 ===========================
1 Contributor Documentation
2 ===========================
3
4 .. toctree::
5 :maxdepth: 2
6
7 contributing
8
+0
-30
doc/source/index.rst less more
0 .. cinder_tempest_plugin documentation master file, created by
1 sphinx-quickstart on Tue Jul 9 22:26:36 2013.
2 You can adapt this file completely to your liking, but it should at least
3 contain the root `toctree` directive.
4
5 =====================================================
6 Welcome to the documentation of cinder_tempest_plugin
7 =====================================================
8
9 Contents:
10
11 .. toctree::
12 :maxdepth: 2
13
14 readme
15 install/index
16 library/index
17 contributor/index
18 configuration/index
19 cli/index
20 user/index
21 admin/index
22 reference/index
23
24 Indices and tables
25 ==================
26
27 * :ref:`genindex`
28 * :ref:`modindex`
29 * :ref:`search`
+0
-10
doc/source/install/common_configure.rst less more
0 2. Edit the ``/etc/cinder_tempest_plugin/cinder_tempest_plugin.conf`` file and complete the following
1 actions:
2
3 * In the ``[database]`` section, configure database access:
4
5 .. code-block:: ini
6
7 [database]
8 ...
9 connection = mysql+pymysql://cinder_tempest_plugin:CINDER_TEMPEST_PLUGIN_DBPASS@controller/cinder_tempest_plugin
+0
-75
doc/source/install/common_prerequisites.rst less more
0 Prerequisites
1 -------------
2
3 Before you install and configure the volume service,
4 you must create a database, service credentials, and API endpoints.
5
6 #. To create the database, complete these steps:
7
8 * Use the database access client to connect to the database
9 server as the ``root`` user:
10
11 .. code-block:: console
12
13 $ mysql -u root -p
14
15 * Create the ``cinder_tempest_plugin`` database:
16
17 .. code-block:: none
18
19 CREATE DATABASE cinder_tempest_plugin;
20
21 * Grant proper access to the ``cinder_tempest_plugin`` database:
22
23 .. code-block:: none
24
25 GRANT ALL PRIVILEGES ON cinder_tempest_plugin.* TO 'cinder_tempest_plugin'@'localhost' \
26 IDENTIFIED BY 'CINDER_TEMPEST_PLUGIN_DBPASS';
27 GRANT ALL PRIVILEGES ON cinder_tempest_plugin.* TO 'cinder_tempest_plugin'@'%' \
28 IDENTIFIED BY 'CINDER_TEMPEST_PLUGIN_DBPASS';
29
30 Replace ``CINDER_TEMPEST_PLUGIN_DBPASS`` with a suitable password.
31
32 * Exit the database access client.
33
34 .. code-block:: none
35
36 exit;
37
38 #. Source the ``admin`` credentials to gain access to
39 admin-only CLI commands:
40
41 .. code-block:: console
42
43 $ . admin-openrc
44
45 #. To create the service credentials, complete these steps:
46
47 * Create the ``cinder_tempest_plugin`` user:
48
49 .. code-block:: console
50
51 $ openstack user create --domain default --password-prompt cinder_tempest_plugin
52
53 * Add the ``admin`` role to the ``cinder_tempest_plugin`` user:
54
55 .. code-block:: console
56
57 $ openstack role add --project service --user cinder_tempest_plugin admin
58
59 * Create the cinder_tempest_plugin service entities:
60
61 .. code-block:: console
62
63 $ openstack service create --name cinder_tempest_plugin --description "volume" volume
64
65 #. Create the volume service API endpoints:
66
67 .. code-block:: console
68
69 $ openstack endpoint create --region RegionOne \
70 volume public http://controller:XXXX/vY/%\(tenant_id\)s
71 $ openstack endpoint create --region RegionOne \
72 volume internal http://controller:XXXX/vY/%\(tenant_id\)s
73 $ openstack endpoint create --region RegionOne \
74 volume admin http://controller:XXXX/vY/%\(tenant_id\)s
+0
-9
doc/source/install/get_started.rst less more
0 =======================
1 volume service overview
2 =======================
3 The volume service provides...
4
5 The volume service consists of the following components:
6
7 ``cinder_tempest_plugin-api`` service
8 Accepts and responds to end user compute API calls...
+0
-17
doc/source/install/index.rst less more
0 =================================
1 volume service installation guide
2 =================================
3
4 .. toctree::
5 :maxdepth: 2
6
7 get_started.rst
8 install.rst
9 verify.rst
10 next-steps.rst
11
12 The volume service (cinder_tempest_plugin) provides...
13
14 This chapter assumes a working setup of OpenStack following the
15 `OpenStack Installation Tutorial
16 <https://docs.openstack.org/project-install-guide/ocata/>`_.
+0
-34
doc/source/install/install-obs.rst less more
0 .. _install-obs:
1
2
3 Install and configure for openSUSE and SUSE Linux Enterprise
4 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
6 This section describes how to install and configure the volume service
7 for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1.
8
9 .. include:: common_prerequisites.rst
10
11 Install and configure components
12 --------------------------------
13
14 #. Install the packages:
15
16 .. code-block:: console
17
18 # zypper --quiet --non-interactive install
19
20 .. include:: common_configure.rst
21
22
23 Finalize installation
24 ---------------------
25
26 Start the volume services and configure them to start when
27 the system boots:
28
29 .. code-block:: console
30
31 # systemctl enable openstack-cinder_tempest_plugin-api.service
32
33 # systemctl start openstack-cinder_tempest_plugin-api.service
+0
-33
doc/source/install/install-rdo.rst less more
0 .. _install-rdo:
1
2 Install and configure for Red Hat Enterprise Linux and CentOS
3 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4
5
6 This section describes how to install and configure the volume service
7 for Red Hat Enterprise Linux 7 and CentOS 7.
8
9 .. include:: common_prerequisites.rst
10
11 Install and configure components
12 --------------------------------
13
14 #. Install the packages:
15
16 .. code-block:: console
17
18 # yum install
19
20 .. include:: common_configure.rst
21
22 Finalize installation
23 ---------------------
24
25 Start the volume services and configure them to start when
26 the system boots:
27
28 .. code-block:: console
29
30 # systemctl enable openstack-cinder_tempest_plugin-api.service
31
32 # systemctl start openstack-cinder_tempest_plugin-api.service
+0
-31
doc/source/install/install-ubuntu.rst less more
0 .. _install-ubuntu:
1
2 Install and configure for Ubuntu
3 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4
5 This section describes how to install and configure the volume
6 service for Ubuntu 14.04 (LTS).
7
8 .. include:: common_prerequisites.rst
9
10 Install and configure components
11 --------------------------------
12
13 #. Install the packages:
14
15 .. code-block:: console
16
17 # apt-get update
18
19 # apt-get install
20
21 .. include:: common_configure.rst
22
23 Finalize installation
24 ---------------------
25
26 Restart the volume services:
27
28 .. code-block:: console
29
30 # service openstack-cinder_tempest_plugin-api restart
+0
-20
doc/source/install/install.rst less more
0 .. _install:
1
2 Install and configure
3 ~~~~~~~~~~~~~~~~~~~~~
4
5 This section describes how to install and configure the
6 volume service, code-named cinder_tempest_plugin, on the controller node.
7
8 This section assumes that you already have a working OpenStack
9 environment with at least the following components installed:
10 .. (add the appropriate services here and further notes)
11
12 Note that installation and configuration vary by distribution.
13
14 .. toctree::
15 :maxdepth: 2
16
17 install-obs.rst
18 install-rdo.rst
19 install-ubuntu.rst
+0
-9
doc/source/install/next-steps.rst less more
0 .. _next-steps:
1
2 Next steps
3 ~~~~~~~~~~
4
5 Your OpenStack environment now includes the cinder_tempest_plugin service.
6
7 To add additional services, see
8 https://docs.openstack.org/project-install-guide/ocata/.
+0
-24
doc/source/install/verify.rst less more
0 .. _verify:
1
2 Verify operation
3 ~~~~~~~~~~~~~~~~
4
5 Verify operation of the volume service.
6
7 .. note::
8
9 Perform these commands on the controller node.
10
11 #. Source the ``admin`` project credentials to gain access to
12 admin-only CLI commands:
13
14 .. code-block:: console
15
16 $ . admin-openrc
17
18 #. List service components to verify successful launch and registration
19 of each process:
20
21 .. code-block:: console
22
23 $ openstack volume service list
+0
-7
doc/source/library/index.rst less more
0 ========
1 Usage
2 ========
3
4 To use cinder_tempest_plugin in a project::
5
6 import cinder_tempest_plugin
+0
-1
doc/source/readme.rst less more
0 .. include:: ../../README.rst
+0
-5
doc/source/reference/index.rst less more
0 ==========
1 References
2 ==========
3
4 References of cinder_tempest_plugin.
+0
-5
doc/source/user/index.rst less more
0 ===========
1 Users guide
2 ===========
3
4 Users guide of cinder_tempest_plugin.