openstack/operations-guide
Code Issues Proposed changes
OpenStack Operations Guide
234 Commits 2 Branches 1 Tag 27 MiB
Text 100%
5ff14d986d
Go to file
Jonathan Proulx 5ff14d986d Add some neutron ovs content to network trouble shooting 
adds flow diagram for neutron with OVS
adds section on ovs debuggin
adds section on dealing with network namespaces

Change-Id: Ia1855f223abae9aa75da70207392086ffe0fdeee
2014-02-04 00:29:43 -05:00
.tx Translation fixes for ops-guide 2014-01-16 16:39:42 +08:00
doc/openstack-ops Add some neutron ovs content to network trouble shooting 2014-02-04 00:29:43 -05:00
tools Fix path used in generatepot 2014-02-03 11:47:13 +09:00
.gitignore Ignore publish-docs directory 2014-02-02 15:36:12 +01:00
.gitreview Changes license to CC-by 3.0. 2013-06-12 13:27:23 -05:00
doc-test.conf Add doc-test.conf 2014-02-03 08:15:57 +01:00
LICENSE Changes license to CC-by 3.0. 2013-06-12 13:27:23 -05:00
README.rst Rename README to README.rst 2014-02-02 12:22:35 +01:00
test-requirements.txt Updated from global requirements 2014-01-25 03:34:58 +00:00
tox.ini Allow passing arguments to tox 2014-01-03 10:43:48 +01:00

README.rst

OpenStack Operations Guide +++++++++++++++++++

This repository contains the source files for the OpenStack Operations Guide.

You can read this guide at docs.openstack.org/ops.

It was originally authored during a book sprint in February 2013. Read more about Book Sprints at http://www.booksprints.net.

Additionally, a tools directory contains tools for testing this guide.

Prerequisites

Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:

apt-get install maven

On Fedora 15 and later:

yum install maven3

Contributing

This book is undergoing a custom edit with O'Reilly publishing and we welcome contributions to make it as accurate as possible. Our target is the Havana release.

The style guide to follow is at chimera.labs.oreilly.com <http://chimera.labs.oreilly.com/books/1230000000969/index.html.

Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation. The best way to get involved with the community is to talk with others online or at a meetup and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at #openstack on irc.freenode.net.

Testing of changes and building of the manual

Install the python tox package and run "tox" from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

  • tox -e checkniceness - to run the niceness tests
  • tox -e checksyntax - to run syntax checks
  • tox -e checkdeletions - to check that no deleted files are referenced
  • tox -e checkbuild - to actually build the manual

tox will use the openstack-doc-tools package for execution of these tests.

Installing OpenStack

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.