Skip to main content

Installing the Upwind Cluster Manager

This topic provides instructions for installing the Upwind Cluster Manager for AWS Lambda functions. There are 2 steps:

  1. Install the Upwind Cluster Manager.
  2. Instrument your AWS Lambda functions with the Upwind Lambda Tracer.

Prerequisites

To successfully install the Upwind components ensure the following prerequisites are met:

  1. AWS VPC. Ensure that you have an existing VPC with connected Lambda functions. The VPC should have DNS resolution and DNS hostnames enabled. If you need to create a VPC, refer to the Create VPC guide.

  2. Private Subnet with NAT Gateway. Ensure the Cluster Manager task has at least one private subnet configured with a NAT Gateway. This setup is essential to provide network services to the Upwind components. For more information, consult the AWS documentation on configuring a VPC with private subnets and a NAT Gateway.

    info

    The Cluster Manager task does not receive a public IP address to prevent exposing services on the public internet. The NAT Gateway is necessary for secure communication with the Upwind platform via the public internet.

Install the Upwind Cluster Manager

The Upwind Cluster Manager is deployed as an ECS Fargate service, running in a dedicated ECS cluster. Follow these steps to get started:

  1. Log in to the Upwind Management Console .

  2. Select the + (plus) symbol at the top of the screen and select Connect AWS Lambda Function.

  3. Select AWS account and VPC that the Upwind Cluster Manager should be installed in. This should be the VPC that your AWS Lambda functions are connected to.

    info

    If your account or VPC is not listed, ensure that your account is properly connected to Upwind. For more information on connecting your account, please refer to the Connect Cloud Account documentation.

    info

    If you have Lambda functions deployed in multiple VPCs you must install the Upwind Cluster Manager in each VPC.

  4. Under Select Sensor Credentials, click Generate to create a new client ID and client secret. If you already have Sensor credentials, you may skip this step and select existing credentials from the list.

    Important

    The credentials can be viewed only once. If you choose to use existing credentials from the list you must provide the client secret.

  5. Upwind Cluster Manager installation using Terraform

  1. Create a new directory for your Terraform project and navigate to it in your terminal, or use an existing one if you would like to set up the Terraform module in an existing project:

    mkdir my-terraform-project && cd $_
  2. Inside your project directory, create a new file named main.tf to hold the Terraform configuration, or modify an existing main.tf if you are integrating with an existing project:

    touch main.tf
  3. Copy or download the code snippet from the Terraform setup section in the Upwind console and paste it into main.tf.

  4. Before proceeding, ensure the configuration settings are tailored to your environment.

    Authentication ConfigurationEnsure that the upwind_client_id and upwind_client_secret variables are set to valid Sensor credential values obtained in step 4.
    VPC ConfigurationEnsure that the vpc_id variable is set to the ID of the desired VPC, containing the Lambda functions you wish to instrument with the Upwind Lambda Tracer.
    Networking ConfigurationEnsure the subnets variable is set to the IDs of one or more private subnets with routes to the NAT Gateway.
  5. Save the changes to your main.tf file.

  6. Run the following command to initialize Terraform within the project directory:

    terraform init
  7. Run the following command to apply the Terraform configuration and create the necessary resources:

    terraform apply
  8. Review the changes that Terraform plans to make and enter yes when prompted to confirm the changes. Terraform will provision the necessary resources in your AWS account to deploy the Upwind components, based on the provided configuration.

  9. Once the terraform apply command has successfully executed, the necessary resources should be provisioned within a few moments. A success message will appear to indicate the successful installation of the Upwind components.

You should now see a new ECS cluster in your AWS account, with a name of the form upwind-utility-cluster-*.

  1. Click the "Test & save" button to test connectivity and complete the Upwind Cluster Manager setup. This will validate the connection between the Cluster Manager and the Upwind platform.

Instrumenting Lambda functions

The next step is to Instrument Lambda functions with the Upwind Lambda Tracer.