tuttinator / pulumi-local

Thin wrapper script to use Pulumi with LocalStack

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pulumi CLI for LocalStack

This package provides the pulumilocal command, which is a thin wrapper around the pulumi command line interface to use Pulumi with LocalStack.

Installation

You can install the pulumilocal command via pip:

pip install pulumi-local

Prerequisites

Please make sure you have a LocalStack instance running on your local machine.

Usage

The pulumilocal command has the same usage as the pulumi command. For detailed usage, please refer to the man pages of pulumi -h.

For example, to deploy a Pulumi application to LocalStack:

pulumilocal up

How it works

When running a deployment command like pulumilocal up, the wrapper script creates a Pulumi.localstack.yaml config file with local endpoint definitions, and then deploys a Pulumi stack called localstack to your LocalStack instance on localhost.

Configurations

You can configure the following environment variables:

  • LOCALSTACK_HOSTNAME: Target host to use for connecting to LocalStack (default: localhost)
  • EDGE_PORT: Target port to use for connecting to LocalStack (default: 4566)
  • PULUMI_CMD: Name of the executable Pulumi command on the system PATH (default: pulumi)
  • PULUMI_STACK_NAME: Name of the Pulumi stack used to configure local endpoints (default: localstack)

Change Log

  • v0.4: Point pulumilocal.bat to the correct script
  • v0.3: Add apigatewayv2 service endpoint
  • v0.2: Add init command and add aws:region key by default
  • v0.1: Initial release

License

This software library is released under the Apache License, Version 2.0 (see LICENSE).

About

Thin wrapper script to use Pulumi with LocalStack

License:Apache License 2.0


Languages

Language:Python 91.7%Language:Makefile 8.0%Language:Batchfile 0.4%