Blame - doc/source/index.rst - devstack

blob: c4a7c59fe59df49cba7ca58ebd0f3a2101f8f3e0 [file] [log] [blame]

Ian Wienand	7cd16ce	2016-04-08 09:40:56 +1000	[diff] [blame]	1	DevStack
				2	========
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	3
Dean Troyer	af14029	2014-11-20 21:13:15 -0600	[diff] [blame]	4	.. image:: assets/images/logo-blue.png
				5
Ian Wienand	7cd16ce	2016-04-08 09:40:56 +1000	[diff] [blame]	6	DevStack is a series of extensible scripts used to quickly bring up a
				7	complete OpenStack environment. It is used interactively as a
				8	development environment and as the basis for much of the OpenStack
				9	project's functional testing.
				10
				11	The source is available at
				12	`<https://git.openstack.org/cgit/openstack-dev/devstack>`__.
				13
Dean Troyer	63baba2	2014-10-29 21:57:31 -0500	[diff] [blame]	14	.. toctree::
				15	:glob:
				16	:maxdepth: 1
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	17
Dean Troyer	63baba2	2014-10-29 21:57:31 -0500	[diff] [blame]	18	overview
				19	configuration
				20	plugins
Sean Dague	0124e08	2015-06-19 08:26:45 -0400	[diff] [blame]	21	plugin-registry
Dean Troyer	63baba2	2014-10-29 21:57:31 -0500	[diff] [blame]	22	faq
Ian Wienand	6f6e2fd	2015-03-20 12:16:28 +1100	[diff] [blame]	23	hacking
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	24
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	25	Quick Start
				26	-----------
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	27
				28	#. Select a Linux Distribution
				29
Kashyap Chamarthy	90bc586	2015-12-01 18:04:40 +0100	[diff] [blame]	30	Only Ubuntu 14.04 (Trusty), Fedora 22 (or Fedora 23) and CentOS/RHEL
Kashyap Chamarthy	a53ae68	2015-05-27 21:59:32 +0200	[diff] [blame]	31	7 are documented here. OpenStack also runs and is packaged on other
				32	flavors of Linux such as OpenSUSE and Debian.
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	33
				34	#. Install Selected OS
				35
				36	In order to correctly install all the dependencies, we assume a
				37	specific minimal version of the supported distributions to make it as
				38	easy as possible. We recommend using a minimal install of Ubuntu or
				39	Fedora server in a VM if this is your first time.
				40
				41	#. Download DevStack
				42
				43	::
				44
				45	git clone https://git.openstack.org/openstack-dev/devstack
				46
				47	The ``devstack`` repo contains a script that installs OpenStack and
				48	templates for configuration files
				49
				50	#. Configure
				51
James Polley	5f2eb6d	2015-03-30 17:36:26 +1100	[diff] [blame]	52	We recommend at least a :ref:`minimal-configuration` be set up.
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	53
Einst Crazy	2ed2813	2015-11-05 16:38:00 +0800	[diff] [blame]	54	#. Add Stack User
				55
				56	Devstack should be run as a non-root user with sudo enabled
				57	(standard logins to cloud images such as "ubuntu" or "cloud-user"
				58	are usually fine).
				59
				60	You can quickly create a separate `stack` user to run DevStack with
				61
				62	::
				63
				64	devstack/tools/create-stack-user.sh; su stack
				65
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	66	#. Start the install
				67
				68	::
				69
				70	cd devstack; ./stack.sh
				71
				72	It takes a few minutes, we recommend `reading the
				73	script <stack.sh.html>`__ while it is building.
				74
Dean Troyer	63baba2	2014-10-29 21:57:31 -0500	[diff] [blame]	75	Guides
				76	======
				77
				78	Walk through various setups used by stackers
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	79
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	80	.. toctree::
				81	:glob:
				82	:maxdepth: 1
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	83
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	84	guides/single-vm
				85	guides/single-machine
Cody A.W. Somerville	baa35d0	2016-02-11 01:23:14 -0500	[diff] [blame]	86	guides/lxc
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	87	guides/multinode-lab
Sean M. Collins	3429601	2014-10-27 11:57:20 -0400	[diff] [blame]	88	guides/neutron
Kashyap Chamarthy	75afd6d	2015-01-20 17:39:25 +0100	[diff] [blame]	89	guides/devstack-with-nested-kvm
Tony Breeds	a339efc	2014-12-04 16:52:58 +1100	[diff] [blame]	90	guides/nova
Aishwarya Thangappa	7c57306	2015-02-18 01:51:13 -0800	[diff] [blame]	91	guides/devstack-with-lbaas-v2
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	92
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	93	All-In-One Single VM
				94	--------------------
Dean Troyer	63baba2	2014-10-29 21:57:31 -0500	[diff] [blame]	95
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	96	Run :doc:`OpenStack in a VM <guides/single-vm>`. The VMs launched in your cloud will be slow as
Dean Troyer	63baba2	2014-10-29 21:57:31 -0500	[diff] [blame]	97	they are running in QEMU (emulation), but it is useful if you don't have
Dean Troyer	d224ae1	2014-11-06 09:33:02 -0600	[diff] [blame]	98	spare hardware laying around. :doc:`[Read] <guides/single-vm>`
Dean Troyer	63baba2	2014-10-29 21:57:31 -0500	[diff] [blame]	99
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	100	All-In-One Single Machine
				101	-------------------------
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	102
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	103	Run :doc:`OpenStack on dedicated hardware <guides/single-machine>` This can include a
				104	server-class machine or a laptop at home.
				105	:doc:`[Read] <guides/single-machine>`
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	106
Cody A.W. Somerville	baa35d0	2016-02-11 01:23:14 -0500	[diff] [blame]	107	All-In-One LXC Container
				108	-------------------------
				109
				110	Run :doc:`OpenStack in a LXC container <guides/lxc>`. Beneficial for intermediate
				111	and advanced users. The VMs launched in this cloud will be fully accelerated but
				112	not all OpenStack features are supported. :doc:`[Read] <guides/lxc>`
				113
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	114	Multi-Node Lab
				115	--------------
Dean Troyer	63baba2	2014-10-29 21:57:31 -0500	[diff] [blame]	116
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	117	Setup a :doc:`multi-node cluster <guides/multinode-lab>` with dedicated VLANs for VMs & Management.
				118	:doc:`[Read] <guides/multinode-lab>`
Dean Troyer	63baba2	2014-10-29 21:57:31 -0500	[diff] [blame]	119
Sean M. Collins	3429601	2014-10-27 11:57:20 -0400	[diff] [blame]	120	DevStack with Neutron Networking
				121	--------------------------------
				122
				123	Building a DevStack cluster with :doc:`Neutron Networking <guides/neutron>`.
				124	This guide is meant for building lab environments with a dedicated
				125	control node and multiple compute nodes.
				126
Kashyap Chamarthy	75afd6d	2015-01-20 17:39:25 +0100	[diff] [blame]	127	DevStack with KVM-based Nested Virtualization
				128	---------------------------------------------
				129
				130	Procedure to setup :doc:`DevStack with KVM-based Nested Virtualization
				131	<guides/devstack-with-nested-kvm>`. With this setup, Nova instances
				132	will be more performant than with plain QEMU emulation.
				133
Tony Breeds	a339efc	2014-12-04 16:52:58 +1100	[diff] [blame]	134	Nova and devstack
				135	--------------------------------
				136
				137	Guide to working with nova features :doc:`Nova and devstack <guides/nova>`.
				138
Dean Troyer	26dd21b	2014-11-06 09:33:02 -0600	[diff] [blame]	139	DevStack Documentation
				140	======================
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	141
				142	Overview
				143	--------
				144
Dean Troyer	d224ae1	2014-11-06 09:33:02 -0600	[diff] [blame]	145	:doc:`An overview of DevStack goals and priorities <overview>`
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	146
				147	Configuration
				148	-------------
				149
Dean Troyer	d224ae1	2014-11-06 09:33:02 -0600	[diff] [blame]	150	:doc:`Configuring and customizing the stack <configuration>`
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	151
				152	Plugins
				153	-------
				154
Dean Troyer	d224ae1	2014-11-06 09:33:02 -0600	[diff] [blame]	155	:doc:`Extending DevStack with new features <plugins>`
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	156
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	157	FAQ
				158	---
				159
Dean Troyer	d224ae1	2014-11-06 09:33:02 -0600	[diff] [blame]	160	:doc:`The DevStack FAQ <faq>`
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	161
				162	Contributing
				163	------------
				164
Ian Wienand	6f6e2fd	2015-03-20 12:16:28 +1100	[diff] [blame]	165	:doc:`Pitching in to make DevStack a better place <hacking>`
Sean M. Collins	09e550c	2014-10-21 11:40:08 -0400	[diff] [blame]	166