Enterprise 3.x documentation changes (initial version) (travis-ci#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]>
Rachelmorrell · Sep 1, 2020 · 1abdd02 · 1abdd02
1 parent d3e8afc
commit 1abdd02
Show file tree

Hide file tree

Showing 37 changed files with 1,115 additions and 125 deletions.
diff --git a/_data/snippets.yml b/_data/snippets.yml
@@ -18,38 +18,38 @@ before_and_after: |
   ```
 ghlimit: |
   > If your API or cron triggered builds run on the *same commit
-  > or branch* over and over again, you will notice GitHub have a limit of
+  > or branch* over and over again, you will notice GitHub has a limit of
   > [1000 status updates](https://developer.github.com/v3/repos/statuses/#create-a-status)
-  > *per commit*, which causes the Travis CI build status displayed on GitHub
-  > to be incorrect.
+  > *per commit*, which causes the Travis CI build status to display incorrectly 
+  > on GitHub.
   > Avoid this problem by specifying a regularly updated branch for your automated builds.
 all_note: |
-  > Language versions and other build-environment specific
-  > information are in our reference pages:
+  > For Language versions and other build-environment specific
+  > information visit our reference pages:
   >  * [Precise](/user/reference/precise/)
   >  * [Trusty](/user/reference/trusty/)
   >  * [Xenial](/user/reference/xenial/)
   >  * [Bionic](/user/reference/bionic/)
   >  * [macOS](/user/reference/osx/)
   >  * [Windows](/user/reference/windows/)
 unix_note: |
-  > Language versions and other build-environment specific
-  > information are in our reference pages:
+  > For Language versions and other build-environment specific
+  > information visit our reference pages:
   >  * [Precise](/user/reference/precise/)
   >  * [Trusty](/user/reference/trusty/)
   >  * [Xenial](/user/reference/xenial/)
   >  * [Bionic](/user/reference/bionic/)
   >  * [macOS](/user/reference/osx/)
 linux_note: |
-  > Language versions and other build-environment specific
-  > information are in our reference pages:
+  > For Language versions and other build-environment specific
+  > information visit our reference pages:
   >  * [Precise](/user/reference/precise/)
   >  * [Trusty](/user/reference/trusty/)
   >  * [Xenial](/user/reference/xenial/)
   >  * [Bionic](/user/reference/bionic/)
 linux_windows_note: |
-  > Language versions and other build-environment specific
-  > information are in our reference pages:
+  > For Language versions and other build-environment specific
+  > information visit our reference pages:
   >  * [Precise](/user/reference/precise/)
   >  * [Trusty](/user/reference/trusty/)
   >  * [Xenial](/user/reference/xenial/)
@@ -79,20 +79,38 @@ contact_enterprise_support: |
    
   - Description of the problem - what are you observing?
   - Which steps did you try already?
-  - A support bundle (You can get it from `https://<your-travis-ci-enterprise-domain>:8800/support`)
+  - A support bundle (see table below on how to obtain it)
   - Log files from all workers (They can be found at `/var/log/upstart/travis-worker.log` - please include as many as you can retrieve).
   - If a build failed or errored, a text file of the build log
-  
+
+  |   TCI Enterprise version | Support bundle |
+  | :---                     | :---           | 
+  | **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.` | 
+  | **2.x+**                 | You can get it from `https://<your-travis-ci-enterprise-domain>:8800/support` |  
+
   Have you made any customizations to your setup? While we may be able to see some 
   information (such as hostname, IaaS provider, and license expiration), there 
-  are many other things we can't see which could lead to something not working. 
-  Therefore , we'd like to ask you to also answer the questions below in your 
+  are many other things we cannot see which could lead to something not working. 
+  Therefore, we would like to ask you to also answer the questions below in your 
   support request (if applicable):
   
-  - How many machines are you using?
+  - How many machines are you using / what is your Kubernetes cluster setup?
   - Do you use configuration management tools (Chef, Puppet)?
   - Which other services do interface with Travis CI Enterprise?
-  - Do you use Travis CI Enterprise together with github.com or GitHub Enterprise?
-  - If you're using GitHub Enterprise, which version of it?
+  - Which Version Control system (VCS) do you use together with Travis CI Enterprise (e.g. github.com, GitHub Enterprise, or BitBucket Cloud)?
+  - If you are using GitHub Enterprise, which version of it?
   
-  We're looking forward to helping!
+  We are looking forward to helping!
+enterprise_2_encryption_key_backup: |
+  To make a backup of encryption keys in TCIE 2.x, please follow these steps:
+
+  1. Open an SSH connection to the platform machine.
+  2. Open a bash session with `root` privileges on the Travis CI container by running `travis bash`.
+  3. Run the following command to obtain the key: `grep -A1 encryption: /usr/local/travis/etc/travis/config/travis.yml`.
+  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.
+enterprise_3_encryption_key_backup: |
+  To make a backup of encryption keys in TCIE 3.x, please follow these steps:
+
+  1. Make sure you have appropriate access to the kubernetes cluster: you need credentials for `kubectl` and connection to [travis-api-pod] 
+  2. Run `kubectl exec -it [travis-api-pod] cat /app/config/travis.yml |grep -A 2 encryption` (using Travis API pod is recommended). 
+  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.
diff --git a/_includes/enterprise_sidebar.html b/_includes/enterprise_sidebar.html
@@ -31,17 +31,20 @@
       <h3>Travis CI Enterprise</h3>
       <ul>
         <li><a href="/user/enterprise/">About Travis CI Enterprise</a></li>
-        <li><a href="/user/enterprise/setting-up-travis-ci-enterprise/">Setting up Travis CI Enterprise</a> </li>
-        <li><a href="/user/enterprise/upgrading/">Upgrading</a></li>
+        <li><a href="/user/enterprise/setting-up-travis-ci-enterprise/">Setting up Travis CI Enterprise 2.x</a> </li>
+        <li><a href="/user/enterprise/tcie-3.x-setting-up-travis-ci-enterprise/">Setting up Travis CI Enterprise 3.x</a> </li>
+        <li><a href="/user/enterprise/setting-up-worker/">Setting up Worker</a> </li>
+        <li><a href="/user/enterprise/upgrading/">Upgrading Travis CI Enterprise 2.x</a></li>
+        <li><a href="/user/enterprise/tcie-3.x-upgrading/">Upgrading Travis CI Enterprise 3.x</a></li>
       </ul>
 
       <h3>Environment reference</h3>
       <ul>
-        <li><a href="/user/enterprise/xenial">Xenial Build Environment</a></li>
-
-        <li><a href="/user/enterprise/trusty/">Trusty Build Environment</a></li>
-
-        <li><a href="/user/enterprise/precise/">Precise (Legacy) Build Environment</a></li>
+        <li><a href="/user/enterprise/focal">Focal Build Environment</a></li>
+        <li><a href="/user/enterprise/bionic">Bionic Build Environment</a></li>
+        <li><a href="/user/enterprise/xenial/">Xenial Build Environment</a></li>
+        <li><a href="/user/enterprise/trusty/">Trusty Build Environment (Deprecated)</a></li>
+        <li><a href="/user/enterprise/precise/">Precise Build Environment (Deprecated)</a></li>
       </ul>
 
       <h3>Customizing Travis CI Enterprise</h3>
@@ -61,6 +64,13 @@ <h3>Enterprise Operations Manual</h3>
         <li><a href="/user/enterprise/user-management/">User Management</a></li>
       </ul>
 
+      <h3>Migrating from Enterprise 2.x to 3.x</h3>
+      <ul>
+        <li><a href="/user/enterprise/tcie-3.x-overview/">Enterprise 3.x Overview</a></li>
+        <li><a href="/user/enterprise/tcie-3.x-obtain-license/">Obtaining 3.x License</a></li>
+        <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>
+      </ul>
+
       <h3>Travis CI Docs</h3>
       <ul>
         <li><a href="/">Travis CI Docs</a></li>

diff --git a/images/tcie-3.x-check-updates.png b/images/tcie-3.x-check-updates.png
diff --git a/images/tcie-3.x-default-build-env.png b/images/tcie-3.x-default-build-env.png
diff --git a/images/tcie-3.x-input-for-db-dumps.png b/images/tcie-3.x-input-for-db-dumps.png
diff --git a/images/tcie-3.x-input-for-encryption-key.png b/images/tcie-3.x-input-for-encryption-key.png
diff --git a/images/tcie-3.x-list-of-versions.png b/images/tcie-3.x-list-of-versions.png
diff --git a/images/tcie-3.x-self-hosted-db.png b/images/tcie-3.x-self-hosted-db.png
diff --git a/images/tcie-3.x-setting-up-Details.png b/images/tcie-3.x-setting-up-Details.png
diff --git a/images/tcie-3.x-setting-up-Header.png b/images/tcie-3.x-setting-up-Header.png
diff --git a/images/tcie-3.x-setting-up-JSON.png b/images/tcie-3.x-setting-up-JSON.png
diff --git a/images/tcie-3.x-setting-up-License.png b/images/tcie-3.x-setting-up-License.png
diff --git a/images/tcie-3.x-setting-up-OAuth.png b/images/tcie-3.x-setting-up-OAuth.png
diff --git a/images/tcie-3.x-setting-up-Port.png b/images/tcie-3.x-setting-up-Port.png
diff --git a/images/tcie-3.x-setting-up-RSA.png b/images/tcie-3.x-setting-up-RSA.png
diff --git a/images/tcie-3.x-setting-up-Secret.png b/images/tcie-3.x-setting-up-Secret.png