openstack/kolla-ansible
Code Issues Proposed changes
fccc2d80bf
kolla-ansible/doc/source/contributor/kolla-for-openstack-development.rst
Surya Prakash Singh 04fd12b945 Restructured the doc of kolla-ansible 
Created the admin directory, remove some files from
user dir and placed into admin and contributor.

For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I84c565d7d14a4d90270a53e14ab93a10f7ffb9b7
Partially-Implements: blueprint ka-queens-doc-restructure
2017-10-05 03:23:23 +00:00

1.7 KiB
Raw Blame History

Using Kolla For OpenStack Development

Kolla-ansible can be used to deploy containers in a way suitable for doing development on OpenStack services.

Note

This functionality is new in the Pike release.

Heat was the first service to be supported, and so the following will use submitting a patch to Heat using Kolla as an example.

Only source containers are supported.

Warning

Kolla dev mode is intended for OpenStack hacking/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:

kolla_dev_mode: true

To enable it just for heat, set:

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:

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:

docker exec -it -u root heat_api pip install remote_pdb

Then, set your breakpoint as follows:

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:

socat readline tcp:127.0.0.1:4444

For more information on remote_pdb, see https://pypi.python.org/pypi/remote-pdb.