Deploy a Worker with Pulumi

In this tutorial, you will go through step-by-step instructions to deploy a Hello World web application using Cloudflare Workers and Pulumi Infrastructure as Code (IaC) so that you can become familiar with the resource management lifecycle. In particular, you will create a Worker, a Route, and a DNS Record to access the application before cleaning up all the resources.

Running Cloudflare Workers application deployed with Pulumi

Note

You will provision resources that qualify under free tier offerings for both Pulumi Cloud and Cloudflare.

Before you begin

Ensure you have:

• A Cloudflare account and API Token with permission to edit the resources in this tutorial. If you need to, sign up for a Cloudflare account ↗ before continuing.
• A Pulumi Cloud account. You can sign up for an always-free, individual tier ↗.
• npm ↗ and the Pulumi CLI installed on your machine.
• A Cloudflare Zone. Complete the Add a Site tutorial to create one.

Link to the full solution

You can find the complete solution of this tutorial under this Pulumi repo and branch ↗. To deploy the final version, run the following:

mkdir serverless-cloudflare && cd serverless-cloudflare
pulumi new https://github.com/pulumi/tutorials/tree/cloudflare-typescript-hello-world-end
npm install
pulumi up --yes

Initialize Pulumi

a. Create a directory

You’ll use a new and empty directory for this tutorial.

mkdir serverless-cloudflare
cd serverless-cloudflare

b. Login

At the prompt, press Enter to log into your Pulumi Cloud account via the browser. Alternatively, you may provide a Pulumi Cloud access token ↗.

pulumi login

c. Create a program

Note

A Pulumi program is code written in a supported programming language ↗ that defines infrastructure resources. We’ll use TypeScript.

To create a program, run:

pulumi new https://github.com/pulumi/tutorials/tree/cloudflare-typescript-hello-world-begin

Complete the prompts with defaults where available; otherwise, provide the requested information. You will need:

• Your Cloudflare account ID.
• Your Cloudflare Zone ID.
• A registered domain. For instance, example.com
• A valid Cloudflare API token.

d. Create a stack

Note

A Pulumi stack is an instance of a Pulumi program. Stacks are independently configurable and may represent different environments (development, staging, production) or feature branches.

To create a stack, run:

pulumi up --yes

After the above command completes, review the value of myFirstOutput for correctness.

e. (Optional) Review the stack

From the output above, follow your View in Browser link to get familiar with the Pulumi stack.

Note

You have not yet created any Cloudflare resources but have defined a variable, myFirstOutput, and the Pulumi stack.

Example:

View in Browser (Ctrl+O):
https://app.pulumi.com/diana-pulumi-corp/serverless-cloudflare/dev/updates/1

Pulumi Cloud stack

Add a Worker

You will now add a Cloudflare Worker to the Pulumi stack, dev.

a. Add Cloudflare Worker to index.ts

Replace the contents of your index.ts file with the following:

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
import * as fs from "fs";

const config = new pulumi.Config();
const accountId = config.require("accountId");

// A Worker script to invoke
export const script = new cloudflare.WorkerScript("hello-world-script", {
  accountId: accountId,
  name: "hello-world",
  // Read the content of the worker from a file
  content: fs.readFileSync("./app/worker.ts", "utf8"),
});

b. Install dependencies

npm install @pulumi/cloudflare

c. Apply the changes

pulumi up --yes

d. (Optional) View the Cloudflare Dashboard

You can view your Cloudflare resource directly in the Cloudflare Dashboard to validate its existence.

1. Log into the Cloudflare dashboard ↗.
2. Select your account.
3. Go to Workers & Pages.
4. Open the “hello-world” application. Example:

Add a Worker route

You will now add a Worker Route to the Pulumi stack, dev so the script can have an endpoint.

a. Add Worker Route to index.ts

Replace the contents of your index.ts file with the following:

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
import * as fs from "fs";

const config = new pulumi.Config();
const accountId = config.require("accountId");
const zoneId = config.require("zoneId");
const domain = config.require("domain");

// A Worker script to invoke
export const script = new cloudflare.WorkerScript("hello-world-script", {
  accountId: accountId,
  name: "hello-world",
  // Read the content of the worker from a file
  content: fs.readFileSync("./app/worker.ts", "utf8"),
});

// A Worker route to serve requests and the Worker script
export const route = new cloudflare.WorkerRoute("hello-world-route", {
  zoneId: zoneId,
  pattern: "hello-world." + domain,
  scriptName: script.name,
});

b. Apply changes

pulumi up --yes

c. (Optional) View the Cloudflare Worker route in the dashboard

In the Cloudflare Dashboard, the Worker application now contains the previously defined Worker Route.

1. Log into the Cloudflare dashboard ↗.
2. Select your account.
3. Go to Workers & Pages.
4. Select your application.
5. For Routes, select View to verify the Worker Route details match your definition.

Add a DNS record

You will now add a DNS record to your domain so the previously configured route can be accessed via a URL.

a. Add DNS Record to index.ts

Replace the contents of your index.ts file with the following:

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
import * as fs from "fs";

const config = new pulumi.Config();
const accountId = config.require("accountId");
const zoneId = config.require("zoneId");
const domain = config.require("domain");

// A Worker script to invoke
export const script = new cloudflare.WorkerScript("hello-world-script", {
  accountId: accountId,
  name: "hello-world",
  // Read the content of the worker from a file
  content: fs.readFileSync("./app/worker.ts", "utf8"),
});

// A Worker route to serve requests and the Worker script
export const route = new cloudflare.WorkerRoute("hello-world-route", {
  zoneId: zoneId,
  pattern: "hello-world." + domain,
  scriptName: script.name,
});

// A DNS record to access the route from the domain
export const record = new cloudflare.Record("hello-world-record", {
  zoneId: zoneId,
  name: script.name,
  value: "192.0.2.1",
  type: "A",
  proxied: true,
});

export const url = route.pattern;

Note

The last line in the code will create an output with the endpoint for the Hello World app.

b. Apply the changes

pulumi up --yes

c. (Optional) View all the resources in Pulumi Cloud

1. In your browser, open your Pulumi Cloud ↗
2. Navigate to your stack, serverless-cloudflare/dev.
3. Confirm all the defined resources are created and healthy. Example:

Pulumi Cloud stack

Test the app

You have incrementally added all the Cloudflare resources needed to run and access your Hello World application. This was done by defining the resources in TypeScript and letting Pulumi handle the rest.

You can test your application via the terminal or browser.

• In the terminal

pulumi stack output url

hello-world.atxyall.com

curl "https://$(pulumi stack output url)"

<!DOCTYPE html>
  <html>
    <head>
      <title>  Hello World </title>
    </head>
    <body>
      <h1>Serverless with Pulumi</h1>
      <p>The current time is: <span id="date">Thu Oct 05 2023 22:02:17 GMT+0000 (Coordinated Universal Time)</span>.</p>
    <script defer src="https://static.cloudflareinsights.com/beacon.min.js/v8b253dfea2ab4077af8c6f58422dfbfd1689876627854" integrity="sha512-bjgnUKX4azu3dLTVtie9u6TKqgx29RBwfj3QXYt5EKfWM/9hPSAI/4qcV5NACjwAo8UtTeWefx6Zq5PHcMm7Tg==" data-cf-beacon='{"rayId":"8118f2b5ddb5eb02","version":"2023.8.0","r":1,"b":1,"token":"240f365d9d42457597f861e6e46c6ce9","si":100}' crossorigin="anonymous"></script>
</body>
  </html>

Note

Depending on your domain settings, you may need to use “http” instead.

• In your browser, open hello-world.YOUR_DOMAIN.com

Example:

Hello World app browser screenshot

Clean up

In this last step, you will run a couple of commands to clean up the resources and stack you used throughout the tutorial.

a. Delete the Cloudflare resources

pulumi destroy

b. Remove the Pulumi stack

pulumi stack rm dev