Skip to main content

Deploy to AWS VMs

This tutorial helps you get started with Harness Continuous Delivery (CD). We will guide you through creating a CD pipeline with deployment types Secure Shell (SSH) and WinRM to deploy applications to remote Linux and Windows servers.

info

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

Before you begin​

Verify the following:

  1. One or more Linux Instances on AWS. Make sure port 22 is open on the security group.
  2. SSH private key (*.pem file) to authenticate with the remote instance(s). To understand how SSH password-less authentication works, go to Passwordless SSH using public-private key pairs.
  3. Docker to set up and start the Harness Docker delegate.

Getting started with Harness CD​

  1. Log into Harness.

  2. Select Projects, and then select Default Project.

    warning

    For the pipeline to run successfully, please follow all of the following steps as they are, including the naming conventions.

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. In Project Setup, select Delegates.

    • Select Delegates.

      • Select Install delegate. For this tutorial, let's explore how to install the Docker Delegate.

      • In the command provided, ACCOUNT_ID, MANAGER_ENDPOINT and DELEGATE_TOKEN are auto-populated values that you can obtain from the delegate installation wizard.

        docker run --cpus=1 --memory=2g \
          -e DELEGATE_NAME=docker-delegate \
          -e NEXT_GEN="true" \
          -e DELEGATE_TYPE="DOCKER" \
          -e ACCOUNT_ID=ACCOUNT_ID \
          -e DELEGATE_TOKEN=DELEGATE_TOKEN \
          -e LOG_STREAMING_SERVICE_URL=https://app.harness.io/gratis/log-service/ \
          -e MANAGER_HOST_AND_PORT=MANAGER_ENDPOINT harness/delegate:23.05.79310

    • Verify that the delegate is installed successfully and can connect to the Harness Manager.

note

You can also follow the Install Harness Delegate on Kubernetes or Docker steps to install the Kubernetes Delegate using Helm, the Terraform Helm Provider, or a Kubernetes manifest.

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.

  1. Create a secret of type SSH Credential.
    • In Project Setup, select Secrets.
    • Select New Secret, and then select SSH Credential.
    • Enter the secret name harness_sshprivatekey and select Continue.
    • With SSH Key as the auth scheme, select Username/SSH Key as the authentication method.
    • In Username, enter the username for the user account on the remote server. For example, ubuntu.
    • Next, select Create or Select a Secret and select New Secret File.
    • Enter the secret name ssh-private-key and select Browse to upload the SSH private key to the Harness Secret Manager.
    • Select Save and, if needed, modify the SSH port number.
    • Finally, select Save and Continue and verify the connection to remote server is successful.
  2. Create a secret to store the AWS secrete key.
    • In Project Setup, select Secrets.
    • Click New Secret, and then select Text.
    • Enter the secret name harness_awssecretkey.
    • For the secret value, paste in the AWS Secret Key.
    • Select Save.

Connectors​

What are connectors?

Connectors in Harness enable integration with 3rd party tools, providing authentication and operations during pipeline runtime. For instance, a GitHub connector facilitates authentication and fetching files from a GitHub repository within pipeline stages. Explore connector how-tos here.

  1. Create an AWS connector.
    • Copy the contents of aws-connector.yml.
    • In Harness, in Project Setup, select Connectors.
    • Select Create via YAML Builder and paste the copied YAML.
    • In the YAML, replace AWS_ACCESS_KEY_ID with the AWS Access Key ID value.
    • Select Save Changes and verify that the new connector named harness_awsconnector is successfully created.
    • Finally, select Test under Connectivity Status to ensure the connection is successful.
  2. Create a Artifactory Connector. For this tutorial, we'll use a publicly available ToDo List app artifact, todolist.war, available in a public Harness Artifactory repo.
    • Copy the contents of artifactory-connector.yml.
    • In Harness, in Project Setup, select Connectors.
    • Select Create via YAML Builder and paste the copied YAML.
    • Select Save Changes and verify that the new connector named harness_artifactrepo is successfully created.
    • Finally, select 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 VMs, Kubernetes clusters, or other target infrastructures. To learn more about environments, go to Environments overview.

  1. In Default Project, select Environments.
    • Select New Environment and toggle to YAML to use the YAML editor.
    • Copy the contents of environment.yml and paste it into the YAML editor and select Save.
    • In Infrastructure Definitions, select Infrastructure Definition and select Edit YAML.
    • Copy the contents of infrastructure-definition.yml and paste it into the YAML editor.
    • In the Infra Definition YAML, replace AWS_REGION with the region where your instance is running and INSTANCE_NAME with the name of the instance.
    • Select Save and verify that the environment and infrastructure definition is created successfully.

Services​

What are Harness services?

In Harness, services represent what you deploy to environments. You use services to configure variables, manifests, 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 Default Project, select Services.
    • Select New Service.
    • Name the service harness_ssh.
    • Select Save, and then in the Configuration tab, toggle to YAML to use the YAML editor.
    • Select Edit YAML and copy the contents of service.yml and paste it into the YAML editor.
    • Select Save and verify that the service harness_ssh 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 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 Default Project, select Pipelines.
    • Select New Pipeline.
    • Enter the name harness_ssh_pipeline.
    • Select Inline to store the pipeline in Harness.
    • Select Start and, in the Pipeline Studio, toggle to YAML to use the YAML editor.
    • Select Edit YAML to enable edit mode, and choose any of the following execution strategies. Paste the respective YAML based on your selection.
What are Canary deployments?

A canary deployment updates nodes in a single environment gradually, allowing you to use gates between increments. Canary deployments allow incremental updates and ensure a controlled rollout process. For more information, go to When to use Canary deployments.

  • Copy the contents of pipeline-ssh-canary.yml and paste it into the YAML editor.
  • Select Save.
  • You can switch to the Visual editor and confirm the pipeline, stage, and execution steps are as shown below.

Canary

  1. 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 copies the artifact from its source to the remote server.

    • After a successful execution, you can check the artifact in your remote server using the following command:

      ls -l ~/harness_ssh/harnessdevenv/todolist.war

Congratulations!🎉​

You've just learned how to use Harness CD to copy an artifact to AWS instances.

Keep learning about Harness CD. Add triggers to your pipeline that'll respond to Git events by following this guide.