Defang Provider: Installation & Configuration

Installation

The Pulumi Provider for Defang — Take your app from Docker Compose to a secure and scalable cloud deployment with Pulumi.

The Defang Pulumi Provider is available in most pulumi languages.

• JavaScript/TypeScript: @defang-io/pulumi-defang
• Python: pulumi-defang
• Go: github.com/DefangLabs/pulumi-defang/sdk/v1/go/defang
• .NET: DefangLabs.Defang
• Java: Coming soon

Installing the Pulumi Plugin directly

pulumi plugin install resource defang --server github://api.github.com/DefangLabs

Authentication

Authenticating with Defang

Sign up for Defang with your Github account.

Authenticating in Github Actions workflows

When run in a Github Actions workflow, the Defang Pulumi Provider will automatically use environment varialbes Github providew to authenticate your Github user with Defang if you give your workflow the appropriate permissions. Defang use the ACTIONS_ID_TOKEN_REQUEST_URL and ACTIONS_ID_TOKEN_REQUEST_TOKEN env vars.

Authenticating with defang token

You can run defang token --expires 30d out of band with a reasonable duration and you can store the result in DEFANG_ACCESS_TOKEN.

Authenticating with your cloud provider

You will also need to authenticate with your cloud provider.

• For AWS, there are many ways to authenticate
  • Use the aws-actions/configure-aws-credentials Github Action
  • Use AWS Access Keys by setting the AWS_ACCESS_KEY_ID, and AWS_ACCESS_KEY_SECRET env vars.
• For Digital Ocean, you will need to set the following env vars:
  • DIGITALOCEAN_TOKEN
  • SPACES_ACCESS_KEY_ID
  • SPACES_SECRET_ACCESS_KEY
• For Google Cloud, you may wish to use the google-github-actions/auth Github Action

Example usage

You can find complete working TypeScript, Python, Go, .NET, and Yaml code samples in the ./examples directory, and some example snippets below:

import * as pulumi from "@pulumi/pulumi";
import * as defang from "@defang-io/pulumi-defang";

const myProject = new defang.Project("myProject", {
    providerID: "aws",
    configPaths: ["compose.yaml"],
});
export const output = {
    albArn: myProject.albArn,
    etag: myProject.etag,
};

import pulumi
import pulumi_defang as defang

my_project = defang.Project("myProject",
    provider_id="aws",
    config_paths=["compose.yaml"])
pulumi.export("output", {
    "albArn": my_project.alb_arn,
    "etag": my_project.etag,
})

package main

import (
	"example.com/pulumi-defang/sdk/go/defang"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myProject, err := defang.NewProject(ctx, "myProject", &defang.ProjectArgs{
			ProviderID: pulumi.String("aws"),
			ConfigPaths: pulumi.StringArray{
				pulumi.String("compose.yaml"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("output", pulumi.StringMap{
			"albArn": myProject.AlbArn,
			"etag":   myProject.Etag,
		})
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Defang = DefangLabs.Defang;

return await Deployment.RunAsync(() =>
{
    var myProject = new Defang.Project("myProject", new()
    {
        ProviderID = "aws",
        ConfigPaths = new[]
        {
            "./compose.yaml",
        },
    });

    return new Dictionary<string, object?>
    {
        ["output"] =
        {
            { "albArn", myProject.AlbArn },
            { "etag", myProject.Etag },
        },
    };
});

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
    defang:Project:
        providerID: aws
        configPaths:
            - ./compose.yaml

Using Pulumi Cloud

Defang runs the Pulumi CLI in your cloud account. You can use Pulumi Cloud to manage the Pulumi resources which Defang creates by setting the following environment variables:

• DEFANG_PULUMI_BACKEND=pulumi-cloud
• PULUMI_ACCESS_TOKEN

Reference

For detailed reference documentation, please visit the Pulumi registry.