Pulumi Lagoon Provider — Python SDK

A Pulumi provider for managing Lagoon resources as infrastructure-as-code.

Installation

pip install pulumi-lagoon

Configuration

pulumi config set lagoon:apiUrl https://api.lagoon.example.com/graphql
pulumi config set --secret lagoon:token YOUR_TOKEN

Or via environment variables:

export LAGOON_API_URL=https://api.lagoon.example.com/graphql
export LAGOON_TOKEN=YOUR_TOKEN

Supported Resources

Resource	Description
`Project`	Lagoon projects (applications/sites)
`Environment`	Environments (branch/PR deployments)
`Variable`	Project and environment variables
`DeployTarget`	Kubernetes cluster deploy targets
`DeployTargetConfig`	Branch-pattern routing to deploy targets
`NotificationSlack`	Slack deployment notifications
`NotificationRocketChat`	RocketChat deployment notifications
`NotificationEmail`	Email deployment notifications
`NotificationMicrosoftTeams`	Microsoft Teams deployment notifications
`ProjectNotification`	Link notifications to projects
`Task`	Advanced task definitions (command and image types)
`Group`	Groups for organizing projects and users
`Route`	API-managed routes (requires Lagoon v2.29.0+)
`ProjectAutogeneratedRouteConfig`	Autogenerated route settings at project level
`EnvironmentAutogeneratedRouteConfig`	Autogenerated route settings at environment level

Usage

import pulumi
from pulumi_lagoon import Project, Environment, Variable, Group  # top-level re-exports
# The submodule path also works: from pulumi_lagoon.lagoon import ...

project = Project("my-site",
    name="my-drupal-site",
    git_url="git@github.com:org/repo.git",
    deploytarget_id=1,
    production_environment="main",
    branches="^(main|develop|stage)$",
)

prod_env = Environment("production",
    name="main",
    project_id=project.lagoon_id,
    deploy_type="branch",
    deploy_base_ref="main",
    environment_type="production",
)

db_config = Variable("db-host",
    name="DATABASE_HOST",
    value="mysql.production.example.com",
    project_id=project.lagoon_id,
    environment_id=prod_env.lagoon_id,
    scope="runtime",
)

team = Group("my-team",
    name="my-team",
)

pulumi.export("project_id", project.lagoon_id)

Importing Existing Resources

pulumi import lagoon:lagoon:Project my-site 123
pulumi import lagoon:lagoon:Environment prod-env 123:main
pulumi import lagoon:lagoon:Variable api-key 123::API_KEY
pulumi import lagoon:lagoon:Group my-team my-team

Multi-Language Support

This provider also has SDKs for TypeScript/JavaScript, Go, and .NET/C#.

Documentation

License

Apache License 2.0

Development Status
- 4 - Beta
Intended Audience
- Developers
- System Administrators
Programming Language
- Python :: 3
Topic
- System :: Systems Administration

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulumi_lagoon-0.5.3.tar.gz (32.4 kB view details)

Uploaded Jul 22, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pulumi_lagoon-0.5.3-py3-none-any.whl (59.4 kB view details)

Uploaded Jul 22, 2026 Python 3

File details

Details for the file pulumi_lagoon-0.5.3.tar.gz.

File metadata

Download URL: pulumi_lagoon-0.5.3.tar.gz
Upload date: Jul 22, 2026
Size: 32.4 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pulumi_lagoon-0.5.3.tar.gz
Algorithm	Hash digest
SHA256	`835fa44d586a07b2658315d4646c6a2e4b0c2600672d54366ce7f5a80df8f9d3`
MD5	`f49fff8f826c78aa1afb7074d5cd3b7c`
BLAKE2b-256	`25f74d82328c9d1536c01bcc0536b409165e1738ef92ba606ee89963ae4cd235`

See more details on using hashes here.

Provenance

The following attestation bundles were made for pulumi_lagoon-0.5.3.tar.gz:

Publisher: publish.yml on tag1consulting/pulumi-lagoon-provider

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: pulumi_lagoon-0.5.3.tar.gz
- Subject digest: 835fa44d586a07b2658315d4646c6a2e4b0c2600672d54366ce7f5a80df8f9d3
- Sigstore transparency entry: 2216059159
- Sigstore integration time: Jul 22, 2026
Source repository:
- Permalink: tag1consulting/pulumi-lagoon-provider@4bb8e222b68c47d3d68889d92d604631b686c9bc
- Branch / Tag: refs/tags/v0.5.3
- Owner: https://github.com/tag1consulting
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@4bb8e222b68c47d3d68889d92d604631b686c9bc
- Trigger Event: release