Skip to content

Commit

Permalink
Add Runbook Installing TE (#23)
Browse files Browse the repository at this point in the history
Co-authored-by: cbruno10 <cody@turbot.com>
  • Loading branch information
RahulSrivastav14 and cbruno10 authored Jul 31, 2024
1 parent 61bfc85 commit 1f6962d
Show file tree
Hide file tree
Showing 10 changed files with 38 additions and 44 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
82 changes: 38 additions & 44 deletions docs/runbooks/enterprise-install/installing-te/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,91 +3,85 @@ title: Installing TE
sidebar_label: Installing TE
---

# Turbot Guardrails Enterprise (TE) Installation
# Install Turbot Guardrails Enterprise (TE)

## Overview
In this runbook, you will:
- Use AWS Service Catalogue to install Turbot Guardrails Enterprise (TE)
- Learn how to monitor installations

**Turbot Guardrails Enterprise (TE)** provides automated configuration and management of
Turbot infrastructure to be used when running the Turbot software application.
For example, TE provides the setup of load balancers, SQS queues, ECS, etc.
while Turbot provides the software to run in the container.
**Turbot Guardrails Enterprise (TE)** provides automated configuration and management of Turbot infrastructure to be used when running the Turbot software application. For example, TE provides the setup of load balancers, SQS queues, ECS, etc., while Turbot provides the software to run in the container.

TE deploys a new version of the Turbot software -- Every Turbot release requires
a new TE version.
TE deploys a new version of the Turbot software -- Every Turbot release requires a new TE version.

## Introduction
## Prerequisites

**Purpose**: This runbook guides administrators through the process of installing TE.

**Prerequisites**:
- Access to the Guardrails master account.
- Administrator privileges.
- Familiarity with AWS Console, Service Catalog, and CloudFormation services.

## Procedure

### Step 1: Access AWS Console
## Step 1: Access AWS Console

Open the AWS Console and navigate to the Service Catalog service in the region to deploy TE.

![AWS Console Home Page](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-console.png)
![AWS Console Home Page](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-console-1.png)

### Step 2: Navigate to Products & Identify the TE Product
## Step 2: Find TE Product

Select the hamburger menu in the top left and click on `Products`.
Select the hamburger menu in the top left and choose **Products**.

Select `Turbot Guardrails Enterprise` from the products list and click `Launch Product`.
Select **Turbot Guardrails Enterprise** from the products list.

![Launch Product ](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-launch-product.png)
![Product Selection](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-product-selection.png)

Select **Launch Product**.

### Step 3: Launch & Name the TE Product
![Launch Product](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-launch-product.png)

## Step 3: Name TE Product

Select the desired version and name the provisioned product with the version number prefixed with `te`.

![Provisioned Product Naming](/images/docs/guardrails/runbooks/enterprise-install/installing-te/provisioned_product_naming.png)
![Provisioned Product Naming](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-product-naming.png)

### Step 4: Verify Parameters
## Step 4: Verify Parameters

Ensure all parameters are correct. Generally, these can be left as default.

<!-- ![Parameters Verification Page](screenshot_parameters_verification.png) -->
![Parameters Verification](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-parameters-verify.png)

### Step 5: Launch Product
## Step 5: Launch Product

Verify the parameters again and select `Launch product`.
Verify the parameters again and select **Launch product**.

99.9% of All TE installations do not need to change any parameters. The parameters for the TE stack are designed by default to pick up their values from the TEF configuration, with no options necessary to change on installation.
99.9% of all TE installations do not need to change any parameters. The parameters for the TE stack are designed by default to pick up their values from the TEF configuration, with no options necessary to change on installation.

### Step 6: Launch Product
![Launch Product](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-te-launch-action.png)

Verify the parameters again and select Launch product.
## Step 6: Review

![Launch Product](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-launch-action.png)
You have successfully installed the TE Service Catalog product. Now you can monitor the product for any issues post-installation and document any anomalies.

- [ ] The installed TE version should appear in Provisioned products with the status **Under change** and a new CloudFormation stack should be created with the status CREATING.

### Step 7: Monitor Installation
![Verify Status](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-install-verification.png)

The installed TE version should appear in Provisioned products with the status Under change and a new CloudFormation stack should be created with the status CREATING.
- [ ] The TE provisioned product status should change to **Available** and the CloudFormation stack status should be **CREATE_COMPLETE** to ensure the installation completed successfully.

## Validation
![Installation Complete verification](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-installation-complete.png)

The TE provisioned product status should change to `Available` and the CloudFormation stack status should be `CREATE_COMPLETE` to ensure the installation completed successfully.
## Next Steps

![Verification Page](/images/docs/guardrails/runbooks/enterprise-install/installing-te/aws-service-catalog-verification-page.png)
Please see the following resources to learn more about Turbot Guardrails Enterprise:

- Learn more about [TE architecture](https://turbot.com/guardrails/docs/enterprise/architecture).
- Learn about [updating TE stacks](https://turbot.com/guardrails/docs/enterprise/updating-stacks).

## Troubleshooting

**Common Issues**:

1. **Installation fails or takes too long**:
- Solution: Check the CloudFormation events tab for errors or issues.
2. **Parameters need adjustment**:
- Solution: Review the parameters and consult the product documentation for correct values.
### Installation Fails or Takes Too Long

## Conclusion
Check the CloudFormation stack events tab for errors. If there are any errors, create a support ticket and include a screenshot of the errors.

**Summary**: You have successfully installed the TE Service Catalog product.
### Parameters Need Adjustment

**Next Steps**: Monitor the product for any issues post-installation and document any anomalies.
Review the parameters and consult the product documentation for correct values.

0 comments on commit 1f6962d

Please sign in to comment.