Update tcie-3.x-setting-up-travis-ci-enterprise.md

nrios14 · web-flow · commit 659438bd8e97 · 2024-12-04T08:29:36.000-04:00
diff --git a/user/enterprise/tcie-3.x-setting-up-travis-ci-enterprise.md b/user/enterprise/tcie-3.x-setting-up-travis-ci-enterprise.md
@@ -23,7 +23,7 @@ Travis CI Enterprise Worker Images are publicly available and must be installed
 
 ## Travis CI Enterprise Core Services components
 
-Travis CI Enterprise Core Services consist of components enlisted below. Each service has its own pod. Please pay attention to the *Comments* section, where you can find a list of services that may require replicating pods for handling higher workloads.
+Travis CI Enterprise Core Services consist of components enlisted below. Each service has its own pod. Please pay attention to the *Comments* section, where you can find a list of services that may require replicating pods to handle higher workloads.
 
 | Pod name                | Function                                                          | Comments                                       |
 | ----------------------- | ----------------------------------------------------------------- | ---------------------------------------------- |
@@ -55,7 +55,7 @@ Please note: certain services will need to run scheduled background jobs, usuall
 
 ## Prerequisites
 
-You can either install Travis CI Enterprise (TCIE) via [Replicated KOTS](https://kots.io/) to install it into a Kubernetes cluster on GCE, AWS, or OpenStack.
+You can install Travis CI Enterprise (TCIE) via [Replicated KOTS](https://kots.io/) and install it into a Kubernetes cluster on GCE, AWS, or OpenStack.
 Alternatively, you can install it on a single machine using the [Replicated kURL](https://kurl.sh/) installer and a configuration prepared by TravisCI (`tci-enterprise-kots`).
 
 To set up your Travis CI Enterprise 3.x, you need:
@@ -66,7 +66,7 @@ To set up your Travis CI Enterprise 3.x, you need:
 |  Infrastructure scenario  | Requirement | Comment                                   |
 | ------------------- | ---------------------- | ------------------------------------------------------- |
 | not using default k8s service at cloud provider  | **Two virtual machines**  on your private cloud that meet the [system requirements](#system-requirements)    | One vm for Core Services, one for Worker                         |
-| using k8s service at cloud provider (e.g. Google KE, Amazon EKS ) | One Kubernetes (k8s) Cluster, one virtual machine that meet the [system requirements](#system-requirements) | Tke k8s cluster is meant for Core Services, the vm is meant for Worker Image |
+| using k8s service at cloud provider (e.g., Google KE, Amazon EKS ) | One Kubernetes (k8s) Cluster, one virtual machine that meets the [system requirements](#system-requirements) | Tke k8s cluster is meant for Core Services, the VM is meant for Worker Image |
 
   * If using a GitHub Cloud or GitHub Enterprise Server: Configure the `secret` and `clientid` of a GitHub.com or GitHub Enterprise [OAuth application](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps/) with:
 
@@ -83,7 +83,7 @@ Platform* which hosts Kubernetes cluster with each service in separate pods, and
 *Worker hosts* which run the tests/jobs in isolated containers using LXC
 and Docker.
 
-Each dedicated host or hypervisor (VMWare, OpenStack, or EC2) should run **Ubuntu 18.04** and have at least **16 gigs of RAM and 8 CPUs**. If the same host is to run as Worker host, the minimum requirement would be **16 gigs of RAM and 8 CPUs**.
+Each dedicated host or hypervisor (VMWare, OpenStack, or EC2) should run **Ubuntu 18.04** and have at least **16 gigs of RAM and 8 CPUs**. If the same host is to run as a Worker host, the minimum requirement would be **16 gigs of RAM and 8 CPUs**.
 
 If you're running on EC2, we recommend the **c4.2xlarge** instance type for both **Core Service (aka Platform)** and **Worker**. We also recommend using an image that uses EBS for the root volume and allocating 80 gigs of space.
 
@@ -112,42 +112,42 @@ Ubuntu 18.04 LTS or later as the underlying operating system.
     | Port | Service         | Description                                                                  |
     |:-----|:----------------|:-----------------------------------------------------------------------------|
     | 8800 | Custom TCP Rule | Allow inbound access to the admin dashboard for your Enterprise installation. |
-    | 5672 | Custom TCP Rule | Allow inbound access for RabbitMQ Non-SSL connections, e.g. for client.      |
-    | 4567 | Custom TCP Rule | Allow inbound access for RabbitMQ SSL, e.g. for client.                      |
+    | 5672 | Custom TCP Rule | Allow inbound access for RabbitMQ Non-SSL connections, e.g., for the client.      |
+    | 4567 | Custom TCP Rule | Allow inbound access for RabbitMQ SSL, e.g., for the client.                      |
     | 3333 | HTTPS           | Allow inbound TCIE 3.x User administration Web application over HTTPS access. |
     | 443  | HTTPS           | Allow inbound Web application over HTTPS access.                             |
     | 80   | HTTP            | Allow inbound Web application access.                                        |
     | 22   | SSH             | Allow inbound SSH traffic to access from your local machine.        |
 
-2. Please configure your hostname now. Skip this step if you will access TCIE through an IP address. Accessing TCIE through IP address is also viable option for your setup.
+2. Please configure your hostname now. Skip this step if you will access TCIE through an IP address. Accessing TCIE through an IP address is also a viable option for your setup.
 3. Set up your cluster/machine instances configuration
 
 |  Infrastructure scenario                                          | How to set up TCIE Core Services           | How to Set Up TCIE Worker           |
 | ----------------------------------------------------------------- | ------------------------------------------ | ----------------------------------- |
 | not using default k8s service at cloud provider                   | Set up one vm as k8s host using Replicated kURL (see point 5 below) | [Set up vm to run Worker Image (docker or lxd)](/user/enterprise/setting-up-worker/)                        |
-| using k8s service at cloud provider (e.g. Google KE, Amazon EKS ) | See point 6 below                                                   | [Set up Worker Image](/user/enterprise/setting-up-worker/) at your convernience, depending on infrastructure setup you use |
+| using k8s service at a cloud provider (e.g., Google KE, Amazon EKS ) | See point 6 below                                                   | [Set up Worker Image](/user/enterprise/setting-up-worker/) at your convenience, depending on infrastructure setup you use |
 
-In each case the TCIE Core Services will be deployed as k8s cluster. Cluster must be prepared and started.
+In each case, the TCIE Core Services will be deployed as a k8s cluster. Cluster must be prepared and started.
 
 4. Install Replicated KOTS on *your local machine*. Make sure that you can connect to the Kubernetes cluster containing Travis CI Enterprise Core Services.
      1.  Replicated KOTS [outputs after installation an url including port number](https://docs.replicated.com/vendor/tutorial-installing-without-existing-cluster#create-a-test-server-and-install-the-app-manager) under which Kotsadmin runs. You can also use `kots admin-console -n [your namespace]` to connect
-     2.  Altenratively you can just use `kubectl` to verify access to cluster (sometimes bash shell reload `bash -l` may be required). See example in [Kubernetes documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#verify-kubectl-configuration).
+     2. Alternatively, you can just use `kubectl` to verify access to the cluster (sometimes bash shell reload `bash -l` may be required). See the example in [Kubernetes documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#verify-kubectl-configuration).
 6. TCIE 3.x installed on **single** virtual machine instance
     1. On *your new VM instance* run `kurl.sh` via `curl -sSL https://k8s.kurl.sh/tci-enterprise-kots | sudo bash`
-    2. Get credentials from the new cluster running on *your new VM instance*. Please view, e.g. [kurl documentation](https://kurl.sh/docs/install-with-kurl/connecting-remotely) where kubectl config with credentials is created and can be used afterward.
+    2. Get credentials from the new cluster running on *your new VM instance*. Please view, e.g., [kurl documentation](https://kurl.sh/docs/install-with-kurl/connecting-remotely) where kubectl config with credentials is created and can be used afterward.
     3. Refer to various cluster and installation options in [kURL documentation](https://kurl.sh/docs/install-with-kurl/). Make sure to adjust your setup and configuration according to your needs before progressing with TCIE 3.X installation.
 7. TCIE 3.x installed as Kubernetes cluster in the cloud
-    1. Connect to your cluster and generate the kubectl config file. Then, download the kubectl config file to your *local machine*. The exact way to obtain generated credentials depends on your Kubernetes cluster provider (see GCloud example below).
+    1. Connect to your cluster and generate the kubectl config file. Then, download the kubectl config file to your *local machine*. The exact way to obtain generated credentials depends on your Kubernetes cluster provider (see the GCloud example below).
 8. Run `kubectl kots install tci-enterprise-kots` to install TCIE 3.x. Please note down the administrative password and namespace used during this step.
-9. *In your browser*, navigate to `http://localhost:8800` to complete the setup. The TCIE 3.x admin console will automatically enable the during first installation:
+9. *In your browser*, navigate to `http://localhost:8800` to complete the setup. The TCIE 3.x admin console will automatically enable the during the first installation:
 
    1. Authorize with a password set during the installation process.
    2. Upload your Travis CI Enterprise license.
    3. Connect your Source Control System (GitHub Enterprise Server, GitHub.com, or Bitbucket).
    4. Optionally, configure Email, Metrics, and Caches.
    5. Copy the *RabbitMQ password* for the Worker setup.
 
-> If you have decided to use a self-signed certificate or wish to use Let's Encrypt certificate, there may be additional configuration steps required. Please see our page on [SSL Certificate Management](/user/enterprise/ssl-certificate-management/) for more information.
+> If you have decided to use a self-signed certificate or wish to use the Let's Encrypt certificate, additional configuration steps may be required. For more information, please see our page on [SSL Certificate Management](/user/enterprise/ssl-certificate-management/).
 
 
 ### Example: TCIE 3.x installation for GCE on macOSX
@@ -160,7 +160,7 @@ You'll want to make sure you have the latest version of Python 3. If you're on m
 ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)
 ```
 
-Once brew is up and running, you'll install Python via:
+Once the brew is up and running, you'll install Python via:
 
 ```bash
 brew install python
@@ -186,7 +186,7 @@ Restart your shell session before running `gcloud init`:
 exec -l $SHELL
 ```
 
-Make sure gcloud installed via using the ```version``` arugument:
+Make sure gcloud is installed via using the ```version``` argument:
 
 ```bash
 gcloud --version
@@ -253,7 +253,7 @@ Once employed with the choice, you can type the following:
 travis
 ```
 
-From there, if you have the correct permissions, you can now start Enterprise on local via going to your browser and typing:
+From there, if you have the correct permissions, you can now start Enterprise locally by going to your browser and typing:
 
 ```bash
 http://localhost:8800
@@ -263,13 +263,13 @@ If you get a "permissions" error, please
 * Make sure you have [obtained correct license](/user/enterprise/tcie-3.x-obtain-license/).
 * Contact one of your sysadmins to solve the access rights error.
 
-Once you get the proper permissions, you should have a license file. You'll see where you can drag and drop this on the localhost UI, it will look like this:
+Once you get the proper permissions, you should have a license file. You'll see where you can drag and drop this on the localhost UI; it will look like this:
 
 ![License](/images/tcie-3.x-setting-up-License.png)
 
 #### Configure Travis CI Enterprise
 
-Next, map your platform host, in example case the platform host is:
+Next, map your platform host in example case the platform host is:
 
 ```bash
 montana.travis-ci-enterprise.com
@@ -283,7 +283,7 @@ Next, you'll want to register a new OAuth application with GitHub. In this case,
 
 ![OAuth](/images/tcie-3.x-setting-up-OAuth.png)
 
-Retrieve your ```Client_ID``` and your ```Secret``` from GitHub and enter them. This is how it would look like in the UI with application name set as ```kubernetes```:
+Retrieve your ```Client_ID``` and your ```Secret``` from GitHub and enter them. This is how it would look in the UI with the application name set as ```kubernetes```:
 
 ![Secret](/images/tcie-3.x-setting-up-Secret.png)
 
@@ -293,7 +293,7 @@ Once your ```Client_ID``` and ```Secrets``` are obtained, obtain proper values v
 https://gh-app-setup.travis-ci-enterprise.com
 ```
 
-Be sure that in GitHub app section to use SSL (Secure Socket Layer) via
+Be sure that in the GitHub app section to use SSL (Secure Socket Layer) via
 ```bash
 https://
 ```
@@ -313,7 +313,7 @@ Now that you have your RSA key, you'll see a variable of settings, including ```
 ```bash
 kubectl get pods -n [NAMESPACE]
 ```
-Remember to replace the ```[NAMESPACE]``` with your value from the config form. Now regarding the Load Balancer, below is the default behavior of the Load Balancer:
+Remember to replace the ```[NAMESPACE]``` with your value from the config form. Now, regarding the Load Balancer, below is the default behavior of the Load Balancer:
 
 ![LoadBalancer](/images/tcie-3.x-setting-up-loadbalancer.svg)
 
@@ -324,7 +324,7 @@ To access the config page, try running:
 kubectl kots admin-console --namespace travis
 ```
 
-The above command assumes your namespace is ```travis```, please replace it with yours. Remember registering the Load Balancer is generic. So you run ```kubectl get service nginx``` for example, just make a DNS record to point to the service's external IP. This is true with GCE and AWS.
+The above command assumes your namespace is ```travis```, please replace it with yours. Remember, registering the Load Balancer is generic. So you run ```kubectl get service nginx``` for example, just make a DNS record to point to the service's external IP. This is true with GCE and AWS.
 
 ## Setup the Enterprise Worker virtual machine
 
