Skip to main content

AWS Lambda serverless deployments

This tutorial demonstrates how to deploy on AWS Lambda using Harness Continuous Delivery (CD). We will guide you through deploying a sample function using a Harness pipeline.

info

Sign up today to unleash the potential of intelligent Harness CD.

Before you begin​

Verify the following:

  1. Obtain GitHub personal access token with the repo scope. For the GitHub documentation, go to creating a personal access token.

  2. Docker. For this tutorial ensure that you have the Docker runtime installed on your Harness Delegate host. If not, use one of the following options to install Docker:

  3. Fork the harnesscd-example-apps repository through the GitHub website.

    • For more information on forking a GitHub repository, go to GitHub docs.

  4. AWS user account with required policy: Serverless deployments require an AWS user account with specific AWS permissions, as described in AWS Credentials from Serverless.com. To create the AWS user, do the following in AWS IAM:

    • Select Users, and then Add user. Enter a name. Enable Programmatic access by selecting the checkbox. Select Next to go to the Permissions page. Do one of the following:

      • Full Admin Access: select Attach existing policies directly. Search for and select AdministratorAccess then select Next: Review. Check to make sure everything looks good and select Create user.
      • Limited Access: select Create policy. Select the JSON tab, and add the JSON from the Serverless gist: IAMCredentials.json.

Supported platforms and versions​

  • Harness supports Serverless framework 1.82 and later.
  • Harness supports Serverless framework CLI versions 2.x.x and 3.x.x.
  • Harness supports all language runtimes that Serverless supports.
  • Harness supports ZIP files and Docker image artifacts only.
    • ZIP files are supported with JFrog Artifactory.
    • Docker images are supported with AWS ECR.

Getting Started with Harness CD​

  1. Log into Harness.
  2. Select Projects and choose Default Project.
warning

Going forward, follow all the steps as they are, including the naming conventions, for the pipeline to run successfully.

Delegate​

What is the Harness Delegate?

The Harness Delegate is a service that runs in your local network or VPC to establish connections between the Harness Manager and various providers such as artifacts registries, cloud platforms, etc. The delegate is installed in the target infrastructure, for example, a Kubernetes cluster, and performs operations including deployment and integration. Learn more about the delegate in the Delegate Overview.

  1. Under Project Setup, select Delegates.
  2. In Delegates Setup, select Install new Delegate. The delegate wizard appears.
  3. In New Delegate, in Select where you want to install your Delegate, select Docker.
  4. Enter the delegate name, harness-aws-lambda-delegate.

Now you can install the delegate by using the command that appears on your installation wizard. The command is prefilled with the information for the environment variables in the example below.

docker run --cpus=1 --memory=2g \
  -e DELEGATE_NAME=harness-serverless-delegate \
  -e NEXT_GEN="true" \
  -e DELEGATE_TYPE="DOCKER" \
  -e ACCOUNT_ID= YOUR_HARNESS_ACCOUNTID \
  -e DELEGATE_TOKEN=YOUR_DELEGATE_TOKEN \
  -e LOG_STREAMING_SERVICE_URL=YOUR_MANAGER_HOST_AND_PORT/log-service/ \
  -e MANAGER_HOST_AND_PORT=YOUR_MANAGER_HOST_AND_PORT \
  DELEGATE_IMAGE:TAG
info

Replace DELEGATE_IMAGE:TAG with the custom delegate image harnesscommunity/serverless-delegate:latest. This image has the Serverless.com framework installed.

Verify delegate connectivity​

  1. Select Continue. After the health checks passes, your delegate is available to use.
  2. Select Done and verify your new delegate is listed.

Secrets​

What are Harness secrets?

Harness offers built-in secret management for encrypted storage of sensitive information. Secrets are decrypted when needed, and only the private network-connected Harness Delegate has access to the key management system. You can also integrate your own secret manager. To learn more about secrets in Harness, go to Harness Secret Manager Overview.

Github secret​

  1. Under Project Setup, select Secrets.
  2. Select New Secret, and then select Text.
  3. Enter the secret name harness_gitpat.
  4. For the secret value, paste the GitHub personal access token you saved earlier.
  5. Select Save.

AWS secret​

  1. Select New Secret, and then select Text.
  2. Enter the secret name awssecret.
  3. For the secret value, paste the access token for your AWS user account. The Harness Delegate uses this credential to authenticate Harness with AWS at deployment runtime.
  4. Select Save.

Connectors​

What are connectors?

Connectors in Harness enable integration with 3rd party tools, providing authentication for operations during pipeline runtime. For instance, a GitHub connector facilitates authentication and fetching files from a GitHub repository within pipeline stages. For more details, go to Connectors.

  1. Create the GitHub connector.

    1. Copy the contents of github-connector.yml.
    2. In your Harness project in the Harness Manager, under Project Setup, select Connectors.
    3. Select Create via YAML Builder and paste the copied YAML.
    4. Assuming you have already forked the harnesscd-example-apps repository mentioned earlier, replace GITHUB_USERNAME in the YAML with your GitHub account username.
    5. In projectIdentifier, replace with the project identifier with yours, for example, default.
    6. Select Save Changes and verify that the new connector named harness_gitconnector is successfully created.
    7. Finally, select Connection Test under Connectivity Status to ensure the connection is successful.

  2. Create the AWS Connector.

    1. Copy the contents of aws-connector.yml.
    2. In your Harness project in the Harness Manager, under Project Setup, select Connectors.
    3. Select Create via YAML Builder and paste the copied YAML.
    4. Assuming you have already forked the harnesscd-example-apps repository mentioned earlier, replace crossAccountRoleArn in the YAML with your AWS role's ARN.
    5. Replace the accessKey placeholder with the AWS access key for the AWS user you created (with the required policies).
    6. Here we assume the region for secret key to be us-east-1. Please replace it with the appropriate region.
    7. In projectIdentifier, replace with the project identifier with yours, for example, default.
    8. Select Save Changes and verify that the new connector named harness_awsconnector is successfully created.
    9. Finally, select Connection Test under Connectivity Status to ensure the connection is successful.

Environment​

What are Harness environments?

Environments define the deployment location, categorized as Production or Pre-Production. Each environment includes infrastructure definitions for serverless functions, VMs, Kubernetes clusters, or other target infrastructures. To learn more about environments, go to Environments overview.

  1. In your Harness project, select Environments.
    1. Select New Environment, and then select YAML.
    2. Copy the contents of environment.yml, paste it into the YAML editor, and select Save.
    3. In your new environment, select the Infrastructure Definitions tab.
    4. Select Infrastructure Definition, and then select YAML.
    5. Copy the contents of infrastructure-definition.yml and paste it into the YAML editor.
    6. Select Save and verify that the environment and infrastructure definition are created successfully.

Services​

What are Harness services?

In Harness, services represent what you deploy to environments. You use services to configure variables, manifests, functions, and artifacts. The Services dashboard provides service statistics like deployment frequency and failure rate. To learn more about services, go to Services overview.

  1. In your Harness project, select Services.
    1. Select New Service.
    2. Enter the name harnessserverless.
    3. Select Save, and then YAML (on the Configuration tab).
    4. Select Edit YAML, copy the contents of service.yml, and paste the into the YAML editor.
    5. Select Save and verify that the service harness_serverless is successfully created.

Pipeline​

What are Harness pipelines?

A pipeline is a comprehensive process encompassing integration, delivery, operations, testing, deployment, and monitoring. It can utilize CI for code building and testing, followed by CD for artifact/function deployment in production. A CD pipeline is a series of stages where each stage deploys a service to an environment. To learn more about CD pipeline basics, go to CD pipeline basics.

  1. In your Harness project, select Pipelines.
    1. Select Create a Pipeline.
    2. Enter the name serverless_pipeline.
    3. Choose Inline to store the pipeline in Harness.
    4. Select Start.
    5. In Pipeline Studio, select YAML.
    6. Select Edit YAML and paste in the YAML in the next section.

Deploy AWS Lambda using Serverless.com Framework​

  1. Copy the contents of serverless-pipeline.yml.

  2. In your Harness pipeline YAML editor, paste the YAML.

  3. Select Save.

    You can switch to the Visual pipeline editor and confirm the pipeline stage and execution steps as shown below.

  4. Finally, it's time to execute the pipeline. Select Run, and then select Run Pipeline to initiate the deployment.

    Observe the execution logs as Harness deploys the function.

Congratulations!🎉​

You've just learned how to use Harness CD to deploy an AWS Lambda function on AWS Lambda using the Serverless.com Framework.