x/quark
Code Issues Proposed changes
master
quark/CONTRIBUTING.rst
Brian Stajkowski ba31915a50 Docker Development 
Adding docker integration for easy development of quark.  This
will be closely tied to the current software revision on any
given patch.  This allows you to vagrant up any current code
revision as it will copy over the current working codebase to the
docker image for installation into a virtualenv.

This also employs several docker containers to make it easier to
manage.  It contains Redis, RabbitMQ, MySQL, PHPMySQLAdmin,
and Kabana with Elasticsearch for log analysis.

If your code changes and you need to test again after you
docker_up.sh, you can easily docker_reload.sh and it will
only update quark and start the process.  In addition,
this will insert a set number of networks and subnets for
easy starting.

Change-Id: I70d0ec9aed1548796bd8d4a9c1a94506234378f9
JIRA:NCP-1692
Implements: blueprint vagrant-quark
2016-06-27 22:34:32 -07:00

4.0 KiB
Raw Permalink Blame History

CONTRIBUTING

OPENSTACK CONTIBUTOR

Before you can start, please ensure you are signed-up with the Openstack Foundation as a foundation member.

Start Here

https://www.openstack.org/join/

Create a Launchpad Account

https://launchpad.net/+login

Follow the Developer's Guide

http://docs.openstack.org/infra/manual/developers.html

Quick Start

  • Follow these steps to get started:

git clone https://github.com/openstack/quark.git

cd quark

git remote add gerrit https://<username>@review.openstack.org/openstack/quark.git

git review -s

git branch <mybranch>

git checkout <mybranch>

PROPER COMMIT MESSAGES

  • All commit messages follow the same requirements as Openstack:

Commit Title

Commit text not to exceed 76 characters. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

Closes-Bug: ####### Partial-Bug: ####### Related-Bug: ####### Implements: blueprint my-blueprint

  • Please only submit one commit. If you update a patch just amend:

git commit -a --amend --all

# Leave the comments alone or update.

git review

BUGS

All bugs must be submitted through launchpad. If code is posted without a reference to a bug or blueprint, you will be asked to do so.

Please visit our launchpad project to open a bug: https://launchpad.net/neutron-quark

BLUEPRINTS & FEATURES

If you are submitting a new feature, please open a blueprint prior to submitting code. The blueprint must detail the following information:

  1. Purpose of the Feature
  2. Overview of Implementation

Please visit our launchpad project to open a blueprint: https://launchpad.net/neutron-quark

REQUEST FOR FEATURES

It is possible to request for features from our team without being a part of the actual code implementation. Please submit through our launchpad project and detail as much of the requirement as possible.

We will review and determine if it is possible and when a developer can be assigned to the request.

DOCKER DEVELOPMENT ENVIRONMENT

Quick Start

  1. Install Docker: https://docs.docker.com/engine/installation/
  2. cd <quark_repo_dir>
  3. ./docker_up.sh
  4. First time? Please wait to download the containers.
  5. This will install the code currently in the directory.

6. If you need to update the development environment with code you have changed, just ./docker_reload.sh once you have the environment up. This will reload the quark container with your new code.

7. Have your own configs? Not a problem, just create a ~/neutron directory local on your laptop or working environment. The default configs will be overwritten by your configuration files. They will also be loaded fresh everytime with ./docker_reload.sh.

8. By default if a configuration file is not in ~/netron directory, it will load docker.neutron.conf, docker.apipaste.ini, and docker.policy.json in this repo.

  1. Once you are done with the evironment, just ./docker_down.sh
  2. What's in the Dev Environment?

For addiitonal ports, please see the docker_up.sh script.

11. Need to reference the IP of one of the containers? No need, the quark container handles the linking and generating /etc/hosts with the correct IPs. To access any of the containers in your configurations files, use the following hostnames:

  • ELK: docker-kibana
  • MySQL: docker-mysql
  • RabbitMQ: docker-rabbitmq
  • Redis: docker-redis
  • Redis-Sentinel: docker-redis-sentinel