diff options
| author | chenxing <chason.chan@foxmail.com> | 2018-09-28 09:54:52 +0800 |
|---|---|---|
| committer | chenxing <chason.chan@foxmail.com> | 2018-09-28 10:01:05 +0800 |
| commit | 43e90216483d44749273cf2765e2fa3e4b008f08 (patch) | |
| tree | 9633e46dd9a9623d587c0008cc22fd5741b077b3 /doc | |
| parent | 7826ba2984911d894ff188be476bc6691290ebc8 (diff) | |
| download | kolla-43e90216483d44749273cf2765e2fa3e4b008f08.tar.gz kolla-43e90216483d44749273cf2765e2fa3e4b008f08.zip | |
Remove '.. end' comments
Following by https://review.openstack.org/#/c/605097/
These were used by now-dead tooling. We can remove them.
Change-Id: I790a18b3a40c22ec94bc6f6dba656ba4db518cfe
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/admin/image-building.rst | 78 | ||||
| -rw-r--r-- | doc/source/admin/template-override/opendaylight-source.rst | 3 | ||||
| -rw-r--r-- | doc/source/admin/template-override/ovs-dpdk.rst | 3 | ||||
| -rw-r--r-- | doc/source/contributor/running-tests.rst | 22 |
4 files changed, 0 insertions, 106 deletions
diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst index 309b4439d..4b2bed25f 100644 --- a/doc/source/admin/image-building.rst +++ b/doc/source/admin/image-building.rst @@ -35,8 +35,6 @@ testing purposes, if at all. cd kolla/ tox -e genconfig -.. end - The location of the generated configuration file is ``etc/kolla/kolla-build.conf``, it can also be copied to ``/etc/kolla``. The default location is one of ``/etc/kolla/kolla-build.conf`` or @@ -51,16 +49,12 @@ In general, images are built like this: kolla-build -.. end - * For development, run: .. code-block:: console python tools/build.py -.. end - By default, the above command would build all images based on CentOS image. The operator can change the base distro with the ``-b`` option: @@ -69,16 +63,12 @@ The operator can change the base distro with the ``-b`` option: kolla-build -b ubuntu -.. end - * For development, run: .. code-block:: console python tools/build.py -b ubuntu -.. end - There are following distros available for building images: - centos @@ -99,16 +89,12 @@ command line: kolla-build keystone -.. end - * For development, run: .. code-block:: console python tools/build.py keystone -.. end - In this case, the build script builds all images whose name contains the ``keystone`` string along with their dependencies. @@ -118,16 +104,12 @@ Multiple names may be specified on the command line: kolla-build keystone nova -.. end - * For development, run: .. code-block:: console python tools/build.py keystone nova -.. end - The set of images built can be defined as a profile in the ``profiles`` section of ``kolla-build.conf``. Later, profile can be specified by ``--profile`` CLI argument or ``profile`` option in ``kolla-build.conf``. Kolla provides some @@ -153,8 +135,6 @@ These images can be built using command line: kolla-build --profile magnum -.. end - Or put following line to ``DEFAULT`` section in ``kolla-build.conf`` file: .. path /etc/kolla/kolla-build.conf @@ -163,8 +143,6 @@ Or put following line to ``DEFAULT`` section in ``kolla-build.conf`` file: [DEFAULT] profile = magnum -.. end - The :command:`kolla-build` uses ``kolla`` as default Docker namespace. This is controlled with the ``-n`` command line option. To push images to a Dockerhub repository named ``mykollarepo``: @@ -173,8 +151,6 @@ repository named ``mykollarepo``: kolla-build -n mykollarepo --push -.. end - To push images to a `local registry <https://docs.openstack.org/kolla-ansible/latest/user/multinode.html#deploy-a-registry>`_, use ``--registry`` flag: @@ -183,8 +159,6 @@ use ``--registry`` flag: kolla-build --registry 172.22.2.81:5000 --push -.. end - Build OpenStack from source =========================== @@ -198,16 +172,12 @@ installed from source code. The default method of the OpenStack install is kolla-build -t source -.. end - * For development, run: .. code-block:: console python tools/build.py -t source -.. end - The locations of OpenStack source code are written in ``etc/kolla/kolla-build.conf``. Now the source type supports ``url``, ``git``, and ``local``. The location of @@ -237,8 +207,6 @@ The ``etc/kolla/kolla-build.conf`` file looks like: type = local location = /tmp/ironic.tar.gz -.. end - To build RHEL containers, it is necessary to include registration with RHN of the container runtime operating system.To obtain a RHN username/password/pool id, contact Red Hat. Use a template's header block @@ -249,8 +217,6 @@ overrides file, add the following: RUN subscription-manager register --user=<user-name> \ --password=<password> && subscription-manager attach --pool <pool-id> -.. end - Dockerfile Customisation ======================== @@ -290,24 +256,18 @@ First, create a file to contain the customisations, for example: RUN useradd --user-group myuser {% endblock %} -.. end - Then rebuild the horizon image, passing the ``--template-override`` argument: .. code-block:: console kolla-build --template-override template-overrides.j2 horizon -.. end - * For development, run: .. code-block:: console python tools/build.py --template-override template-overrides.j2 horizon -.. end - .. note:: The above example will replace all contents from the original block. Hence @@ -340,24 +300,18 @@ for example, ``template-overrides.j2``. In this place the following: # Horizon {% set horizon_packages_append = ['iproute'] %} -.. end - Then rebuild the horizon image, passing the ``--template-override`` argument: .. code-block:: console kolla-build --template-override template-overrides.j2 horizon -.. end - * For development, run: .. code-block:: console python tools/build.py --template-override template-overrides.j2 horizon -.. end - Alternatively ``template_override`` can be set in ``kolla-build.conf``. The ``append`` suffix in the above example carries special significance. It @@ -382,8 +336,6 @@ Base-image can be specified by argument ``--base-image``. For example: kolla-build --base-image registry.access.redhat.com/rhel7/rhel --base rhel -.. end - Plugin Functionality -------------------- @@ -408,8 +360,6 @@ image, one may want to add the following to the ``template-override`` file: && pip --no-cache-dir install networking-cisco {% endblock %} -.. end - Astute readers may notice there is one problem with this however. Assuming nothing else in the Dockerfile changes for a period of time, the above ``RUN`` statement will be cached by Docker, meaning new commits added to the Git @@ -430,8 +380,6 @@ format: [<image>-plugin-<plugin-name>] -.. end - Where ``<image>`` is the image that the plugin should be installed into, and ``<plugin-name>`` is the chosen plugin identifier. @@ -446,8 +394,6 @@ Continuing with the above example, add the following to location = https://git.openstack.org/openstack/networking-cisco reference = master -.. end - The build will clone the repository, resulting in the following archive structure: @@ -457,8 +403,6 @@ structure: |__ plugins |__networking-cisco -.. end - The template now becomes: .. code-block:: console @@ -468,8 +412,6 @@ The template now becomes: pip --no-cache-dir install /plugins/* {% endblock %} -.. end - Many of the Dockerfiles already copy the ``plugins-archive`` to the image and install available plugins at build time. @@ -500,8 +442,6 @@ format: [<image>-additions-<additions-name>] -.. end - Where ``<image>`` is the image that the plugin should be installed into, and ``<additions-name>`` is the chosen additions identifier. @@ -515,8 +455,6 @@ Continuing with the above example, add the following to type = local location = /path/to/your/jenkins/data -.. end - The build will copy the directory, resulting in the following archive structure: @@ -526,8 +464,6 @@ structure: |__ additions |__jenkins -.. end - Alternatively, it is also possible to create an ``additions-archive.tar`` file yourself without passing by ``/etc/kolla/kolla-build.conf`` in order to use the feature for binary build type. @@ -541,8 +477,6 @@ The template now becomes: RUN cp /additions/jenkins/jenkins.json /jenkins.json {% endblock %} -.. end - Custom Repos ------------ @@ -559,8 +493,6 @@ Update ``rpm_setup_config`` in ``/etc/kolla/kolla-build.conf``: rpm_setup_config = https://trunk.rdoproject.org/centos7/currrent/delorean.repo,https://trunk.rdoproject.org/centos7/delorean-deps.repo -.. end - If specifying a ``.repo`` file, each ``.repo`` file will need to exist in the same directory as the base Dockerfile (``kolla/docker/base``): @@ -569,8 +501,6 @@ same directory as the base Dockerfile (``kolla/docker/base``): rpm_setup_config = epel.repo,delorean.repo,delorean-deps.repo -.. end - Ubuntu ------ For Debian based images, additional apt sources may be added to the build as @@ -580,8 +510,6 @@ follows: apt_sources_list = custom.list -.. end - Known issues ============ @@ -626,8 +554,6 @@ To set the proxy settings, we can add this to the template's header block: ENV http_proxy=https://evil.corp.proxy:80 ENV https_proxy=https://evil.corp.proxy:80 -.. end - To unset the proxy settings, we can add this to the template's footer block: .. code-block:: ini @@ -635,8 +561,6 @@ To unset the proxy settings, we can add this to the template's footer block: ENV http_proxy="" ENV https_proxy="" -.. end - Besides this configuration options, the script will automatically read these environment variables. If the host system proxy parameters match the ones going to be used, no other input parameters will be needed. These are the @@ -647,8 +571,6 @@ variables that will be picked up from the user env: HTTP_PROXY, http_proxy, HTTPS_PROXY, https_proxy, FTP_PROXY, ftp_proxy, NO_PROXY, no_proxy -.. end - Also these variables could be overwritten using ``--build-args``, which have precedence. diff --git a/doc/source/admin/template-override/opendaylight-source.rst b/doc/source/admin/template-override/opendaylight-source.rst index b6528915b..f86cfa68e 100644 --- a/doc/source/admin/template-override/opendaylight-source.rst +++ b/doc/source/admin/template-override/opendaylight-source.rst @@ -20,12 +20,9 @@ Point to the desired version of OpenDaylight in `kolla-build.conf`: type = url location = https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/integration/distribution-karaf/0.6.2-Carbon/distribution-karaf-0.6.2-Carbon.tar.gz -.. end - Build the container by executing the following command: .. code-block:: console kolla-build --type source --template-override contrib/template-override/opendaylight-template-overrides.j2 opendaylight -.. end diff --git a/doc/source/admin/template-override/ovs-dpdk.rst b/doc/source/admin/template-override/ovs-dpdk.rst index e000a80e7..0b6c63951 100644 --- a/doc/source/admin/template-override/ovs-dpdk.rst +++ b/doc/source/admin/template-override/ovs-dpdk.rst @@ -29,8 +29,6 @@ In this place the ``contrib/template-override/ovs-dpdk.j2`` file: location = http://dpdk.org/git/dpdk reference = v17.02 -.. end - To build the container execute the follow command: .. code-block:: console @@ -38,4 +36,3 @@ To build the container execute the follow command: tools/build.py --template-override \ contrib/template-override/ovs-dpdk.j2 dpdk -.. end diff --git a/doc/source/contributor/running-tests.rst b/doc/source/contributor/running-tests.rst index 269b7da54..cb3cc4bdf 100644 --- a/doc/source/contributor/running-tests.rst +++ b/doc/source/contributor/running-tests.rst @@ -26,8 +26,6 @@ so the only package you install is ``tox`` itself: pip install tox -.. end - See the `unit testing <https://wiki.openstack.org/wiki/Testing#Unit_Tests>`__ section of the Testing wiki page for more information. Following are some simple examples. @@ -38,24 +36,18 @@ To run the Python 2.7 tests: tox -e py27 -.. end - To run the style tests: .. code-block:: console tox -e pep8 -.. end - To run multiple tests separate items by commas: .. code-block:: console tox -e py27,py35,pep8 -.. end - Running a subset of tests ------------------------- @@ -69,16 +61,12 @@ To run the tests located only in the ``kolla/tests`` directory: tox -e py27 kolla.tests -.. end - To run the tests of a specific file say ``kolla/tests/test_set_config.py``: .. code-block:: console tox -e py27 test_set_config -.. end - To run the tests in the ``ConfigFileTest`` class in the ``kolla/tests/test_set_config.py`` file: @@ -86,8 +74,6 @@ the ``kolla/tests/test_set_config.py`` file: tox -e py27 test_set_config.ConfigFileTest -.. end - To run the ``ConfigFileTest.test_delete_path_not_exists`` test method in the ``kolla/tests/test_set_config.py`` file: @@ -95,8 +81,6 @@ the ``kolla/tests/test_set_config.py`` file: tox -e py27 test_set_config.ConfigFileTest.test_delete_path_not_exists -.. end - Coverage Report Generation -------------------------- @@ -106,8 +90,6 @@ In order to get coverage report for Kolla, run the below command. tox -e cover -.. end - Debugging unit tests -------------------- @@ -118,8 +100,6 @@ a breaking point to the code: import pdb; pdb.set_trace() -.. end - Then run :command:`tox` with the debug environment as one of the following: .. code-block:: console @@ -127,8 +107,6 @@ Then run :command:`tox` with the debug environment as one of the following: tox -e debug tox -e debug test_file_name.TestClass.test_name -.. end - For more information see the `oslotest documentation <https://docs.openstack.org/oslotest/latest/user/features.html#debugging-with-oslo-debug-helper>`_. |
