Skip to content

Commit ff5220a

Browse files
authored
Update worker-configuration.md
1 parent 2dcf824 commit ff5220a

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

user/enterprise/worker-configuration.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The following section shows how to connect to the platform with different Ubuntu
1313
### Connect with Ubuntu 16.04
1414

1515
The configuration for connecting to the Travis CI Enterprise platform can be found in `/etc/default/travis-worker`.
16-
If you need to change the hostname the Worker should connect to, or the
16+
If you need to change the hostname the Worker should connect to or the
1717
RabbitMQ password, you can do so by updating:
1818

1919
```sh
@@ -23,10 +23,10 @@ export AMQP_URI="amqp://travis:<rabbitmq password>@<your-travis-ci-enterprise-do
2323
### Connect with Ubuntu 14.04
2424

2525
The configuration for connecting to the Travis CI Enterprise Platform,
26-
including the RabbitMQ password, can be found in
26+
including the RabbitMQ password, which can be found in
2727
`/etc/default/travis-enterprise`.
2828

29-
If you need to change the hostname the Worker should connect to, or the
29+
If you need to change the hostname the Worker should connect to or the
3030
RabbitMQ password, you can do so by updating:
3131

3232
```sh
@@ -37,7 +37,7 @@ export TRAVIS_ENTERPRISE_SECURITY_TOKEN="super-secret-password"
3737
## Set Timeouts
3838

3939
The following options can be customized in `/etc/default/travis-worker`.
40-
It is recommended to have all Workers use the same config.
40+
It is recommended that all workers use the same configuration.
4141

4242
By default, jobs can run for a maximum of 50 minutes. You can increase or
4343
decrease this using the following setting:
@@ -46,7 +46,7 @@ decrease this using the following setting:
4646
export TRAVIS_WORKER_HARD_TIMEOUT="50m"
4747
```
4848

49-
If no log output has been received for more than 10mins, the job is cancelled as
49+
If no log output has been received for more than 10 mins, the job is canceled as
5050
it is assumed the job stalled. You can customize this timeout using the
5151
following setting:
5252

@@ -62,7 +62,7 @@ allowed for a job to use are configured with the
6262
variables, respectively. Each Job requires a minimum of 2 CPUs, and by
6363
default, each Worker runs 2 jobs. The product of
6464
`TRAVIS_WORKER_POOL_SIZE * TRAVIS_WORKER_POOL_SIZE` cannot exceed the
65-
number of CPUs the worker machine has, otherwise jobs will error and
65+
number of CPUs the worker machine has; otherwise, jobs will error and
6666
requeue.
6767

6868
To change the number of concurrent jobs allowed for a worker to use,
@@ -81,8 +81,8 @@ export TRAVIS_WORKER_DOCKER_CPUS=2
8181
```
8282

8383
To completely disable this setting, set the value to 0. Then
84-
resources will be used as needed, which means a single job can for
85-
example use all CPU cores.
84+
resources will be used as needed, which means a single job can be for
85+
example, use all CPU cores.
8686

8787
```sh
8888
export TRAVIS_WORKER_DOCKER_CPUS=0
@@ -92,7 +92,7 @@ export TRAVIS_WORKER_DOCKER_CPUS=0
9292
## Change the Worker Hostname
9393

9494
Each Worker should have a unique hostname, making it easier to determine
95-
where jobs ran. By default this is set to the `hostname` of the host the
95+
where jobs run. By default, this is set to the `hostname` of the host the
9696
Worker is running on.
9797

9898
```sh
@@ -152,7 +152,7 @@ export TRAVIS_WORKER_MAX_LOG_LENGTH=40000000
152152

153153
You can use [Docker bind mounts](https://docs.docker.com/storage/bind-mounts/)
154154
when the worker launches the container of a job. This lets you share files or directories
155-
across all jobs ran by a worker. Multiple binds can be provided
155+
across all jobs run by a worker. Multiple binds can be provided
156156
as _space separated_ strings.
157157

158158
For example, the setting below shows how to share the `/tmp` directory in read/write mode,
@@ -202,17 +202,17 @@ export TRAVIS_WORKER_DOCKER_HTTP_PROXY="<YOUR PROXY URL>"
202202
export TRAVIS_WORKER_DOCKER_API_VERSION=1.35
203203
```
204204

205-
In this example we've used Docker-CE 17.12. According to the [API mismatch table](https://docs.docker.com/develop/sdk/#docker-ee-and-ce-api-mismatch) we need to choose `1.35` for `TRAVIS_WORKER_DOCKER_API_VERSION`.
205+
In this example, we've used Docker-CE 17.12. According to the [API mismatch table](https://docs.docker.com/develop/sdk/#docker-ee-and-ce-api-mismatch) we need to choose `1.35` for `TRAVIS_WORKER_DOCKER_API_VERSION`.
206206

207-
Below you can find the full list of available environment variables and how they're accessible during the build:
207+
Below, you can find the full list of available environment variables and how they're accessible during the build:
208208

209209
Environment variable | Available as:
210210
`TRAVIS_WORKER_DOCKER_HTTP_PROXY` | `HTTP_PROXY`, `http_proxy`
211211
`TRAVIS_WORKER_DOCKER_HTTPS_PROXY` | `HTTPS_PROXY`, `https_proxy`
212212
`TRAVIS_WORKER_DOCKER_NO_PROXY` | `NO_PROXY`, `no_proxy`
213213
`TRAVIS_WORKER_DOCKER_FTP_PROXY` | `FTP_PROXY`, `ftp_proxy`
214214

215-
> Please note, that all `apt-get` commands by default respect `TRAVIS_WORKER_DOCKER_HTTP_PROXY` and `TRAVIS_WORKER_DOCKER_HTTPS_PROXY` which means that all package installs will go via the HTTP Proxy as well. If you don't want this to happen, please whitelist your apt package mirror by adding it to TRAVIS_WORKER_DOCKER_NO_PROXY` like this:
215+
> Please note that all `apt-get` commands by default respect `TRAVIS_WORKER_DOCKER_HTTP_PROXY` and `TRAVIS_WORKER_DOCKER_HTTPS_PROXY`, which means that all package installs will go via the HTTP Proxy as well. If you don't want this to happen, please whitelist your apt package mirror by adding it to TRAVIS_WORKER_DOCKER_NO_PROXY` like this:
216216
217217
```
218218
export TRAVIS_WORKER_DOCKER_NO_PROXY='.ubuntu.com,packagecloud.io,.postgresql.org'
@@ -222,15 +222,15 @@ export TRAVIS_WORKER_DOCKER_NO_PROXY='.ubuntu.com,packagecloud.io,.postgresql.or
222222

223223
After running the `lxd_install.sh` the LXD worker configuration is stored in `/var/snap/travis-worker/common/worker.env`.
224224

225-
All parameters mentioned on this page with the exception of Docker parameters apply to LXD.
225+
All parameters mentioned on this page, with the exception of Docker parameters, apply to LXD.
226226
Below you can find a list of available parameters:
227227

228228
Parameters | Definition:
229229
`TRAVIS_WORKER_LXD_CPUS` | defines how many CPU's can be used by LXD, the default is `2`.
230230
`TRAVIS_WORKER_LXD_CPUS_BURST` | defines if all CPU's can be used by LXD if not already in use, the default is `True`.
231231
`TRAVIS_WORKER_LXD_DISK` | LXD disk size limit, the default is `20Gb`.
232-
`TRAVIS_WORKER_LXD_ARCH_OVERRIDE` | overrides the architecture defined in the job configuration, not present by default.
233-
`TRAVIS_WORKER_LXD_MEMORY` | defines the memory available for each container, the default is `4Gb`.
232+
`TRAVIS_WORKER_LXD_ARCH_OVERRIDE` | overrides the architecture defined in the job configuration, which is not present by default.
233+
`TRAVIS_WORKER_LXD_MEMORY` | defines the memory available for each container; the default is `4Gb`.
234234
`TRAVIS_WORKER_LXD_NETWORK` | defines the network bandwidth, the default is `1Gb`.
235235

236236
## Contact Enterprise Support

0 commit comments

Comments
 (0)