Configure an Agent

• Amazon Web Services (AWS)
• Microsoft Azure
• Google Cloud Platform (GCP)
• Running locally in Docker
• Kubernetes (k8s) Cluster

​

AWS

​

Overview

​

Prerequisites

• Review the Agent reference page.
• Amazon Web Services (AWS) account.

​

Step One - Create an Agent

​

Step Two - Launch an agent in AWS

1. Prepare the UserData by going to your agent’s page in Control Plane. Select Download Scripts from the Actions menu. Paste the bootstrap token you saved earlier and copy the YAML that shows in the Userdata Script tab.
2. Log in to the AWS Console.
3. Navigate to EC2 service
4. You can deploy a single VM or an ASG to create multi-instance deployment of the agent

5. Optional: Under the Key pair(login) section, select or create a new key pair to enable SSH access to the agent. A key pair is necessary only for accessing the agent during troubleshooting.

5. Under the Network setting section, review the details and verify that the selected VPC is the same as the AWS resource you are trying to access.
6. Under the Configure storage section, click the Advanced link and expand the volume property. Modify the Delete on termination dropdown to Yes. This will ensure the associated volume is removed if the agent is terminated, thereby preventing any orphaned volumes.
7. Expand the Advanced details section. Scroll to the bottom and paste User data textbox.
8. Click Launch instance in the lower right corner.
9. After a brief moment, the instance will launch and be ready to process requests.

​

Next Steps

​

Azure

​

Overview

​

Prerequisites

• Review the Agent reference page
• Microsoft Azure account

​

Step One - Create an Agent

​

Step Two - Launch an agent in Azure

1. Prepare the UserData by going to your agent’s page in Control Plane. Select Download Scripts from the Actions menu. Paste the bootstrap token you saved earlier and copy the YAML that shows in the Userdata Script tab.
2. Log in to the Azure Console.
3. Use these recommended settings for the Create a virtual machine wizard:

• Basic
  • Subscription: Choose the appropriate subscription.
  • Resource Group: Choose the appropriate resource group. If necessary, create a new one.
  • Virtual machine name: Enter Control-Plane-Agent-01. If installing multiple agents, increment the number.
  • Region: Select a region closest to your other Azure resources.
  • Availability options: Select No infrastructure redundancy required. Use a different option for your environment if you are running in production.
  • Image: Select a recent Linux image.
  • Size: An instance with at least 2 vCPUs and 4 GiB of memory is recommended for optimal performance.
  • Authentication type: Select SSH public key.
  • Username: Leave as azureuser.
  • SSH public key source: Choose the appropriate key. If necessary, create a new one.
  • Key pair name: Select appropriate key, or if creating a new one, use the default or update the key name.
  • Public inbound ports: Select None. The agent does not need any inbound ports open.
  • Click Next: Disks.
• Disks
  • OS disk type: Select Premium SSD.
  • Encryption type: Select (Default) Encryption at-rest with a platform-managed key.
  • Click Next: Networking.
• Networking
  • Virtual network: Choose an appropriate network or use the new network that will be created.
  • Subnet: Choose appropriate network or use the default.
  • Public IP: Select None.
  • NIC network security group: Select Basic.
  • Public inbound ports: Select None.
  • Click Next: Management.
• Management
  • Enable basic plan for free: Enabled.
  • Boot diagnostics: Select Enable with managed storage account.
  • Enable OS guest diagnostics: Disabled.
  • System assigned managed identity: Disabled.
  • Enable auto-shutdown: Disabled.
  • Patch orchestration options: Select Image default.
  • Click Next: Advanced.
• Advanced
  • Custom data: Paste the YAML produced in step 1.
  • Click Next: Tags.
• Tags
  • Optional: Enter any necessary tags.
  • Click Next: Review + create.
• Review + create
  • Review all the settings and enter any missing values.
  • Click Create.
  • If you requested to create a new key pair, a modal will pop-up requesting to download the private key. Click Download private key and create resource.

​

Next Steps

​

GCP

​

Overview

​

Prerequisites

• Review the Agent reference page
• Google Cloud Platform (GCP) account.

​

Step One - Create an Agent

​

Step Two - Launch agent in GCP

1. Prepare the UserData by going to your agent’s page in Control Plane. Select Download Scripts from the Actions menu. Paste the bootstrap token you saved earlier and copy the shell script shows in the Startup Script tab.
2. Deploy a VM (or an autoscaling group) from your preferred Linux base image.
3. During configuration of the VM or the launch template set the startup-script metadata to the script you produced in step 1. See Metadata keys for Linux startup scripts

3. Give the VM(s) a few minutes to boot and connect to Control Plane.
4. The agent will now be running, connecting to the Control Plane servers, and ready to process requests.

​

Step Three - Configure Firewall

​

Next Steps

​

Running locally in Docker

​

Overview

​

Prerequisites

• Review the Agent reference page.
• Install the CLI.
• Install Docker

​

Step One - Create an Agent

​

Step Two - Launch agent locally

1. Open a new shell and execute the following command. Use the bootstrap file that was created in step one.

cpln agent up --bootstrap-file=path/to/bootstrapConfig.json

2. The agent will now be running, connecting to the Control Plane servers, and ready to process requests.

​

Next Steps

​

Kubernetes (k8s) Cluster

​

Overview

​

Prerequisites

• Review the Agent reference page.
• Install the CLI.

​

Step One - Create an Agent

​

Step Two - Launch agent within a K8s cluster

1. Prepare your k8s manifests by going to your agent’s page in Control Plane. Select Download Scripts from the Actions menu. Paste the bootstrap token you saved earlier and copy the YAML that shows in the K8S Manifests tab. There you can optionally configure a namespace and number of replicas. Recommended number of replicas is 2.
2. Assuming you have saved the manifest to a file locally just apply it with kubectl:

# may need to create the namespace using kubectl create ns agent-namespace

kubectl apply -f agent-manifests.yaml

3. Withing a few minutes agent pods will be ready to can handle requests.

​

Next Steps