blob: 81d4b80b8a867d83a97214f88bc2ce8fda03610d [file] [log] [blame]
Dean Troyer0986a7b2014-10-29 22:08:13 -05001===========================
2stackrc - DevStack Settings
3===========================
Sean M. Collins09e550c2014-10-21 11:40:08 -04004
5``stackrc`` is the primary configuration file for DevStack. It contains
6all of the settings that control the services started and the
7repositories used to download the source for those services. ``stackrc``
8sources the ``localrc`` section of ``local.conf`` to perform the default
9overrides.
10
11DATABASE\_TYPE
12 Select the database backend to use. The default is ``mysql``,
13 ``postgresql`` is also available.
14ENABLED\_SERVICES
15 Specify which services to launch. These generally correspond to
16 screen tabs. The default includes: Glance (API and Registry),
17 Keystone, Nova (API, Certificate, Object Store, Compute, Network,
Dean Troyerea3cdfa2014-11-08 08:29:16 -060018 Scheduler, Certificate Authentication), Cinder
Sean M. Collins09e550c2014-10-21 11:40:08 -040019 (Scheduler, API, Volume), Horizon, MySQL, RabbitMQ, Tempest.
20
21 ::
22
Davanum Srinivas4a974e62016-01-11 22:10:43 -050023 ENABLED_SERVICES=g-api,g-reg,key,n-api,n-crt,n-cpu,n-net,n-cond,c-sch,c-api,c-vol,n-sch,n-cauth,horizon,rabbit,tempest,$DATABASE_TYPE
Sean M. Collins09e550c2014-10-21 11:40:08 -040024
25 Other services that are not enabled by default can be enabled in
26 ``localrc``. For example, to add Swift, use the following service
27 names:
28
29 ::
30
31 enable_service s-proxy s-object s-container s-account
32
33 A service can similarly be disabled:
34
35 ::
36
37 disable_service horizon
38
39Service Repos
40 The Git repositories used to check out the source for each service
41 are controlled by a pair of variables set for each service.
42 ``*_REPO`` points to the repository and ``*_BRANCH`` selects which
43 branch to check out. These may be overridden in ``local.conf`` to
44 pull source from a different repo for testing, such as a Gerrit
45 branch proposal. ``GIT_BASE`` points to the primary repository
46 server.
47
48 ::
49
50 NOVA_REPO=$GIT_BASE/openstack/nova.git
51 NOVA_BRANCH=master
52
53 To pull a branch directly from Gerrit, get the repo and branch from
54 the Gerrit review page:
55
56 ::
57
58 git fetch https://review.openstack.org/p/openstack/nova refs/changes/50/5050/1 && git checkout FETCH_HEAD
59
60 The repo is the stanza following ``fetch`` and the branch is the
61 stanza following that:
62
63 ::
64
65 NOVA_REPO=https://review.openstack.org/p/openstack/nova
66 NOVA_BRANCH=refs/changes/50/5050/1