Skip to content

Commit 520eae8

Browse files
authored
Update platform-tips.md
1 parent bbae387 commit 520eae8

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

user/enterprise/platform-tips.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ and tools.
1212
**TCIE 2.x**: Please connect to your Platform machine via SSH before getting
1313
started.
1414

15-
## Inspecting Logs and Running Services
15+
## Inspect Logs and Run Services
16+
17+
The following section describes how to inspect logs on different platforms and how to run the services.
1618

1719
### Platform logs
1820

@@ -36,20 +38,21 @@ On the Platform you can find the main log file at
3638

3739
### Worker logs
3840

39-
#### With Ubuntu 16.04 and later as host operating system
41+
This section describes how to obtain worker logs with Ubuntu as the host operating system.
42+
#### With Ubuntu 16.04 and higher
4043

4144
On the Worker you can obtain the worker logs by running:
4245

4346
```sh
4447
$ sudo journalctl -u travis-worker
4548
```
4649

47-
#### With Ubuntu 14.04 as host operating system
50+
#### With Ubuntu 14.04
4851

4952
On the Worker you can find the main log file at
5053
`/var/log/upstart/travis-worker.log`
5154

52-
## Accessing Travis Container and Console on the Platform
55+
## Access Travis Container and Console on the Platform
5356

5457
### Console access in TCIE 3.x
5558

@@ -67,7 +70,7 @@ Platform.
6770
`travis console`: This will get you into a Ruby IRB session on the
6871
Platform.
6972

70-
## Cancelling or Resetting Stuck Jobs
73+
## Cancel or Reset Stuck Jobs
7174

7275
Occasionally, jobs can get stuck in a `queued` state on the worker. To cancel or
7376
reset a large number of jobs, please execute the following steps:
@@ -86,7 +89,7 @@ Then, please run:
8689
>> stuck_jobs.each(&:reset!)
8790
```
8891

89-
## Clearing Redis Archive Queue (for releases < 2.1.7)
92+
## Clear Redis Archive Queue (V2.1.7 and prior)
9093

9194
In releases of Enterprise before 2.1.7, jobs where enqueued in the archive queue
9295
for log aggregation. Currently, this feature is available only for the hosted
@@ -109,7 +112,7 @@ Then, please run:
109112
>> Sidekiq::Queue.new('archive').clear
110113
```
111114

112-
## Managing RabbitMQ in TCIE 3.x
115+
## Manage RabbitMQ in TCIE 3.x
113116

114117
RabbitMQ is now deployed in separate pod named `travisci-platform-rabbitmq-ha-0` and all Rabbit-related maintenance should be done there.
115118
In order to access RabbitMQ pod execute
@@ -120,7 +123,7 @@ and perform any necessary actions.
120123

121124
The RabbitMQ management UI is available under `https://[platform-hostname]/amqp_ui`.
122125

123-
## Resetting the RabbitMQ Certificate in TCIE 2.x
126+
## Reset the RabbitMQ Certificate in TCIE 2.x
124127

125128
After an upgrade of Replicated 2.8.0 to a newer version, occasionally the service
126129
restarts with the following error:
@@ -148,7 +151,7 @@ $ sudo rm -r /etc/travis/ssl/rabbitmq.cert
148151
After this, do a full reboot of the system and everything should start again properly.
149152

150153

151-
## Viewing Sidekiq Queue Statistics
154+
## View Sidekiq Queue Statistics
152155

153156
In the past there have been reported cases where the system became unresponsive. It took quite a while until jobs where worked off or they weren't picked up at all. We found out that often full Sidekiq queues played a part in this. To get some insight, it helps to retrieve some basics statistics in the Ruby console:
154157

@@ -181,7 +184,7 @@ Then, please run:
181184
"user_sync"=>0}
182185
```
183186

184-
## Uninstalling Travis CI Enterprise 3.x
187+
## Uninstall Travis CI Enterprise 3.x
185188

186189
If you wish to uninstall Travis CI Enterprise 3.x from your Kubernetes cluster, please execute:
187190

@@ -194,7 +197,7 @@ $ sudo docker images | grep travis | awk '{print $3}' | xargs sudo docker rmi -f
194197
```
195198

196199

197-
## Uninstalling Travis CI Enterprise 2.x
200+
## Uninstall Travis CI Enterprise 2.x
198201

199202
If you wish to uninstall Travis CI Enterprise 2.x from your platform and worker
200203
machines, please follow the instructions below. On the platform machine, you
@@ -248,7 +251,7 @@ Additionally, please use the following command to clean up all Docker build imag
248251
$ sudo docker images | grep travis | awk '{print $3}' | xargs sudo docker rmi -f
249252
```
250253

251-
## Finding out about the Maximum Available Concurrency
254+
## Discover the Maximum Available Concurrency
252255

253256
To find out how much concurrency is available in your Travis CI Enterprise setup:
254257

@@ -265,7 +268,7 @@ root@te-main:/# rabbitmqctl list_consumers -p travis | grep builds.trusty | wc -
265268

266269
The number that's returned here is equal to the maximum number of concurrent jobs that are available. To adjust concurrency, please follow the instructions [here](/user/enterprise/worker-configuration/#configuring-the-number-of-concurrent-jobs) for each worker machine.
267270

268-
## Finding out how Many Worker Machines are Connected
271+
## Discover how many Worker Machines are Connected
269272

270273
If you wish to find out how many worker machines are currently connected, please follow these steps:
271274

@@ -281,7 +284,7 @@ root@te-main:/# rabbitmqctl list_consumers -p travis | grep amq.gen- | wc -l
281284

282285
If you need to boot more worker machines, please see our docs about [installing new worker machines](/user/enterprise/setting-up-travis-ci-enterprise/#2-setting-up-the-enterprise-worker-virtual-machine).
283286

284-
## Integrating Travis CI Enterprise into Your Monitoring
287+
## Integrate Travis CI Enterprise into your Monitoring
285288

286289
To check if your Travis CI Enterprise 2.x/3.x installation is up and running, query the `/api/uptime` endpoint of your instance.
287290

@@ -292,7 +295,7 @@ $ curl -H "Authorization: token XXXXX" https://<your-travis-ci-enterprise-domain
292295
If everything is up and running, it answers with a `HTTP 200 OK`, or in case of failure with an `HTTP 500 Internal Server Error`.
293296

294297

295-
## Configuring Backups
298+
## Configure Backups
296299

297300
This section explains how you integrate Travis CI Enterprise in your backup strategy. Here, we'll talk about two topics:
298301

@@ -309,7 +312,7 @@ Without the encryption key you cannot access the information in your production
309312

310313
{{ site.data.snippets.enterprise_2_encryption_key_backup }}
311314

312-
### Creating a backup of the data directories
315+
### Create a backup of the data directories
313316

314317
#### Data backup in TCIE 3.x
315318

@@ -362,7 +365,7 @@ The data directories are located on the platform machine and are mounted into th
362365

363366
The files are located at `/var/travis` on the platform machine. Please run `sudo tar -czvf travis-enterprise-data-backup.tar.gz /var/travis` to create a compressed archive from this folder. After this has finished, copy this file off the machine to a secure location.
364367

365-
## Migrating from GitHub Services to Webhooks
368+
## Migrate from GitHub Services to Webhooks
366369

367370
Travis CI Enterprise initially used GitHub Services to connect your repositories with GitHub.com (or GitHub Enterprise). As of January 31st, 2019 [services have been disabled on github.com](https://developer.github.com/changes/2019-01-29-life-after-github-services/). Services will also be disabled on GitHub Enterprise starting with GitHub Enterprise v2.17.0.
368371

0 commit comments

Comments
 (0)