1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
.. _user_config:
User configuration
==================
User configuration and preferences can be specified in a user provided
configuration file, and usually also on the command line.
Values specified in a user provided configuration file override the
defaults, while command line options take precedence over any other
specified configurations.
Configuration file
------------------
Users can provide a configuration file to override parameters in
the default configuration.
Unless a configuration file is explicitly specified on the command line when
invoking ``bst``, an attempt is made to load user specific configuration from
``$XDG_CONFIG_HOME/buildstream.conf``. On most Linux based systems, the location
will be ``~/.config/buildstream.conf``
Project specific value
----------------------
The ``projects`` key can be used to specify project specific configurations,
the supported configurations on a project wide basis are listed here.
.. _config_artifacts:
Artifact server
~~~~~~~~~~~~~~~
Although project's often specify a :ref:`remote artifact cache <artifacts>` in
their ``project.conf``, you may also want to specify extra caches.
Assuming that your host/server is reachable on the internet as ``artifacts.com``
(for example), there are two ways to declare remote caches in your user
configuration:
1. Adding global caches:
.. code:: yaml
#
# Artifacts
#
artifacts:
# Add a cache to pull from
- url: https://artifacts.com/artifacts:11001
server-cert: server.crt
# Add a cache to push/pull to/from
- url: https://artifacts.com/artifacts:11002
server-cert: server.crt
client-cert: client.crt
client-key: client.key
push: true
# Add another cache to pull from
- url: https://anothercache.com/artifacts:8080
server-cert: another_server.crt
.. note::
Caches declared here will be used by **all** BuildStream project's on the user's
machine and are considered a lower priority than those specified in the project
configuration.
2. Specifying caches for a specific project within the user configuration:
.. code:: yaml
projects:
project-name:
artifacts:
# Add a cache to pull from
- url: https://artifacts.com/artifacts:11001
server-cert: server.crt
# Add a cache to push/pull to/from
- url: https://artifacts.com/artifacts:11002
server-cert: server.crt
client-cert: client.crt
client-key: client.key
push: true
# Add another cache to pull from
- url: https://ourprojectcache.com/artifacts:8080
server-cert: project_server.crt
.. note::
Caches listed here will be considered a higher priority than those specified
by the project. Furthermore, for a given list of URLs, earlier entries will
have higher priority.
Notice that the use of different ports for the same server distinguishes between
pull only access and push/pull access. For information regarding this and the
server/client certificates and keys, please see:
:ref:`Key pair for the server <server_authentication>`.
Strict build plan
~~~~~~~~~~~~~~~~~
The strict build plan option decides whether you want elements
to rebuild when their dependencies have changed. This is enabled
by default, but recommended to turn off in developer scenarios where
you might want to build a large system and test it quickly after
modifying some low level component.
**Example**
.. code:: yaml
projects:
project-name:
strict: False
.. note::
It is always possible to override this at invocation time using
the ``--strict`` and ``--no-strict`` command line options.
.. _config_default_mirror:
Default Mirror
~~~~~~~~~~~~~~
When using :ref:`mirrors <project_essentials_mirrors>`, a default mirror can
be defined to be fetched first.
The default mirror is defined by its name, e.g.
.. code:: yaml
projects:
project-name:
default-mirror: oz
.. note::
It is possible to override this at invocation time using the
``--default-mirror`` command-line option.
Default configuration
---------------------
The default BuildStream configuration is specified here for reference:
.. literalinclude:: ../../buildstream/data/userconfig.yaml
:language: yaml
|
