42 Commits

Author SHA1 Message Date
Balagopal
7ed812c6cd Change "secrete" to "secret"
Apparently this is intentional as a joke on devstack leaking
passwords, but the dual meaning of the word confuses people.  Let's
change it before we get yet another review fixing it.

Change-Id: I3bee03612f6ea197362aab04a37f81043f77f235
2016-03-17 14:53:03 +11:00
Sean Dague
985e958dda remove keystone templated catalog
This is just another code path for little benefit in devstack which is
going to rot out. We should be opinionated here and only support the
dynamic catalog.

Change-Id: I4e5c7e86aefe72fc21c77d423033e9b169318fec
2016-02-10 15:39:31 -05:00
Jenkins
80eb79c1a9 Merge "Adding ENABLE_IDENTITY_V2 on docs" 2016-01-29 05:10:21 +00:00
Steve Martinelli
3567d6103a remove SERVICE_TOKEN from the docs
there are a few lingering instances of SERVICE_TOKEN in the docs
and some of the scripts in tools.

Change-Id: I9d2147eea6639db1f4ea15a259c147eecfc339ff
2016-01-10 01:29:39 +00:00
henriquetruta
f212622cbd Adding ENABLE_IDENTITY_V2 on docs
Adds the documentation of ENABLE_IDENTITY_V2 property on keystone
section.

Change-Id: If72325751c3bfd7f11f46c518c9fbf59f10a894f
2016-01-05 13:45:34 -03:00
Jenkins
307730acd9 Merge "configuration.rst: Document post-extra meta section phase" 2015-11-27 02:19:11 +00:00
Jenkins
8f07ef84db Merge "Delete some comment or messages of keystone_data.sh(removed)" 2015-11-16 17:24:42 +00:00
yangyapeng
01cf55a692 Fix RST in configuration.rst
Fix minor RST issue from before file was converted.

Change-Id: Ie16ceace9c17e98010e068641ce60ba9a365ede0
2015-11-16 14:52:08 +11:00
Markus Zoeller
c30657d7de Cleanup ReST format issues
* ReST doesn't allow monospace in italic sections.
      bash$ grep -R \`\` doc/build/html/ --include "*.html"
* The code-block section "::" needed an empty line before the code,
  otherwise it gets shown in the HTML output.
      bash$ egrep -R "<dt>::" doc/build/html/ --include "*.html"
* Monospaced font incorrectly marked with a single back tick
      bash$ egrep -nR '\w`(\s|[\.,;:])' doc/source/ --include "*.rst"

Change-Id: I66c3f685f33851c3f3f0f859996037fc24930246
2015-11-02 11:27:46 +01:00
Einst Crazy
f54f60a63e Delete some comment or messages of keystone_data.sh(removed)
As files/keystone_data.sh has been removed in the commit
https://review.openstack.org/#/c/79366/, we should remove some
related documations and comments.

Change-Id: I7802d0052fa28d8debb7f361d36a4f108869554c
2015-10-30 23:00:57 +08:00
Oleksii Chuprykov
a692810ef0 Add toggle to run Heat API services via Apache2
Add templates for running Heat API services via
apache mod_wsgi. Also add appropriate functions to
lib/heat for configuring Heat.

Change-Id: I1bdd678c44ddfa616a9db7db85ff6f490ff08947
2015-10-28 15:25:17 +00:00
Jenkins
0989cf9512 Merge "Nano and Micro flavors should run really small cirros only" 2015-10-07 16:44:16 +00:00
Rafael Folco
f0131e14b8 Nano and Micro flavors should run really small cirros only
Guests with large memory requirements can use default flavors, so
removing the special flavor for ppc64 since new qemu requires more
memory - http://wiki.qemu.org/ChangeLog/2.4 - PowerPC.
Users should set DEFAULT_INSTANCE_TYPE to one of the default
flavors available in local.conf, as m1.tiny.

DocImpact

Change-Id: I0fd275dc7342cc2daa83e9a2bd79d30e7defa3e4
2015-10-06 08:52:13 -05:00
Anton Arefiev
651cb1ad75 Add toggle to run Cinder API under Apache
This change adds apache templates for Cinder API services.
Also add possibility to switch between the old and new ways
to setup Cinder API.

Related Cinder blueprint:
 https://blueprints.launchpad.net/cinder/+spec/non-eventlet-wsgi-app

Change-Id: Icfad40ee6998296727a95613199e5c2d87bd0a45
Depends-On: Ifbab059001d1567b1f7b394c0411a9ca4629f846
Co-Authored-By: Ivan Kolodyazhny <e0ne@e0ne.info>
2015-09-28 15:01:03 +00:00
dieterly
7c7679ecc9 Clarify new header configuration syntax
Make it clear that there are no spaces in the
new header section.

Change-Id: I69c14017820621a3aea75e41960ac3758f7e4835
2015-09-18 15:31:07 -06:00
Jenkins
1d0b0d363e Merge "Add/Overwrite default images in IMAGE_URLS and detect duplicates" 2015-09-03 08:52:59 +00:00
John Hua
a4693b5dea Add/Overwrite default images in IMAGE_URLS and detect duplicates
IMAGE_URLS could be set both in localrc with customization or stackrc by
default. By setting DOWNLOAD_DEFAULT_IMAGES, user could choose to add
default images to IMAGE_URLS or overwrite them.

As uploading duplicate images will cause a "409 Conflict" error, a
duplicate detection will expose it earlier.

Care needs to be taken that you don't end up with a duplicate image, so
clean up Xen's README.

Depends-On: I6fbae12f950a03afab39f341132746d3db9f788c
Change-Id: I3ca4e576aa3fb8992c08ca44900a8c53dd4b4163
Closes-Bug: #1473432
2015-08-27 10:33:26 +01:00
Ian Wienand
a35391e3bb Talk about local.conf first
We bury the lead with all the historical notes about localrc; just
talk about what is important to somebody setting up a current
devstack, which is local.conf.

There are already inline examples of config-variables, etc.  Remove
them, but add a small overview example for logging in its place.

Change-Id: I466252ffba66ef4ea180c9355f715a19eb4f8017
2015-08-27 15:19:31 +10:00
Ian Wienand
7d5be29920 Move configuration notes into configuration guide
We have configuration information split between the README.md and
configuration documentation.  A lot of it is duplicated and it shows
little organisation.

This clears the README.md of detailed configuration options and
consolidates it into the existing configuration guide.  When someone
first hits the README they don't need details on changing the RPC
back-end; but more importantly this indicates clearly where we should
be adding or clarifying details.

Firstly, the detailed overview of local.conf is removed; it was
duplicated in the configuration guide.  This is left as a first-level
section of that guide.

The configuration notes are divided into generic devstack things
(logging, database-backend, etc) and then the rest of the notes on
various projects' configuration options have been moved into a
dedicated sub-section "Projects".

Each project gets its own sub-sub-section.  Duplicated swift guides is
consolidated into the single "Swift section". The neutron and
multi-node nodes, which were all duplicated in their more specific
dedicated guides are removed and replaced with links to those.  Other
sections are moved directly.

Change-Id: Ib0bac56d82be870fe99c47c53fda674d8668b968
2015-08-27 15:17:57 +10:00
venkatamahesh
b237b93f2b Location of the "local.conf" file is confusing. It is updated.
It was shown that the local.conf is at root devstack directory, but
it is at devstack/samples directory. So the path is updated.

1.) Copy the file into root Devstack directory.

Change-Id: I6ff8a404a3664c892bb458023c57ccc5d0926fdf
Closes-Bug: #1464491
2015-08-13 15:56:48 +05:30
Ian Wienand
815db16c20 Clean up configuration documentation
The current format is just copy-paste after auto-conversion and very
inconsistent.  Move discussion of each option into a section and
reword some slightly so they read more clearly.  Group some together
into a section+sub-sections, such as the logging and ip-version option
discussions.

Add a top table-of-contents for the major sections, and then a
separate toc for each of the configuration options that are discussed
in detail.

Change-Id: Iddd27cb54f1d9f062b9c47ff9ad6a2bef3650d6b
2015-08-06 10:28:50 +10:00
YAMAMOTO Takashi
961643e404 configuration.rst: Document post-extra meta section phase
Change-Id: I81d121424057fd79c1a0a65d420df3ee1badb6f3
2015-07-31 13:45:27 +09:00
Brian Haley
180f5eb652 Add IPv6 support to devstack infrastructure
By default, most Openstack services are bound to 0.0.0.0
and service endpoints are registered as IPv4 addresses.
With this change we introduce two new variables to control
this behavior:

SERVICE_IP_VERSION - can either be "4" or "6".

When set to "4" (default if not set) devstack will operate
as today - most services will open listen sockets on 0.0.0.0
and service endpoints will be registered using HOST_IP as the
address.

When set to "6" devstack services will open listen sockets on ::
and service endpoints will be registered using HOST_IPV6 as the
address.

There is no support for "4+6", more work is required for that.

HOST_IPV6 - if SERVICE_IP_VERSION=6 this must be an IPv6
address configured on the system.

Some existing services, like the Openvswitch agent, will continue
to use IPv4 addresses for things like tunnel endpoints.  This is
a current restriction in the code and can be updated at a later
time.  This change is just a first step to supporting IPv6-only
control and data planes in devstack.

This change is also partly based on two previous patches,
https://review.openstack.org/#/c/140519/ and
https://review.openstack.org/#/c/176898/

Change-Id: I5c0b775490ce54ab104fd5e89b20fb700212ae74
Co-Authored-By: Sean Collins <sean@coreitpro.com>
Co-Authored-By: Baodong Li <baoli@cisco.com>
Co-Authored-By: Sridhar Gaddam <sridhar.gaddam@enovance.com>
Co-Authored-By: Adam Kacmarsky <adam.kacmarsky@hp.com>
Co-Authored-By: Jeremy Alvis <jeremy.alvis@hp.com>
2015-07-02 15:16:34 -06:00
Tomoki Sekine
1e3a89eeff Fix typo: where is runs => where it runs
Change-Id: I7dad52c5b5ea91d727bd8ee7253a64422e4ec210
2015-06-25 06:35:07 +09:00
Guillaume Giamarchi
93ee8c876c Set IP_VERSION default value to 4+6
This is actually the default value since 645114b

Change-Id: Ib6603b4f6ea0b4079f9a4ea46e723ecbb2ea371d
2015-05-26 02:15:27 +02:00
James Polley
5f2eb6dade Add a target for, and link to, minimal config docs
Reading through the docs for the first time, the reader encounters an
instruction to provide a minimal configuration, with a link that they'd
expect to tell them how to do this.

At present the link actually takes them to the top of
configuration.html, where they read some history about how devstack's
configuration has changed over time.

This is interesting and important and should be in the docs - but in my
opinion a link about setting up a minimal configuration would be more
useful if it takes me to a place that tells them about a minimal
configuration.

To get this, I've had to an an explicit link target into
configuration.rst. I'm not hugely keen on this approach, as I don't
think it scales well. I'd be open to suggestions about other
approaches. The only idea I've had so far though is to simply move the
minimal configuration section right to the top of the page, so that a
link to the doc is a link to the minimal config - the historical
information could be moved to its own topic somewhere further down the doc.

Change-Id: I231ca1b7f17b55f09a4e058dab8ee433893f737e
2015-03-30 17:41:25 +11:00
Dean Troyer
41d6f858be Clean up additional INSTALL_TESTONLY_PACKAGES bits
The original removal is in https://review.openstack.org/#/c/167669/

Change-Id: I3c59f040523d2cd1453465e80280955218880634
2015-03-26 15:36:23 -05:00
Jenkins
c392fd3b5f Merge "Add global venv enable/disable knob" 2015-03-26 20:32:31 +00:00
Chris Dent
ebdd9ac5b4 Provide an option to force pip --upgrade
Make it possible for someone to config

  PIP_UPGRADE=True

in local.conf and thus force pip_install calls to upgrade. In
automated testing this is probably a bad idea, but in manual testing
or situations where devstack is being used to spin up proof of
concepts having the option to use the latest and greatest Python
modules is a useful way of exploring the health of the ecosystem.

To help with visibility of the setting, and section has been added
in configuration.rst near other similar settings.

Change-Id: I484c954f1e1f05ed02c0b08e8e4a9c18558c05ef
2015-03-26 14:27:54 +00:00
Dean Troyer
5686dbc45d Add global venv enable/disable knob
Adds USE_VENV to globally enable/disable use of virtual environments.

ADDITIONAL_VENV_PACKAGES is used to manually add packages that do not
appear in requirements.txt or test-requirements.txt to be installed
into each venv.  Database Python bindings are handled this way when
a dataabse service is enabled.

Change-Id: I9cf298b936fd10c95e2ce5f51aab0d49d4b7f37f
2015-03-20 09:48:43 -05:00
Thanassis Parathyras
a03ed37626 Adds documentation for devstack unit tests enablement
Closes Bug: 1283214
Closes Bug: 1203723

Change-Id: Iac25185c7cc92ddebd3a22b602f7c8885d009807
2015-03-17 16:27:29 +02:00
Jenkins
36b13f58cf Merge "Deprecate SCREEN_LOGDIR in favor of LOGDIR" 2015-01-29 05:57:19 +00:00
Dean Troyer
dde41d0797 Deprecate SCREEN_LOGDIR in favor of LOGDIR
This is the first step in the log file cleanup.  If SCREEN_LOGDIR
is still set, symlinks will be created in the old screen log directory
so things like the devstack-gate log collector continues to work.

bp:logging-and-service-names
Change-Id: I3ac796e322a18dbd0b8b2310a08310ca159d7613
2015-01-20 16:08:22 -06:00
JordanP
37b7a665d0 Fix doc: API_RATE_LIMIT has been removed
Ib0538bdd23b17e519b9c917018ccc9fa8c6425c5 removed the option
API_RATE_LIMIT. So don't mention it in the documentation.

Change-Id: I9df67c3dd1b800f6a51de2cd78aeaad10ca38f7e
2015-01-20 14:28:22 +01:00
Juan Antonio Osorio Robles
fe6dccb0a8 Fix typos in the configuration documentation
Change-Id: I0089c195f4cda313c3b68a7c5c215b9dbff94db2
2014-11-28 13:12:14 +02:00
Jenkins
b103e1abd8 Merge "Add IPv6 support for tenant data network" 2014-11-20 20:09:43 +00:00
Sean Dague
07d7e5b1f9 add LIBS_FROM_GIT to docs
Also reformat common configuration variables to have an additional
header level which makes it easy to direct link to specific
configuration vars when directing someone.

Reformat header markup to us a more standard == = - for h1, h2, h3

Change-Id: I10bac5a93529cdfbcde0a05f9ebdbc1799d403cd
2014-11-18 06:44:20 -05:00
John Davidge
21529a50e3 Add IPv6 support for tenant data network
Define IP_VERSION with one of the three values 4, 6, or 4+6 in
your localrc to indicate if you intend to run your tenant data network
as either IPv4, IPv6, or dual stack respectively. Default value is 4.

If your IP_VERSION is set to 6 or 4+6, then the following variables
should be defined in your localrc:
  - FIXED_RANGE_V6: The IPv6 prefix for your tenant network
  - IPV6_PRIVATE_NETWORK_GATEWAY: The gateway IP with the same prefix
  - IPV6_RA_MODE (with default as slaac)
  - IPV6_ADDRESS_MODE (with default as slaac)

If you're going to use IPV6_RA_MODE/IPV6_ADDRESS_MODE settings other
than the defaults then you should make sure your VM image has dhcpv6
client enabled at bootup, otherwise you'll need to run it manually
after the VM is booted.

It's recommended to run the latest version of dnsmasq 2.68.
If you intend to enable internet access in your VM, make sure
your network node has IPv6 internet access, and the IPv6 prefix for
your tenant network is a GUA and routable.

Implements: blueprint ipv6-support
Change-Id: I848abf18e00e2a869697c5ef6366bc567dde448a
Co-Authored-By: John Davidge <jodavidg@cisco.com>
2014-11-17 05:16:07 -08:00
Dean Troyer
ea3cdfad1f Pass through the rest of the docs
Do the link cleanups and update a handful of things that were
out of date.

Change-Id: I758027bf3577c66cfb13df963516823a5c247080
2014-11-08 08:29:20 -06:00
Dean Troyer
0986a7b760 Remove old HTML headers
Change-Id: I39107df88aeb89d3364ad479d8c313b7a79b9440
2014-11-06 06:40:45 -06:00
Sean M. Collins
0f3bafc74e Remove copyright footer from RST docs
Change-Id: I2fe6aac7caec21af26983636d6ec827b3525ee15
2014-10-24 10:48:46 -04:00
Sean M. Collins
09e550c370 Convert all HTML doc to RST
The motivation for this conversion is to have DevStack's docs be
generated using a more familair workflow for OpenStack projects, using
Sphinx.

Changing from raw HTML to RST will also make it easier to contribute
more documentation, as well as making edits less of a hassle.

The majority of the work was done by using Pandoc to convert from HTML
to RST, with minor edits to the output to remove errors in Sphinx.

Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-22 12:27:00 -04:00