8000 gh-1178: Fix indentation in the buildbot page (#1179) · python/devguide@40e97a8 · GitHub
[go: up one dir, main page]
Skip to content

Commit 40e97a8

Browse files
ezio-melottiezio-melotti
authored
gh-1178: Fix indentation in the buildbot page (#1179)
1 parent c2de3bc commit 40e97a8

File tree

1 file changed

+98
-98
lines changed

1 file changed

+98
-98
lines changed

‎testing/new-buildbot-worker.rst

Lines changed: 98 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -70,28 +70,28 @@ if you choose that path.
7070

7171
For Linux:
7272

73-
* If your package manager provides the buildbot worker software, that is
74-
probably the best way to install it; it may create the buildbot user for
75-
you, in which case you can skip that step. Otherwise, do ``pip install
76-
buildbot-worker``.
77-
* Create a ``buildbot`` user (using, eg: ``useradd``) if necessary.
78-
* Log in as the buildbot user.
73+
* If your package manager provides the buildbot worker software, that is
74+
probably the best way to install it; it may create the buildbot user for
75+
you, in which case you can skip that step. Otherwise, do ``pip install
76+
buildbot-worker``.
77+
* Create a ``buildbot`` user (using, eg: ``useradd``) if necessary.
78+
* Log in as the buildbot user.
7979

8080
For Mac:
8181

82-
* Create a buildbot user using the OS/X control panel user admin. It
83-
should be a "standard" user.
84-
* Log in as the buildbot user.
85-
* Install the buildbot worker [#]_ by running ``pip install buildbot-worker``.
82+
* Create a buildbot user using the OS/X control panel user admin. It
83+
should be a "standard" user.
84+
* Log in as the buildbot user.
85+
* Install the buildbot worker [#]_ by running ``pip install buildbot-worker``.
8686

8787
For Windows:
8888

89-
* Create a buildbot user as a "standard" user.
90-
* Install the latest version of Python from python.org.
91-
* Open a Command Prompt.
92-
* Execute ``python -m pip install pypiwin32 buildbot-worker`` (note that
93-
``python.exe`` is not added to ``PATH`` by default, making the
94-
``python`` command accessible is left as an exercise for the user).
89+
* Create a buildbot user as a "standard" user.
90+
* Install the latest version of Python from python.org.
91+
* Open a Command Prompt.
92+
* Execute ``python -m pip install pypiwin32 buildbot-worker`` (note that
93+
``python.exe`` is not added to ``PATH`` by default, making the
94+
``python`` command accessible is left as an exercise for the user).
9595

9696
In a terminal window for the buildbot user, issue the following commands (you
9797
can put the ``buildarea`` wherever you want to)::
@@ -113,73 +113,73 @@ machine reboots:
113113

114114
For Linux:
115115

116-
* Add the following line to ``/etc/crontab``::
116+
* Add the following line to ``/etc/crontab``::
117117

118-
@reboot buildbot-worker restart /path/to/buildarea
118+
@reboot buildbot-worker restart /path/to/buildarea
119119

120-
Note that we use ``restart`` rather than ``start`` in case a crash has
121-
left a ``twistd.pid`` file behind.
120+
Note that we use ``restart`` rather than ``start`` in case a crash has
121+
left a ``twistd.pid`` file behind.
122122

123123
For OSX:
124124

125-
* Create a bin directory for your buildbot user::
126-
127-
mkdir bin
128-
129-
* Place the following script, named ``run_worker.sh``, into that directory::
130-
131-
#!/bin/bash
132-
export PATH=/usr/local/bin:/Library/Frameworks/Python.framework/Versions/2.7/bin:$PATH
133-
export LC_CTYPE=en_US.utf-8
134-
cd /Users/buildbot/buildarea
135-
twistd --nodaemon --python=buildbot.tac --logfile=buildbot.log --prefix=worker
136-
137-
If you use pip with Apple's system python, add '/System' to the front of
138-
the path to the Python bin directory.
139-
140-
* Place a file with the following contents into ``/Library/LaunchDaemons``:
141-
142-
.. code-block:: xml
143-
144-
<?xml version="1.0" encoding="UTF-8"?>
145-
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN"
146-
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
147-
<plist version="1.0">
148-
<dict>
149-
<key>Label</key>
150-
<string>net.buildbot.worker</string>
151-
<key>UserName</key>
152-
<string>buildbot</string>
153-
<key>WorkingDirectory</key>
154-
<string>/Users/buildbot/buildarea</string>
155-
<key>ProgramArguments</key>
156-
<array>
157-
<string>/Users/buildbot/bin/run_worker.sh</string>
158-
</array>
159-
<key>StandardOutPath</key>
160-
<string>twistd.log</string>
161-
<key>StandardErrorPath</key>
162-
<string>twistd.log</string>
163-
<key>KeepAlive</key>
164-
<true/>
165-
<key>SessionCreate</key>
166-
<true/>
167-
</dict>
168-
</plist>
169-
170-
The recommended name for the file is ``net.buildbot.worker``.
125+
* Create a bin directory for your buildbot user::
126+
127+
mkdir bin
128+
129+
* Place the following script, named ``run_worker.sh``, into that directory::
130+
131+
#!/bin/bash
132+
export PATH=/usr/local/bin:/Library/Frameworks/Python.framework/Versions/2.7/bin:$PATH
133+
export LC_CTYPE=en_US.utf-8
134+
cd /Users/buildbot/buildarea
135+
twistd --nodaemon --python=buildbot.tac --logfile=buildbot.log --prefix=worker
136+
137+
If you use pip with Apple's system python, add '/System' to the front of
138+
the path to the Python bin directory.
139+
140+
* Place a file with the following contents into ``/Library/LaunchDaemons``:
141+
142+
.. code-block:: xml
143+
144+
<?xml version="1.0" encoding="UTF-8"?>
145+
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN"
146+
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
147+
<plist version="1.0">
148+
<dict>
149+
<key>Label</key>
150+
<string>net.buildbot.worker</string>
151+
<key>UserName</key>
152+
<string>buildbot</string>
153+
<key>WorkingDirectory</key>
154+
<string>/Users/buildbot/buildarea</string>
155+
<key>ProgramArguments</key>
156+
<array>
157+
<string>/Users/buildbot/bin/run_worker.sh</string>
158+
</array>
159+
<key>StandardOutPath</key>
160+
<string>twistd.log</string>
161+
<key>StandardErrorPath</key>
162+
<string>twistd.log</string>
163+
<key>KeepAlive</key>
164+
<true/>
165+
<key>SessionCreate</key>
166+
<true/>
167+
</dict>
168+
</plist>
169+
170+
The recommended name for the file is ``net.buildbot.worker``.
171171

172172
For Windows:
173173

174-
* Add a Scheduled Task to run ``buildbot-worker start buildarea`` as the
175-
buildbot user "when the computer starts up". It is best to provide
176-
absolute paths to the ``buildbot-worker`` command and the :file:`buildarea`
177-
directory. It is also recommended to set the task to run in the
178-
directory that contains the :file:`buildarea` directory.
174+
* Add a Scheduled Task to run ``buildbot-worker start buildarea`` as the
175+
buildbot user "when the computer starts up". It is best to provide
176+
absolute paths to the ``buildbot-worker`` command and the :file:`buildarea`
177+
directory. It is also recommended to set the task to run in the
178+
directory that contains the :file:`buildarea` directory.
179179

180-
* Alternatively (note: don't do both!), set up the worker
181-
service as described in the `buildbot documentation
182-
<https://docs.buildbot.net/current/manual/installation/requirements.html#windows-support>`_.
180+
* Alternatively (note: don't do both!), set up the worker
181+
service as described in the `buildbot documentation
182+
<https://docs.buildbot.net/current/manual/installation/requirements.html#windows-support>`_.
183183

184184
To start the worker running for your initial testing, you can do::
185185

@@ -203,20 +203,20 @@ We also support running `latent workers
203203
<http://docs.buildbot.net/current/manual/configuration/workers.html#latent-workers>`_
204204
on the AWS EC2 service. To set up such a worker:
205205

206-
* Start an instance of your chosen base AMI and set it up as a
207-
conventional worker.
208-
* After the instance is fully set up as a conventional worker (including
209-
worker name and password, and admin and host information), create an AMI
210-
from the instance and stop the instance.
211-
* Contact the buildmaster administrator who gave you your worker
212-
name and password and give them the following information:
213-
214-
* Instance size (such as ``m4.large``)
215-
* Full region specification (such as ``us-west-2``)
216-
* AMI ID (such as ``ami-1234beef``)
217-
* An Access Key ID and Access Key. It is recommended to set up
218-
a separate IAM user with full access to EC2 and provide the access key
219-
information for that user rather than for your main account.
206+
* Start an instance of your chosen base AMI and set it up as a
207+
conventional worker.
208+
* After the instance is fully set up as a conventional worker (including
209+
worker name and password, and admin and host information), create an AMI
210+
from the instance and stop the instance.
211+
* Contact the buildmaster administrator who gave you your worker
212+
name and password and give them the following information:
213+
214+
* Instance size (such as ``m4.large``)
215+
* Full region specification (such as ``us-west-2``)
216+
* AMI ID (such as ``ami-1234beef``)
217+
* An Access Key ID and Access Key. It is recommended to set up
218+
a separate IAM user with full access to EC2 and provide the access key
219+
information for that user rather than for your main account.
220220

221221
The buildmaster cannot guarantee that it will always shut down your
222222
instance(s), so it is recommended to periodically check and make sure
@@ -231,13 +231,13 @@ or other software updates, but when to do such maintenance is largely up to you
231231
as the worker owner. There are a couple different options for doing such
232232
updates:
233233

234-
* Start an instance from your existing AMI, do updates on that instance,
235-
and save a new AMI from the updated instance. Note that (especially for
236-
Windows workers) you should do at least one restart of the instance after
237-
doing updates to be sure that any post-reboot update work is done before
238-
creating the new AMI.
239-
* Create an entirely new setup from a newer base AMI using your existing
240-
worker name and password.
234+
* Start an instance from your existing AMI, do updates on that instance,
235+
and save a new AMI from the updated instance. Note that (especially for
236+
Windows workers) you should do at least one restart of the instance after
237+
doing updates to be sure that any post-reboot update work is done before
238+
creating the new AMI.
239+
* Create an entirely new setup from a newer base AMI using your existing
240+
worker name and password.
241241

242242
Whichever way you choose to update your AMI, you'll need to provide the
243243
buildmaster administrators with the new AMI ID.
@@ -312,9 +312,9 @@ Based on the last time we did a `survey
312312
buildbot requirements, the recommended resource allocations for a python
313313
buildbot are at least:
314314

315-
* 2 CPUs
316-
* 512 MB RAM
317-
* 30 GB free disk space
315+
* 2 CPUs
316+
* 512 MB RAM
317+
* 30 GB free disk space
318318

319319
The bigmem tests won't run in this configuration, since they require
320320
substantially more memory, but these resources should be sufficient to ensure

0 commit comments

Comments
 (0)
0