Skip to content

Commit 1abdd02

Browse files
michal-at-traviscinrios14Jan Schulte
authored
Enterprise 3.x documentation changes (initial version) (#2872)
* TCIE3.0 support bundle instructions * Questions in eneterprise support updated * Basic TCIE 3.0 overview doc * Adding 3.0 references * Create tcie-3.x-obtain-license.md Basic instructions * Rewording EOL for 2.0 * Create tcie-3.x-migrating-db-from-2.x-to-3.x.md * Create tcie-3.x-setting-up-travis-ci-enterprise.md placeholder * Update enterprise_sidebar.html New TCIE 3.x related links * Update tcie-3.x-migrating-db-from-2.x-to-3.x.md Initial description as summarized by the team * TCIE 3.X images for DB migration * fixes and img links * TCIE 3.X setting up images * Initial content based on @Montana work * Create setting-up-worker.md initial version * Update enterprise_sidebar.html excluded worker, added entry for upgrading 3.0 * Create placholder for upgrading 3.x content * Create tcie-3.x-upgrading.md placeholder * Delete tcie-3.x-upgrading.md--- title: Setting up Travis CI Enterprise layout: en_enterprise redirect_from: - * couple of screenshots 3.0 related * excluding worker set up and ref link * Linking to Worker setup * Ubuntu version update * Update setting-up-worker.md adjusting to be a separate page * Title update * Update tcie-3.x-upgrading.md content added, adjusted to 3.x * small fix * deploy recipe recommendation * fixed cloud addressess of VCS * redirects fixed * updated images (cropped to content) * Add TCIE 3.x, reorganize * First draft with TCIE 3.x * anchor fixes * another anchor fix * Fixed some of the gaps and content during review * Basic 3.x instructions added * Fixed general description and generic steps * Some more fixes * TCIE encryption key backup Appears in multiple docs, excluded to snippet * Update upgrading.md * Update tcie-3.x-upgrading.md * Adding TCIE 3.x contents * fixing some examples and commands * fixed link * updated with 3.x content * formatting fixes * wording * typo fix * Create bionic.md * Precise disbanded in 3.x * Create focal.md * fixed references * Added bionic and focal references * Update snippets.yml * Let's encrypt related updates * Added Let's Encrypt cert remark * fixed sentence * fixed typo and wording * Update snippets.yml * eidting fix Co-authored-by: Jan Schulte <[email protected]> * editing fix Co-authored-by: Jan Schulte <[email protected]> * Update snippets.yml fixed versions in `contact_enterprise_support: ` table removing space clarifying kubernetes cluster access * Fix typo in user/enterprise.md Co-authored-by: Jan Schulte <[email protected]> * grammar fix * remove Trusty reference #1 in user/enterprise/bionic.md Co-authored-by: Jan Schulte <[email protected]> * Adressing review comments in bionic.md * Adressing 3.x review comments in trusty.md * header update * header change * Removing trusty reference in user/enterprise/focal.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/high-availability.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/high-availability.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/high-availability.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/high-availability.md Co-authored-by: Jan Schulte <[email protected]> * Adjusted description of HA mode steps for 3.x * Grammar fixes * typo fix * grammar * Update user/enterprise/tcie-3.x-obtain-license.md Co-authored-by: Jan Schulte <[email protected]> * Modified production license rollout As per internal discussion * Capital E ;-) * Update user/enterprise/platform-tips.md Co-authored-by: Jan Schulte <[email protected]> * reworded Trusty out of support * Removing 14.04 reference since it's not supported * Update user/enterprise/platform-tips.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/platform-tips.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/platform-tips.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/platform-tips.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/platform-tips.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/platform-tips.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/platform-tips.md Co-authored-by: Jan Schulte <[email protected]> * Update user/enterprise/platform-tips.md Co-authored-by: Jan Schulte <[email protected]> * Apply suggestions from code review Co-authored-by: Jan Schulte <[email protected]> * adding links to Redis & RMQ backup docs * Adding deprecation notes * Apply suggestions from code review Co-authored-by: Jan Schulte <[email protected]> * Apply suggestions from code review Co-authored-by: Jan Schulte <[email protected]> * Apply suggestions from code review Co-authored-by: Jan Schulte <[email protected]> * Apply suggestions from code review Co-authored-by: Jan Schulte <[email protected]> * Apply suggestions from code review Co-authored-by: Jan Schulte <[email protected]> * delete unnecessary and unclear sentence * Extending info in tables * Move to proper section * Typo fix * Port number rephrase for pg_dump * deprecation note for Trusty * Applying review remarks * in prerequisites * system requirements * Security Group/firewall rules description * typos fixed * adding deprecation markers * fixes * header level fix * formatting fix * small suggestion how to re-deploy nginx * Adressing review comment * Adressing review comment * Applying review comments * Applying review comment * Applying review comments * Applying review remarks Co-authored-by: nrios14 <[email protected]> Co-authored-by: Jan Schulte <[email protected]>
1 parent d3e8afc commit 1abdd02

37 files changed

+1115
-125
lines changed

_data/snippets.yml

+37-19
Original file line numberDiff line numberDiff line change
@@ -18,38 +18,38 @@ before_and_after: |
1818
```
1919
ghlimit: |
2020
> If your API or cron triggered builds run on the *same commit
21-
> or branch* over and over again, you will notice GitHub have a limit of
21+
> or branch* over and over again, you will notice GitHub has a limit of
2222
> [1000 status updates](https://developer.github.com/v3/repos/statuses/#create-a-status)
23-
> *per commit*, which causes the Travis CI build status displayed on GitHub
24-
> to be incorrect.
23+
> *per commit*, which causes the Travis CI build status to display incorrectly
24+
> on GitHub.
2525
> Avoid this problem by specifying a regularly updated branch for your automated builds.
2626
all_note: |
27-
> Language versions and other build-environment specific
28-
> information are in our reference pages:
27+
> For Language versions and other build-environment specific
28+
> information visit our reference pages:
2929
> * [Precise](/user/reference/precise/)
3030
> * [Trusty](/user/reference/trusty/)
3131
> * [Xenial](/user/reference/xenial/)
3232
> * [Bionic](/user/reference/bionic/)
3333
> * [macOS](/user/reference/osx/)
3434
> * [Windows](/user/reference/windows/)
3535
unix_note: |
36-
> Language versions and other build-environment specific
37-
> information are in our reference pages:
36+
> For Language versions and other build-environment specific
37+
> information visit our reference pages:
3838
> * [Precise](/user/reference/precise/)
3939
> * [Trusty](/user/reference/trusty/)
4040
> * [Xenial](/user/reference/xenial/)
4141
> * [Bionic](/user/reference/bionic/)
4242
> * [macOS](/user/reference/osx/)
4343
linux_note: |
44-
> Language versions and other build-environment specific
45-
> information are in our reference pages:
44+
> For Language versions and other build-environment specific
45+
> information visit our reference pages:
4646
> * [Precise](/user/reference/precise/)
4747
> * [Trusty](/user/reference/trusty/)
4848
> * [Xenial](/user/reference/xenial/)
4949
> * [Bionic](/user/reference/bionic/)
5050
linux_windows_note: |
51-
> Language versions and other build-environment specific
52-
> information are in our reference pages:
51+
> For Language versions and other build-environment specific
52+
> information visit our reference pages:
5353
> * [Precise](/user/reference/precise/)
5454
> * [Trusty](/user/reference/trusty/)
5555
> * [Xenial](/user/reference/xenial/)
@@ -79,20 +79,38 @@ contact_enterprise_support: |
7979
8080
- Description of the problem - what are you observing?
8181
- Which steps did you try already?
82-
- A support bundle (You can get it from `https://<your-travis-ci-enterprise-domain>:8800/support`)
82+
- A support bundle (see table below on how to obtain it)
8383
- Log files from all workers (They can be found at `/var/log/upstart/travis-worker.log` - please include as many as you can retrieve).
8484
- If a build failed or errored, a text file of the build log
85-
85+
86+
| TCI Enterprise version | Support bundle |
87+
| :--- | :--- |
88+
| **3.x** | Run `kubectl kots admin-console -n [namespace]` to access admin console on `http://localhost:8800`<br />Support bundle generation instruction is available in ‘troubleshoot’ menu or directly at: `http://localhost:8800/app/tci-enterprise-kots/troubleshoot`<br /><br />A command for generating support bundle will appear after selecting: <br />`If you'd prefer, [click here]() to get a command to manually generate a support bundle.` |
89+
| **2.x+** | You can get it from `https://<your-travis-ci-enterprise-domain>:8800/support` |
90+
8691
Have you made any customizations to your setup? While we may be able to see some
8792
information (such as hostname, IaaS provider, and license expiration), there
88-
are many other things we can't see which could lead to something not working.
89-
Therefore , we'd like to ask you to also answer the questions below in your
93+
are many other things we cannot see which could lead to something not working.
94+
Therefore, we would like to ask you to also answer the questions below in your
9095
support request (if applicable):
9196
92-
- How many machines are you using?
97+
- How many machines are you using / what is your Kubernetes cluster setup?
9398
- Do you use configuration management tools (Chef, Puppet)?
9499
- Which other services do interface with Travis CI Enterprise?
95-
- Do you use Travis CI Enterprise together with github.com or GitHub Enterprise?
96-
- If you're using GitHub Enterprise, which version of it?
100+
- Which Version Control system (VCS) do you use together with Travis CI Enterprise (e.g. github.com, GitHub Enterprise, or BitBucket Cloud)?
101+
- If you are using GitHub Enterprise, which version of it?
97102
98-
We're looking forward to helping!
103+
We are looking forward to helping!
104+
enterprise_2_encryption_key_backup: |
105+
To make a backup of encryption keys in TCIE 2.x, please follow these steps:
106+
107+
1. Open an SSH connection to the platform machine.
108+
2. Open a bash session with `root` privileges on the Travis CI container by running `travis bash`.
109+
3. Run the following command to obtain the key: `grep -A1 encryption: /usr/local/travis/etc/travis/config/travis.yml`.
110+
4. Create a backup of the value returned by the previous command by either writing it down on a piece of paper or storing it on a different computer.
111+
enterprise_3_encryption_key_backup: |
112+
To make a backup of encryption keys in TCIE 3.x, please follow these steps:
113+
114+
1. Make sure you have appropriate access to the kubernetes cluster: you need credentials for `kubectl` and connection to [travis-api-pod]
115+
2. Run `kubectl exec -it [travis-api-pod] cat /app/config/travis.yml |grep -A 2 encryption` (using Travis API pod is recommended).
116+
3. Create a backup of the value returned by that command by either writing it down on a piece of paper or storing it on a different computer.

_includes/enterprise_sidebar.html

+17-7
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,20 @@
3131
<h3>Travis CI Enterprise</h3>
3232
<ul>
3333
<li><a href="/user/enterprise/">About Travis CI Enterprise</a></li>
34-
<li><a href="/user/enterprise/setting-up-travis-ci-enterprise/">Setting up Travis CI Enterprise</a> </li>
35-
<li><a href="/user/enterprise/upgrading/">Upgrading</a></li>
34+
<li><a href="/user/enterprise/setting-up-travis-ci-enterprise/">Setting up Travis CI Enterprise 2.x</a> </li>
35+
<li><a href="/user/enterprise/tcie-3.x-setting-up-travis-ci-enterprise/">Setting up Travis CI Enterprise 3.x</a> </li>
36+
<li><a href="/user/enterprise/setting-up-worker/">Setting up Worker</a> </li>
37+
<li><a href="/user/enterprise/upgrading/">Upgrading Travis CI Enterprise 2.x</a></li>
38+
<li><a href="/user/enterprise/tcie-3.x-upgrading/">Upgrading Travis CI Enterprise 3.x</a></li>
3639
</ul>
3740

3841
<h3>Environment reference</h3>
3942
<ul>
40-
<li><a href="/user/enterprise/xenial">Xenial Build Environment</a></li>
41-
42-
<li><a href="/user/enterprise/trusty/">Trusty Build Environment</a></li>
43-
44-
<li><a href="/user/enterprise/precise/">Precise (Legacy) Build Environment</a></li>
43+
<li><a href="/user/enterprise/focal">Focal Build Environment</a></li>
44+
<li><a href="/user/enterprise/bionic">Bionic Build Environment</a></li>
45+
<li><a href="/user/enterprise/xenial/">Xenial Build Environment</a></li>
46+
<li><a href="/user/enterprise/trusty/">Trusty Build Environment (Deprecated)</a></li>
47+
<li><a href="/user/enterprise/precise/">Precise Build Environment (Deprecated)</a></li>
4548
</ul>
4649

4750
<h3>Customizing Travis CI Enterprise</h3>
@@ -61,6 +64,13 @@ <h3>Enterprise Operations Manual</h3>
6164
<li><a href="/user/enterprise/user-management/">User Management</a></li>
6265
</ul>
6366

67+
<h3>Migrating from Enterprise 2.x to 3.x</h3>
68+
<ul>
69+
<li><a href="/user/enterprise/tcie-3.x-overview/">Enterprise 3.x Overview</a></li>
70+
<li><a href="/user/enterprise/tcie-3.x-obtain-license/">Obtaining 3.x License</a></li>
71+
<li><a href="/user/enterprise/tcie-3.x-migrating-db-from-2.x-to-3.x/">Migrating Database from 2.2.6+ to 3.x</a></li>
72+
</ul>
73+
6474
<h3>Travis CI Docs</h3>
6575
<ul>
6676
<li><a href="/">Travis CI Docs</a></li>

images/tcie-3.x-check-updates.png

25.2 KB
Loading

images/tcie-3.x-default-build-env.png

15.5 KB
Loading
18 KB
Loading
15 KB
Loading

images/tcie-3.x-list-of-versions.png

40.6 KB
Loading

images/tcie-3.x-self-hosted-db.png

55.2 KB
Loading
117 KB
Loading

images/tcie-3.x-setting-up-Header.png

64.8 KB
Loading

images/tcie-3.x-setting-up-JSON.png

246 KB
Loading
81.4 KB
Loading

images/tcie-3.x-setting-up-OAuth.png

319 KB
Loading

images/tcie-3.x-setting-up-Port.png

493 KB
Loading

images/tcie-3.x-setting-up-RSA.png

475 KB
Loading

images/tcie-3.x-setting-up-Secret.png

302 KB
Loading

0 commit comments

Comments
 (0)