kolla-ansible/doc/source/contributor/kolla-for-openstack-development.rst
Pierre Riteau 14052dd742 Remove outdated comments in dev mode docs
Pike has been EOL for years and there is only one image type.

Change-Id: Ida9402dfc69c1ccfaa30c03a80481c8bc269d51b
2024-01-23 22:53:56 +01:00

73 lines
1.7 KiB
ReStructuredText

=====================================
Using Kolla For OpenStack Development
=====================================
Kolla-ansible can be used to deploy containers in a way suitable for doing
development on OpenStack services.
Heat was the first service to be supported, and so the following will use
submitting a patch to Heat using Kolla as an example.
.. warning::
Kolla dev mode is intended for OpenStack hacking or development only.
Do not use this in production!
Enabling Kolla "dev mode"
-------------------------
To enable dev mode for all supported services, set in
``/etc/kolla/globals.yml``:
.. path /etc/kolla/globals.yml
.. code-block:: yaml
kolla_dev_mode: true
To enable it just for heat, set:
.. path /etc/kolla/globals.yml
.. code-block:: yaml
heat_dev_mode: true
Usage
-----
When enabled, the source repo for the service in question will be cloned under
``/opt/stack/`` on the target node(s). This will be bind mounted into the
container's virtualenv under the location expected by the service on startup.
After making code changes, simply restart the container to pick them up:
.. code-block:: console
docker restart heat_api
Debugging
---------
``remote_pdb`` can be used to perform debugging with Kolla containers. First,
make sure it is installed in the container in question:
.. code-block:: console
docker exec -it -u root heat_api pip install remote_pdb
Then, set your breakpoint as follows:
.. code-block:: python
from remote_pdb import RemotePdb
RemotePdb('127.0.0.1', 4444).set_trace()
Once you run the code(restart the container), pdb can be accessed using
``socat``:
.. code-block:: console
socat readline tcp:127.0.0.1:4444
Learn more information about `remote_pdb
<https://pypi.org/project/remote-pdb/>`_.