DevStack - an OpenStack Community Production ============================================ .. image:: assets/images/logo-blue.png .. toctree:: :glob: :maxdepth: 1 overview configuration plugins plugin-registry faq changes hacking Quick Start ----------- #. Select a Linux Distribution Only Ubuntu 14.04 (Trusty), Fedora 21 (or Fedora 22) and CentOS/RHEL 7 are documented here. OpenStack also runs and is packaged on other flavors of Linux such as OpenSUSE and Debian. #. Install Selected OS In order to correctly install all the dependencies, we assume a specific minimal version of the supported distributions to make it as easy as possible. We recommend using a minimal install of Ubuntu or Fedora server in a VM if this is your first time. #. Download DevStack :: git clone https://git.openstack.org/openstack-dev/devstack The ``devstack`` repo contains a script that installs OpenStack and templates for configuration files #. Configure We recommend at least a :ref:`minimal-configuration` be set up. #. Start the install :: cd devstack; ./stack.sh It takes a few minutes, we recommend `reading the script `__ while it is building. Guides ====== Walk through various setups used by stackers .. toctree:: :glob: :maxdepth: 1 guides/single-vm guides/single-machine guides/multinode-lab guides/neutron guides/devstack-with-nested-kvm guides/nova guides/devstack-with-lbaas-v2 All-In-One Single VM -------------------- Run :doc:`OpenStack in a VM `. The VMs launched in your cloud will be slow as they are running in QEMU (emulation), but it is useful if you don't have spare hardware laying around. :doc:`[Read] ` All-In-One Single Machine ------------------------- Run :doc:`OpenStack on dedicated hardware ` This can include a server-class machine or a laptop at home. :doc:`[Read] ` Multi-Node Lab -------------- Setup a :doc:`multi-node cluster ` with dedicated VLANs for VMs & Management. :doc:`[Read] ` DevStack with Neutron Networking -------------------------------- Building a DevStack cluster with :doc:`Neutron Networking `. This guide is meant for building lab environments with a dedicated control node and multiple compute nodes. DevStack with KVM-based Nested Virtualization --------------------------------------------- Procedure to setup :doc:`DevStack with KVM-based Nested Virtualization `. With this setup, Nova instances will be more performant than with plain QEMU emulation. Nova and devstack -------------------------------- Guide to working with nova features :doc:`Nova and devstack `. DevStack Documentation ====================== Overview -------- :doc:`An overview of DevStack goals and priorities ` Configuration ------------- :doc:`Configuring and customizing the stack ` Plugins ------- :doc:`Extending DevStack with new features ` Recent Changes -------------- :doc:`An incomplete summary of recent changes ` FAQ --- :doc:`The DevStack FAQ ` Contributing ------------ :doc:`Pitching in to make DevStack a better place ` Code ==== *A look at the bits that make it all go* Scripts ------- * `stack.sh `__ - The main script * `functions `__ - DevStack-specific functions * `functions-common `__ - Functions shared with other projects * `lib/apache `__ * `lib/ceph `__ * `lib/cinder `__ * `lib/database `__ * `lib/dstat `__ * `lib/glance `__ * `lib/heat `__ * `lib/horizon `__ * `lib/infra `__ * `lib/ironic `__ * `lib/keystone `__ * `lib/ldap `__ * `lib/neutron-legacy `__ * `lib/nova `__ * `lib/oslo `__ * `lib/rpc\_backend `__ * `lib/swift `__ * `lib/tempest `__ * `lib/tls `__ * `lib/trove `__ * `unstack.sh `__ * `clean.sh `__ * `run\_tests.sh `__ * `extras.d/50-ironic.sh `__ * `extras.d/60-ceph.sh `__ * `extras.d/70-tuskar.sh `__ * `extras.d/80-tempest.sh `__ * `inc/ini-config `__ * `inc/meta-config `__ * `inc/python `__ * `pkg/elasticsearch.sh `_ Configuration ------------- .. toctree:: :glob: :maxdepth: 1 local.conf stackrc openrc exerciserc eucarc Tools ----- * `tools/build\_docs.sh `__ * `tools/build\_venv.sh `__ * `tools/create-stack-user.sh `__ * `tools/create\_userrc.sh `__ * `tools/fixup\_stuff.sh `__ * `tools/info.sh `__ * `tools/install\_pip.sh `__ * `tools/install\_prereqs.sh `__ * `tools/make\_cert.sh `__ * `tools/upload\_image.sh `__ Samples ------- * `local.sh `__ Exercises --------- * `exercise.sh `__ * `exercises/aggregates.sh `__ * `exercises/boot\_from\_volume.sh `__ * `exercises/bundle.sh `__ * `exercises/client-args.sh `__ * `exercises/client-env.sh `__ * `exercises/euca.sh `__ * `exercises/floating\_ips.sh `__ * `exercises/horizon.sh `__ * `exercises/neutron-adv-test.sh `__ * `exercises/sec\_groups.sh `__ * `exercises/swift.sh `__ * `exercises/volumes.sh `__