Skip to content

Commit c267085

Browse files
Merge pull request #3422 from travis-ci/DU-22/Heading-updates
Du 22/heading updates
2 parents 8b5dab9 + bf4231e commit c267085

27 files changed

+251
-212
lines changed

user/enterprise.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ integrates with GitHub.com, enabling you to have greater control over your secur
2424
to scale out your build infrastructure as needed.
2525

2626

27-
## Why choose Enterprise over travis-ci.com?
27+
## Why Enterprise over travis-ci.com
2828

2929
Travis CI Enterprise is built to bring the features of the [hosted
3030
platform](/user/travis-pro) to different development processes. So whether you
@@ -88,18 +88,18 @@ Travis CI Enterprise requires a certain infrastructure for deployment. It curren
8888

8989
![Travis CI Enterprise About page](/images/TCIE-architecture1.png)
9090

91-
### Travis CI Enterprise consists of two major parts:
91+
### Travis CI Enterprise Core Services and Worker
9292

9393
1. TCI services (or TCI Core Services), responsible for integration with version control systems, authorizing builds, scheduling build jobs, etc.
9494
2. TCI Worker and build environment images (also called OS images).
9595

96-
#### TCI Core services require the following:
96+
#### TCI Enterprise Core Services
9797

9898
1. A PostgreSQL11 (or later) database.
9999
2. An infrastructure to deploy a Kubernetes cluster; it can be deployed in a server cluster or in a single machine if required
100100
3. Depending on your setup, you may want to deploy and configure some of the components on your own, e.g., RabbitMQ - see the [Setting up Travis CI Enterprise](/user/enterprise/tcie-3.x-setting-up-travis-ci-enterprise/) for more details.
101101

102-
#### TCI Worker requires the following:
102+
#### TCI Enterprise Worker
103103

104104
1. An infrastructure where a docker image containing the Worker and a linked build image can be deployed.
105105
2. Connectivity to certain Travis CI Core Services components - see the [Setting Up Worker](/user/enterprise/setting-up-worker/) for more details.
@@ -130,7 +130,7 @@ Set up Travis CI Enterprise by heading over our [set up](/user/enterprise/tcie-3
130130

131131
Or if you need more information on Travis CI, head back and view our [core concepts](/user/for-beginners/), the [Onboarding](/user/onboarding/) guide, or the [tutorials](/user/tutorials/tutorials-overview/).
132132

133-
## Contact
133+
## Contact Enterprise Support
134134

135135
{{ site.data.snippets.contact_enterprise_support }}
136136

user/enterprise/Multi-CPU-Builds.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ layout: en_enterprise
44

55
---
66

7-
## Multi CPU builds
7+
## Enable Multi CPU builds
88

99
If you wish to build on different multiple CPU architectures (ARM64, IBM PowerPC, IBM Z) and own or manage respective infrastructure, it is possible to do so using Travis CI.
1010

@@ -18,3 +18,7 @@ In order to enable the capability of building on multiple CPU architectures, the
1818
The MultiCPU environment runs as LXD containers within an LXD host. Once the infrastructure is set up, developers can use it by simply modifying the .travis.yml in the repository. Please see our [Multi CPU documentation](https://docs.travis-ci.com/user/multi-cpu-architectures/) for usage examples.
1919

2020
Please see [deployment](https://docs.travis-ci.com/user/enterprise/setting-up-worker/) and [configuration](https://docs.travis-ci.com/user/enterprise/worker-configuration/) instructions on preparing Travis CI Enterprise to build against various CPU architectures.
21+
22+
## Contact Enterprise Support
23+
24+
{{ site.data.snippets.contact_enterprise_support }}

user/enterprise/bionic.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ We recommend using a **compute optimized** machine with 8 vCPUs and ~16 GB of me
1414

1515
> A single worker machine can only be used together with one build environment. If you would like to setup additional build environments (such as Xenial or Focal), please provision an additional machine.
1616
17-
## Third party apt repositories and services disabled by default
17+
## Third-party apt repositories and services disabled by default
1818

1919
[Third party apt-repositories are removed](https://docs.travis-ci.com/user/reference/bionic/#third-party-apt-repositories-removed) to help reduce risk of unrelated interference and allow for faster apt-get updates.
2020

2121
[Services disabled by default](https://docs.travis-ci.com/user/reference/bionic/#services-disabled-by-default) to speed up boot time and improve performance.
2222

23-
## Installation with Travis CI Enterprise 2.2.6 and later
23+
## Install Bionic with Travis CI Enterprise 2.2.6 or higher
2424

2525
To install the Bionic build environment on a new server, run the commands below:
2626

@@ -33,7 +33,7 @@ $ sudo bash /tmp/installer.sh \
3333
--travis_build_images=bionic
3434
```
3535

36-
## Restarting `travis-worker`
36+
## Restart the travis-worker
3737

3838
After installation, or when configuration changes are applied to the worker, restart the worker as follows:
3939

@@ -43,7 +43,7 @@ $ sudo systemctl restart travis-worker
4343

4444
Worker configuration changes are applied on start.
4545

46-
## Running Builds in the Bionic Build Environment
46+
## Run Builds in the Bionic Build Environment
4747

4848
To run a project's builds in the new Bionic build environment, please add a `dist: bionic` to your `.travis.yml` file.
4949

user/enterprise/build-images.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Customizing Travis CI Enterprise Build Images
2+
title: Customize Travis CI Enterprise Build Images
33
layout: en_enterprise
44

55
---
@@ -9,7 +9,7 @@ development process and improve the build environment and performance.
99

1010

1111

12-
## Customizing Build Images
12+
## Customize Build Images
1313

1414
After pulling the build images from
1515
[quay.io](https://quay.io/organization/travisci) either through
@@ -61,7 +61,7 @@ you can run:
6161
docker -H tcp://0.0.0.0:4243 rm travis_ruby
6262
```
6363

64-
## Enabling Docker Builds
64+
## Enable Docker Builds
6565

6666
### Worker machine configuration
6767

user/enterprise/custom-queues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ production:
4949
5050
See the [example](#advanced-configuration-yaml-example) for details on syntax. Click 'Save' on the Management Console Settings when you are ready. Travis CI Enterprise will restart with your new queue settings.
5151
52-
### Advanced Configuration YAML Example
52+
### Advanced Configuration YAML
5353
5454
The syntax for the **Advanced Configuration YAML** field is very important. Incorrect syntax will result in builds being routed to defaults, usually a `builds.linux` queue, depending on if there are any modifications to your installation. Here's an example of a custom queue definition:
5555

user/enterprise/focal.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
title: Focal Build Containers for Enterprise (beta)
2+
title: Focal Build Containers for Enterprise
33
layout: en_enterprise
44

55
---
66

7+
> Note: Focal Build Containers for Enterprise is a beta feature.
8+
79
## System Setup
810

911
**Platform Requirements**: To use the Focal build containers, the Travis CI Enterprise (TCIE) installation must be at version 3.0 or higher.
@@ -15,13 +17,13 @@ We recommend using a **compute optimized** machine with 8 vCPUs and ~16 GB of me
1517

1618
> A single worker machine can only be used together with one build environment. If you would like to setup additional build environments (such as Xenial or Focal), please provision an additional machine.
1719
18-
## Third party apt repositories and services disabled by default
20+
## Third-party apt repositories and services disabled by default
1921

2022
[Third party apt-repositories are removed](https://docs.travis-ci.com/user/reference/focal/#third-party-apt-repositories-removed) to help reduce risk of unrelated interference and allow for faster apt-get updates.
2123

2224
[Services disabled by default](https://docs.travis-ci.com/user/reference/focal/#services-disabled-by-default) to speed up boot time and improve performance.
2325

24-
## Installation with Travis CI Enterprise 3.0 and later
26+
## Install Focal with Travis CI Enterprise 3.0 or higher
2527

2628
On a new server, please run the commands below to install the Focal build environment:
2729

@@ -34,7 +36,7 @@ $ sudo bash /tmp/installer.sh \
3436
--travis_build_images=focal
3537
```
3638

37-
## Restarting `travis-worker`
39+
## Restart the travis-worker
3840

3941
After installation, or when configuration changes are applied to the worker, restart the worker as follows:
4042

@@ -44,7 +46,7 @@ $ sudo systemctl restart travis-worker
4446

4547
Worker configuration changes are applied on start.
4648

47-
## Running Builds in the Focal Build Environment
49+
## Run Builds in the Focal Build Environment
4850

4951
To run a project's builds in the new Focal build environment, please add a `dist: focal` to your `.travis.yml` file.
5052

user/enterprise/high-availability.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ layout: en_enterprise
88

99
Travis CI Enterprise (TCIE) 3.x typically runs in **a Kubernetes cluster** with one or multiple workers. Services are split into several pods in the cluster. This enables a High Availability setup out of the box which you are able to customize based on your needs.
1010

11-
### Installing the Platform in High Availability Mode
11+
### Install the Platform in High Availability Mode
1212

1313
Please make sure to configure your [Kubernetes](https://kubernetes.io/) cluster with redundant pods for each service and secure appropriate resources and configuration (see below) to run it or choosing to self-host several services. You will need to modify several services configuration on your own to achieve High Availability adjusted to your requirements.
1414

1515
Select one of the options depending on your planned setup, deployment, data backup policies, the volume of users, and the number of build jobs. See also the regular [installation instructions for TCIE 3.x](/user/enterprise/tcie-3.x-setting-up-travis-ci-enterprise/#1-setting-up-enterprise-platform).
1616

17-
#### Self hosting services for High Availability Mode
17+
#### Self-hosting services for High Availability Mode
1818

1919
You may need to consider self-hosting of
2020

@@ -25,9 +25,9 @@ Once TCIE 3.x is installed, go to the Dashboard, Configs and format *self-hosted
2525

2626
![Self-hosted config example](/images/tcie-3.x-self-hosted-db.png)
2727

28-
Similar configuration options are available for self-hosted logs, Insights, Redis and Rabbit MQ. The self-hosted solution for these services allows you to fully deploy and configure their High Availability compliant setup as per your requirements.
28+
Similar configuration options are available for self-hosted logs, Insights, Redis, and Rabbit MQ. The self-hosted solution for these services allows you to fully deploy and configure their High-Availability compliant setup as per your requirements.
2929

30-
#### Utilizing services in Kubernetes cluster
30+
#### Kubernetes cluster services
3131

3232
Another option is to modify the configuration for the aforementioned services (PostgreSQL, Redis, and RabbitMQ) taking into account service specific details. These details can be found in the documentation for the tools. Since there are multiple possible variations, we suggest only general guidelines that should be treated as a starting point for developing your specific High Availability configuration.
3333

@@ -47,7 +47,7 @@ Travis CI Enterprise 2.x typically runs as a single container instance communica
4747

4848
If you're interested, or might be interested, in running Travis CI Enterprise in High Availability mode, please email us at [[email protected]](mailto:enterprise@travis-cicom?subject:HA%20Mode) and we can discuss options and help you get started.
4949

50-
### Overview of Installation
50+
### Installation Overview
5151

5252
The platform installation is similar to the standard [Enterprise installation](/user/enterprise/setting-up-travis-ci-enterprise/#1-setting-up-enterprise-platform-virtual-machine), and the [worker installation](#installing-the-worker-in-high-availability-mode) is identical. However, there are some additional [system prerequisites](/user/enterprise/high-availability/), which means that to install in HA mode, you will need the following:
5353
* 3+ **16 gigs of RAM, 8 CPUs, 40GB HDD**, i.e. `c4.2xlarge` with a 40GB HDD. - 2+ for the VMs running the Platform, and 1+ for the VMs running the Worker
@@ -56,7 +56,7 @@ and [Postgres](https://www.postgresql.org/) instances
5656
* [GitHub OAuth app](/user/enterprise/setting-up-travis-ci-enterprise/#prerequisites), [trial license](/user/enterprise/setting-up-travis-ci-enterprise/#prerequisites) -- enabled for HA
5757
* Internet connection -- note, this installation is _not_ airgapped by default. Let [us know](mailto:[email protected]) if you are interested in one.
5858

59-
### Installing the Platform in High Availability Mode
59+
### Install the Platform in High Availability Mode
6060

6161
HA is configured entirely on the Enterprise platform instance, but installing an HA platform is quite similar to installing a standard platform. The steps for HA are as follows.
6262

@@ -76,15 +76,15 @@ HA is configured entirely on the Enterprise platform instance, but installing an
7676

7777
Once your first platform instance is fully configured, you should be able to see the UI and request a build - your build will only run correctly, if a worker is installed. Try out your new platform, and [please let us know](mailto:[email protected]?subject=HA%20Troubleshooting) if you have questions.
7878

79-
#### Adding More Platform Installations
79+
#### Add more Platform Installations
8080

8181
We recommend at least two Platform containers for HA mode and you can install more Enterprise containers in the same way you [installed](/user/enterprise/setting-up-travis-ci-enterprise/#1-setting-up-enterprise-platform-virtual-machine) the first.
8282

8383
Once your second platform is installed, it will also need its HA settings configured. Go to the Admin Dashboard for your new platform container at `https://<your-second-travis-ci-enterprise-domain>:8800` to configure these as you did for [the first platform installation](#installing-the-platform-in-high-availability-mode).
8484

8585

8686

87-
## Installing the Worker in High Availability Mode (all versions)
87+
## Install the Worker in High Availability Mode (all versions)
8888

8989
The worker installation works the same as for non-HA installations, as do the build environment compatibility defaults per Enterprise version. Check out the docs for which version of Enterprise handle different OS's([TCIE 2.x](/user/enterprise/setting-up-travis-ci-enterprise/#2-setting-up-the-enterprise-worker-virtual-machine) or [TCIE 3.x](/user/enterprise/tcie-3.x-setting-up-travis-ci-enterprise/#2-setting-up-the-enterprise-worker-virtual-machine) and other information regarding the installation. You will need to retrieve your RabbitMQ password from your own installation, rather than from the Travis CI Enterprise Admin Dashboard.
9090

0 commit comments

Comments
 (0)