Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
rajlearner17 committed Jul 17, 2024
1 parent 50d48db commit 68a0dff
Show file tree
Hide file tree
Showing 25 changed files with 31 additions and 430 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/runbooks/enterprise-install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ sidebar_label: Enterprise Install

## Overview

TODO
Do we need to follow and bring all same pages like in existing https://turbot.com/guardrails/docs/enterprise/installation ?
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,82 +1,81 @@
# Runbook: Installing TE
---
title: Installing TE
sidebar_label: Installing TE
---

# Turbot Guardrails Enterprise (TE) Installation

## Overview

**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.

## Introduction

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

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

---

## Procedure

### 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](screenshot_aws_console.png) -->

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

### Step 2: Navigate to Products

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

<!-- ![Navigation Menu](screenshot_navigation_menu.png) -->

---

### Step 3: Identify the TE Product

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

<!-- ![Service Catalog Products List](screenshot_service_catalog_products_list.png) -->

---

### Step 4: Name the TE Product

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

<!-- ![Provisioned Product Naming](screenshot_provisioned_product_naming.png) -->

---

### Step 5: Verify Parameters

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

<!-- ![Parameters Verification Page](screenshot_parameters_verification.png) -->

---

### Step 6: Launch Product

Verify the parameters again and select `Launch product`.

<!-- ![Update Confirmation Page](screenshot_update_confirmation.png) -->

---

### Step 7: Monitor Installation

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`.

<!-- ![Verification Page](screenshot_verification_page.png) -->

---

## Validation

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

<!-- ![CloudFormation Stack Update Status](screenshot_stack_update_status.png) -->

---

## Troubleshooting

**Common Issues**:
Expand All @@ -85,8 +84,6 @@ The TE provisioned product status should change to `Available` and the CloudForm
2. **Parameters need adjustment**:
- Solution: Review the parameters and consult the product documentation for correct values.

---

## Conclusion

**Summary**: You have successfully installed the TE Service Catalog product.
Expand Down
186 changes: 0 additions & 186 deletions docs/runbooks/enterprise-install/mod_installation.md

This file was deleted.

Loading

0 comments on commit 68a0dff

Please sign in to comment.