fix link to install TEF runbook (#179)

* fix link to install TEF runbook * tweak language * Update the image paths to render images in install-tef/install-tef-and-new-vpc/ --------- Co-authored-by: Raj <[email protected]>
turbot · Oct 23, 2024 · 1a69474 · 1a69474
1 parent f7f4d5d
commit 1a69474
Show file tree

Hide file tree

Showing 34 changed files with 26 additions and 26 deletions.
diff --git a/docs/guides/hosting-guardrails/installation/install-tef/index.md b/docs/guides/hosting-guardrails/installation/install-tef/index.md
@@ -9,5 +9,5 @@ This section provides detailed, step-by-step instructions for installing the  Tu
 
 | Guide                                            | Description
 | ------------------------------------------------ | -------------------------------------------------------------------------------- |
-| [Install TEF and New VPC](guides/hosting-guardrails/installation/install-tef/with-guardrail-vpc) | Guide for installing TEF using Guardrails-managed VPC. |
-| [Install TEF into Existing VPC](guides/hosting-guardrails/installation/install-tef/install-tef-into-existing-vpc) | Guide for installing TEF using existing VPC. |
+| [Install TEF into a new VPC](guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc) | Guide for installing TEF using Guardrails-managed VPC. |
+| [Install TEF into existing VPC](guides/hosting-guardrails/installation/install-tef/install-tef-into-existing-vpc) | Guide for installing TEF using existing VPC. |
diff --git a/...ting-guardrails/installation/install-tef/install-tef-into-existing-vpc/index.md b/...ting-guardrails/installation/install-tef/install-tef-into-existing-vpc/index.md
@@ -1,5 +1,5 @@
 ---
-title: With Existing VPC
+title: Install TEF into Existing VPC
 sidebar_label: Install TEF into Existing VPC
 ---
 

diff --git a/...d-new-vpc/aws-service-catalog-console.png → ...o-new-vpc/aws-service-catalog-console.png b/...d-new-vpc/aws-service-catalog-console.png → ...o-new-vpc/aws-service-catalog-console.png
diff --git a/...edit-termination-protection-activated.png → ...edit-termination-protection-activated.png b/...edit-termination-protection-activated.png → ...edit-termination-protection-activated.png
diff --git a/...cfn-stack-edit-termination-protection.png → ...cfn-stack-edit-termination-protection.png b/...cfn-stack-edit-termination-protection.png → ...cfn-stack-edit-termination-protection.png
diff --git a/...install-tef-and-new-vpc/cfn-stack-tef.png → ...nstall-tef-into-new-vpc/cfn-stack-tef.png b/...install-tef-and-new-vpc/cfn-stack-tef.png → ...nstall-tef-into-new-vpc/cfn-stack-tef.png
diff --git a/...f-and-new-vpc/cfn-tef-create-complete.png → ...-into-new-vpc/cfn-tef-create-complete.png b/...f-and-new-vpc/cfn-tef-create-complete.png → ...-into-new-vpc/cfn-tef-create-complete.png
diff --git a/...tall-tef/install-tef-and-new-vpc/index.md → ...all-tef/install-tef-into-new-vpc/index.md b/...tall-tef/install-tef-and-new-vpc/index.md → ...all-tef/install-tef-into-new-vpc/index.md
@@ -1,9 +1,9 @@
 ---
-title: With Guardrail VPC
-sidebar_label: Install TEF and New VPC
+title: Install TEF into New VPC
+sidebar_label: Install TEF into New VPC
 ---
 
-# Install TEF and New VPC
+# Install TEF into New VPC
 
 In this guide, you will:
 - Use AWS Service Catalog to install Turbot Guardrails Enterprise Foundation (TEF). This guide demonstrates the installation process using the default `Network Option A - Created in this Stack`, where Turbot Guardrails manages the creation of the VPC and related networking resources.
@@ -25,37 +25,37 @@ The TEF CloudFormation stack creates and manages the networking and compute comp
 
 Open the AWS Console and navigate to the Service Catalog service in the region where you wish to install TEF.
 
-![AWS Console Home Page](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/aws-service-catalog-console.png)
+![AWS Console Home Page](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/aws-service-catalog-console.png)
 
 ## Step 2: Navigate to Products
 
 Select the **Products** section from the left navigation menu.
 
-![Product Selection](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-products.png)
+![Product Selection](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-products.png)
 
 ## Step 3: Launch Product
 
 Select **Turbot Guardrails Enterprise Foundation** from the products list, select **Launch Product**.
 
-![Launch Product](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-launch-product-tef.png)
+![Launch Product](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-launch-product-tef.png)
 
 ## Step 4: Name Provisioned Product
 
 Select a Name for the provisioned project. Typically, this will be `tef`.
 
-![Name Provisioned Product](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-name-provisioned-product.png)
+![Name Provisioned Product](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-name-provisioned-product.png)
 
 ## Step 5: Find Version
 
 Sort the Product versions section by **Created time** (descending) to see the latest available version.
 
-![Find TEF Version](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-find-tef-product-versions.png)
+![Find TEF Version](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-find-tef-product-versions.png)
 
 ## Step 6: Select Version
 
 Select the desired TEF version under **Product Versions**. Usually, you will want the latest version.
 
-![Select TEF Version](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-select-tef-version.png)
+![Select TEF Version](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-select-tef-version.png)
 
 ## Step 7: Configure Installation
 
@@ -75,7 +75,7 @@ The required parameters for this installation option are as below
 > [!IMPORTANT]
 > **Manager DNS records in Route 53** It is highly recommended that you allow Turbot to manage DNS records in Route53.  If you choose not to do so, you must manually update DNS records every time you install a new version in your workspaces.
 
-![Installation Parameter](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-tef-parameter-installation.png)
+![Installation Parameter](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-parameter-installation.png)
 
 > [!NOTE]
 > Each region must be given a different **Region Code** identifier, allowing the stacks to be automatically coordinated for peering etc. Select "alpha" as the **Region Code** for this first region.
@@ -86,7 +86,7 @@ Proceed to `Logging` section leaving the `Turbot Guardrails License Key` field b
 
 Select the desired values for `Turbot Handler Log Retention Days`, `Audit Trail Log Retention Days`, `Turbot Guardrails Process Log Objects Retention Days`, and `Turbot Guardrails Mod Installation Data Retention Days`, or leave them all at their default values.
 
-<!-- ![Logging](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-tef-parameter-logging.png) -->
+<!-- ![Logging](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-parameter-logging.png) -->
 
 ## Step 9: Configure Network with New VPC - Created in this Stack
 
@@ -97,11 +97,11 @@ The Turbot Guardrails Enterprise Foundation setup can create the VPC to host Tur
 > Any subnet with an empty CIDR will NOT be created. For each subnet type, there are 3 possible subnets that corresponds to 3 different availability zones. If you wish to create a 2 AZ network, only enter CIDRs for subnets #1 and #2.
 > Enter the desired **NAT Gateway High Availability** configuration.  For a production deployment, you should choose **Multi-AZ**.
 
-![Network Created in Stack](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-tef-parameter-network-create-in-stack.png)
+![Network Created in Stack](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-parameter-network-create-in-stack.png)
 
 Keep rest of the parameters for `Load Balancer`, `Proxy`, `Security Groups` at their default values and proceed to `Advanced - ECS EC2 configuration` section.
 
-![Default Parameter Sections](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-tef-default-parameter-sections.png)
+![Default Parameter Sections](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-default-parameter-sections.png)
 
 ## Step 10: Advanced - ECS EC2 Configuration
 
@@ -110,7 +110,7 @@ By default, support is provided for the `Instance Type for EC2 ECS host` and `AM
 > [!NOTE]
 > You can choose between `Standard Instances` (powered by Intel/AMD processors with the AMD64 architecture) or `Graviton Instances` (powered by AWS Graviton processors using the ARM64 architecture).
 
-![AMI and ECS Type for EC2 ECS host](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-tef-ecs-host-parameter.png)
+![AMI and ECS Type for EC2 ECS host](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-ecs-host-parameter.png)
 
 > [!CAUTION]
 > For `Graviton Instances`, ensure that your TE version is at least `5.47.x`.
@@ -122,15 +122,15 @@ You can modify the rest of the parameters as needed, or leave them at their defa
 
 Select **Launch product**.
 
-![Launch Product](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-tef-launch-product-action.png)
+![Launch Product](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-launch-product-action.png)
 
 ## Step 12: Monitor Installation
 
 You have initiated the installation of the new TEF version. This triggers an update of several nested CloudFormation stacks.
 
 The TEF provisioned product should be in the **Under Change** status.
 
-![Under Change Status](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-tef-under-change.png)
+![Under Change Status](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-under-change.png)
 
 ## Step 13: Enable Termination Protection
 
@@ -139,29 +139,29 @@ The TEF provisioned product should be in the **Under Change** status.
 
 Select the TEF Provisioned Product, select **Outputs** tab, and use the `CloudFormationStackARN` **Value** link to navigate to the respective CloudFormation stack.
 
-![Navigate to CloudFormation Stack](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-install-tef-navigate-to-cfn.png)
+![Navigate to CloudFormation Stack](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-install-tef-navigate-to-cfn.png)
 
 Select the TEF stack. The description of the correct stack should say **Turbot Guardrails Enterprise Foundation &lt;version&gt;**.
 
-![TEF CFN Stack](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/cfn-stack-tef.png)
+![TEF CFN Stack](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/cfn-stack-tef.png)
 
 Select **Edit termination protection** from **Stack actions** dropdown menu.
 
-![Edit Termination Protection](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/cfn-stack-edit-termination-protection.png)
+![Edit Termination Protection](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/cfn-stack-edit-termination-protection.png)
 
 Choose `Termination protection` as **Activated** and select **Save**.
 
-![Termination Protection Activated](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/cfn-stack-edit-termination-protection-activated.png)
+![Termination Protection Activated](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/cfn-stack-edit-termination-protection-activated.png)
 
 ## Step 14: Review
 
 - [ ] The TEF CloudFormation stack status should change to `CREATE_COMPLETE` indicating the installation completed successfully.
 
-![CFN Create Complete](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/cfn-tef-create-complete.png)
+![CFN Create Complete](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/cfn-tef-create-complete.png)
 
 - [ ] The TE `Provisioned product` status should change to `Succeeded`.
 
-![Installation Complete Verification](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc/service-catalog-tef-succeeded.png)
+![Installation Complete Verification](/images/docs/guardrails/guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc/service-catalog-tef-succeeded.png)
 
 ## Next Steps
 

diff --git a/...ice-catalog-find-tef-product-versions.png → ...ice-catalog-find-tef-product-versions.png b/...ice-catalog-find-tef-product-versions.png → ...ice-catalog-find-tef-product-versions.png
diff --git a/...e-catalog-install-tef-navigate-to-cfn.png → ...e-catalog-install-tef-navigate-to-cfn.png b/...e-catalog-install-tef-navigate-to-cfn.png → ...e-catalog-install-tef-navigate-to-cfn.png
diff --git a/...pc/service-catalog-launch-product-tef.png → ...pc/service-catalog-launch-product-tef.png b/...pc/service-catalog-launch-product-tef.png → ...pc/service-catalog-launch-product-tef.png
diff --git a/...vice-catalog-name-provisioned-product.png → ...vice-catalog-name-provisioned-product.png b/...vice-catalog-name-provisioned-product.png → ...vice-catalog-name-provisioned-product.png
diff --git a/...-and-new-vpc/service-catalog-products.png → ...into-new-vpc/service-catalog-products.png b/...-and-new-vpc/service-catalog-products.png → ...into-new-vpc/service-catalog-products.png
diff --git a/...pc/service-catalog-select-tef-version.png → ...pc/service-catalog-select-tef-version.png b/...pc/service-catalog-select-tef-version.png → ...pc/service-catalog-select-tef-version.png
diff --git a/...ault-parameter-sections-netowrk-opt-b.png → ...ault-parameter-sections-netowrk-opt-b.png b/...ault-parameter-sections-netowrk-opt-b.png → ...ault-parameter-sections-netowrk-opt-b.png
diff --git a/...atalog-tef-default-parameter-sections.png → ...atalog-tef-default-parameter-sections.png b/...atalog-tef-default-parameter-sections.png → ...atalog-tef-default-parameter-sections.png
diff --git a/...ervice-catalog-tef-ecs-host-parameter.png → ...ervice-catalog-tef-ecs-host-parameter.png b/...ervice-catalog-tef-ecs-host-parameter.png → ...ervice-catalog-tef-ecs-host-parameter.png
diff --git a/...ice-catalog-tef-launch-product-action.png → ...ice-catalog-tef-launch-product-action.png b/...ice-catalog-tef-launch-product-action.png → ...ice-catalog-tef-launch-product-action.png
diff --git a/...atalog-tef-parameter-advanced-scaling.png → ...atalog-tef-parameter-advanced-scaling.png b/...atalog-tef-parameter-advanced-scaling.png → ...atalog-tef-parameter-advanced-scaling.png
diff --git a/...ef-parameter-deployment-release-phase.png → ...ef-parameter-deployment-release-phase.png b/...ef-parameter-deployment-release-phase.png → ...ef-parameter-deployment-release-phase.png
diff --git a/...meter-deployment-resource-name-prefix.png → ...meter-deployment-resource-name-prefix.png b/...meter-deployment-resource-name-prefix.png → ...meter-deployment-resource-name-prefix.png
diff --git a/...atalog-tef-parameter-installation-old.png → ...atalog-tef-parameter-installation-old.png b/...atalog-tef-parameter-installation-old.png → ...atalog-tef-parameter-installation-old.png
diff --git a/...ce-catalog-tef-parameter-installation.png → ...ce-catalog-tef-parameter-installation.png b/...ce-catalog-tef-parameter-installation.png → ...ce-catalog-tef-parameter-installation.png
diff --git a/...service-catalog-tef-parameter-logging.png → ...service-catalog-tef-parameter-logging.png b/...service-catalog-tef-parameter-logging.png → ...service-catalog-tef-parameter-logging.png
diff --git a/...tef-parameter-network-create-in-stack.png → ...tef-parameter-network-create-in-stack.png b/...tef-parameter-network-create-in-stack.png → ...tef-parameter-network-create-in-stack.png
diff --git a/...og-tef-parameter-network-existing-vpc.png → ...og-tef-parameter-network-existing-vpc.png b/...og-tef-parameter-network-existing-vpc.png → ...og-tef-parameter-network-existing-vpc.png
diff --git a/...g-tef-parameter-network-load-balancer.png → ...g-tef-parameter-network-load-balancer.png b/...g-tef-parameter-network-load-balancer.png → ...g-tef-parameter-network-load-balancer.png
diff --git a/...alog-tef-parameter-network-predefined.png → ...alog-tef-parameter-network-predefined.png b/...alog-tef-parameter-network-predefined.png → ...alog-tef-parameter-network-predefined.png
diff --git a/...e-catalog-tef-parameter-network-proxy.png → ...e-catalog-tef-parameter-network-proxy.png b/...e-catalog-tef-parameter-network-proxy.png → ...e-catalog-tef-parameter-network-proxy.png
diff --git a/...tef-parameter-network-security-groups.png → ...tef-parameter-network-security-groups.png b/...tef-parameter-network-security-groups.png → ...tef-parameter-network-security-groups.png
diff --git a/...ameter-scaling-target-cpu-utilisation.png → ...ameter-scaling-target-cpu-utilisation.png b/...ameter-scaling-target-cpu-utilisation.png → ...ameter-scaling-target-cpu-utilisation.png
diff --git a/...new-vpc/service-catalog-tef-succeeded.png → ...new-vpc/service-catalog-tef-succeeded.png b/...new-vpc/service-catalog-tef-succeeded.png → ...new-vpc/service-catalog-tef-succeeded.png
diff --git a/...-vpc/service-catalog-tef-under-change.png → ...-vpc/service-catalog-tef-under-change.png b/...-vpc/service-catalog-tef-under-change.png → ...-vpc/service-catalog-tef-under-change.png
diff --git a/docs/sidebar.json b/docs/sidebar.json
@@ -383,7 +383,7 @@
                 "id": "install-tef",
                 "link": "guides/hosting-guardrails/installation/install-tef",
                 "items": [
-                  "guides/hosting-guardrails/installation/install-tef/install-tef-and-new-vpc",
+                  "guides/hosting-guardrails/installation/install-tef/install-tef-into-new-vpc",
                   "guides/hosting-guardrails/installation/install-tef/install-tef-into-existing-vpc"
                 ]
               },