Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

...

Amazon Web Services (AWS) is a subsidiary of Amazon that provides onthese metered pay-as-you-go services:

  • On-demand cloud computing platforms

...

  • APIs to individuals, companies, and governments

...

Configure A Terraform Backend State (AWS)

...

Deploying an AWS Terraform Blueprint is a three-step process where you’ll need to:

  1. Create a Terraform Blueprint

  2. Provision your Resource using Terraform Blueprint

  3. Deploy your Terraform Blueprint

Note

Before you begin
Ensure that you have access to at least one resource pool.

Create a Terraform Blueprint

...

Create a Terraform-based Blueprint is a three-step process. You’ll need to:

  1. Configure a Terraform Backend State

  2. Create a Terraform Workspace

  3. Create a Terraform Blueprint

Configure a Backend State

...

A Terraform backend allows for abstraction and determines how a state is loaded, and operations executed. Terraform uses the local backend by default. In the HCP portal, a Terraform Backend state stores the current state of the deployment. (Refer Note 1)

You can use the following steps to configure your Terraform Backend State:

  1. Login to HyperCloudTM with your credentials.

  2. Click Service Orchestration > Select AppStore > Click Terraform

  3. Click on Terraform Blueprint to open your Blueprint Azure Postgres (PaaS)

    1. On the Overview page, review details and click Next

    2. On the Workspace page:

      1. Select the Workspace type as New:

        • Enter the name for your new workspace.

        • Enter the brief description for your new workspace.

        • Select the environment type from the drop-down list e.g: Dev.

        • Select the Cloud type from the drop-down list.

        • Select the Resource pool e.g: RP.ARM.Australia Central.atest

        • Select the backend state for your new workspace.

        • To entitled users:

          • Select Only Me: If this template is not meant to be shared.

          • Select Everyone If this template is to be shared with everyone in the.

          • Select Groups & Users: if the template is to be shared with specific users or groups.

        • Click Create Workspace and Validate

      2. Select the workspace type as Existing and Select the existing workspace e.g. hgprodazurewks1 and click Validate

  4. On the Define Variables page, click on the Action button and update the following values:

    • rg_name: "hgprod-tf-rg"

    • pg_name: "hgprod-psqlsrv01"

    • client_startip: "your system's public ip address"

    • client_endip: "your system's public ip address"

  5. Click on Plan

  6. Review the Successful Plan Output.

  7. Click on Apply

  8. Click on the Workspace for e.g hgprodazurewks1

  9. Click on Timeline Tab to monitor the status of the Terraform provisioning.

  10. Once the Terraform template has successfully provisioned, click on the Resource Tab to view the resources created via Terraform template

To create additional templates refer to the Terraform documentation.

Note

[1]

To create a Terraform Backend State:

  1. Log in to your HCP portal account.

  2. Click Service Orchestration and navigate to Services > Infra as Code > Backend State > Click + New Backend State.

  3. Enter the following details in the New backend State dialog:

    1. Enter a Name for your Backend State.

    2. Select the Cloud Type from the drop-down list.

    3. Select your Resource Pool from the drop-down list.

    4. Enter a brief Description of your Backend State.

    5. To entitle users to your Backend State, select:

      • Only Me: if you do not want anyone to access your backend state.

      • Everyone: if you want to share your backend state with everyone.

      • Groups & Users: if you want to share the backend state with specific users or groups.

        1. Enter the first three alphabets of the username in the Users drop-down and select the username.

        2. Type the first three alphabets of the Group Name in the Groups drop-down and select the group name.

  4. Click Save Changes.

Note

  • [1] If the backend state has no state saved previously, the Terraform plan will provide you an information object which will be created.

    • Otherwise, the Terraform output will show updates and delete tasks too, which means existing resources will change if ignored.

Create your Terraform Workspace

...

Workspaces are collections of infrastructure that run locally. In other words, a workspace is an isolated instance of state data for a Terraform CLI. A Terraform workspace manages each collection of infrastructure with a persistent working directory, which contains a configuration, state data, and variables. You can create multiple workspaces to manage various sets of discrete infrastructure from a single configuration in a single directory. The Terraform cloud manages infrastructure collections through workspaces instead of directories. The terraform workspace organizes your infrastructure into groups. You can create a workspace to manage your collection of infrastructure resources.

To create a Terraform Workspace: [1]

  1. Login to your HCP account.

  2. Click Service Orchestration and navigate to Infra as Code > Workspace > Click + New Workspace.

  3. Enter the following details in the New Workspace dialog:

    1. Enter your workspace Name.

    2. Enter a brief description of your Workspace.

    3. Select your workspace Environment.

    4. Select the Cloud Type from the drop-down list.

    5. Select your Resource Pool from the drop-down list.

    6. Select your Backend State from the drop-down list.

    7. To entitle users to your new Workspace, select: 

      • Only Me: if you do not want anyone to access your Workspace.

      • Everyone: if you want to share your Workspace with everyone.

      • Groups & Users: if you want to share the Workspace with specific users or groups.

        1. Enter the first three alphabets of the username in the Users drop-down and select the username.

        2. Type the first three alphabets of the Group Name in the Groups drop-down and select the group name.

  4. Click New Workspace.

Notes

  • [1] Resource pool contains cloud provider information. Therefore, a Terraform deployment does not affect the quota limit of the resource pool.

Create a Terraform Blueprint

...

Terraform-based blueprints let you create infrastructure on your cloud environment using a template.

Tip

Before you begin
If you want to upload a Terraform-based template, follow these steps:

  1. Download the Sample Terraform Template.

  2. Zip the downloaded files.
    Example: aws-s3-bucket-tf.zip

  3. Follow Step 2c below to upload your Terraform template to the HCP portal.

Follow these steps to create a Terraform-based blueprint:

  1. Log in to your HCP portal account.

  2. Click Service Orchestration and navigate to AppStore > Click New > Select Terraform from the drop-down list.

  3. Enter these details in the New Terraform dialog:

    1. Enter a Name for your Terraform Template,
      Example: AWS S3 Bucket.

    2. Enter a brief description of your Terraform Template. This is an optional field.

    3. You can create a Terraform template using a template file in .zip format. Click Choose File to upload a Terraform template file.

    4. Configure your Terraform template version. This is an optional step.

    5. Select AWS from the Cloud Typedrop-down list.

    6. To entitle users to your Terraform template, select:

      • Only Me: if you do not want anyone to access your Terraform template.

      • Everyone: if you want to share your Terraform template with everyone.

      • Groups & Users: if you want to share your Terraform template with specific users or groups.

        1. Enter the first three alphabets of the username in the Users drop-down and select the username.

        2. Type the first three alphabets of the Group Name in the Groups drop-down and select the group name.

      • If you are a Cloud Administrator, you can choose All Tenants to make the template available to all the tenants.

  4. Click Create.

Provision your Terraform Blueprint

...

Once you’ve created a Terraform workspace, you can provision your Terreform Blueprint on your Amazon Web Service (AWS) resource. Follow these steps to provision your Terraform Blueprint:

  1. Login to your HCP portal account.

  2. Click Service Orchestration and navigate to AppStore > Terraform > Click open your Terraform Blueprint.

  3. From the Blueprint Details page:

    1. Review your blueprint Overview, and click Next.

    2. Select New Workspace Type from the Workspace page.

      1. Enter these details to create a new workspace:

        1. Enter a Name for workspace.

        2. Enter a brief Description of the new workspace.

        3. Select the following configurations for your workspace from the drop-down list:

          1. Select your workspace Environment

          2. Select Cloud Type

          3. Select your Resource Pool

          4. Select the backend state

        4. To entitle users to your new Workspace, select: 

          • Only Me: if you do not want anyone to access your Workspace.

          • Everyone: if you want to share your Workspace with everyone.

          • Groups & Users: if you want to share the Workspace with specific users or groups.

            1. Enter the first three alphabets of the username in the Users drop-down and select the username.

            2. Type the first three alphabets of the Group Name in the Groups drop-down and select the group name.

        5. Click Create Workspace and Validate.

        6. Alternately, you can select an Existing Workspace Type from the drop-down list, if you’ve configured one already.

        7. From the Define Variables page, click Action and provide the value for Bucket_Name.
          Example: "hg-prod-bk1" [1]

        8. Click Plan and Review the Successful Plan Output. [2]

        9. Click Apply.

        10. Click open your Workspace.

        11. Click Timeline to monitor the Terraform provisioning status.

        12. Once you’ve successfully provisioned your Terraform template, click the Resource to view the resources created via the Terraform template.

Note

  • [1]All variables must be enclosed in double-quotes.

  • Terraform Template provides the information regarding, Overlapping the Existing Workspace that may destroy the existing deployment.

  • If this is the first time a Terraform template is being deployed, ensure no resources are updated or deleted.

  • If so verify that this is intentional and then proceed to the next step[2] If you are deploying your Terraform template for the first time, it ensures that it does not delete or update your existing resources.

    • If any of your resources are slated for deletion or updates, the template verifies that this is intentional before performing these tasks.

  • You can create your own templates. Refer to your Terraform Amazon Web Services Documentation.

Deploy your Terraform Blueprint

...

Once you’ve provisioned a Terraform Blueprint, you’ll need to deploy it. Follow these steps to deploy your Terraform Blueprint:

  1. Login to your HCP portal account.

  2. Click Service Orchestration and navigate to AppStore > Terraform > Click open your Terraform Blueprint.

  3. Select your Workspace and click Validate.

  4. Check your Terraform variables for syntax errors by clicking Validate.

  5. Click Plan to create a plan of execution and review the changes to your deployed resource.

  6. Click Apply to deploy your Blueprint and configure your resources in the cloud provider.