Pulumi - Infrastructure as Code in any programming language. Build infrastructure intuitively on any cloud using familiar languages 🚀
Go to file
Kyle Dixler 13e584ba91
[sdkgen/python] revert changes introducing `_configure` (#14427)
<!--- 
Thanks so much for your contribution! If this is your first time
contributing, please ensure that you have read the
[CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md)
documentation.
-->

# Description

<!--- Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context. -->

Fixes https://github.com/pulumi/pulumi/issues/14418
Reopens https://github.com/pulumi/pulumi/issues/12546

This removes the `_configure()` ResourceArgs helper method as it has
caused a number of issues (linked below).

`_configure()` was added in order to support initializing default values
sdk side for python. This has led to the following PRs being merged to
address unexpected bugs.

## Overview of fixes:

It will be quite hard to demonstrate without examples, so I will give an
example of the code and describe its short comings:

---
- https://github.com/pulumi/pulumi/issues/14418

```python
args = MyArgs() # fails as required argument foo not provided
args.foo = "Hello, World!"
```

---
- https://github.com/pulumi/pulumi/pull/14235
Supporting `imageName` and `image_name`
```python
def _configure(...
        image_name, # required
        ...):
    ...

# This should not error, but errors.
_configure(imageName="debian")
```

---
- https://github.com/pulumi/pulumi/pull/14281

```python
def _configure(...
        image_name, # required
        ...
        **kwargs):
    ...

# This should not fail, but fails as `image_name` is not provided
_configure(imageName="debian")
```

---
- https://github.com/pulumi/pulumi/pull/14014

```python
class Thing:
    def __init__(self,
                ...
                # Optional
                certmanager=None,
                ...):
        ...
        Thing._configure(
                ...
                certmanager=None,
                ...)
        ...
    def _configure(...):
        ...
            # This block runs when certmanager = None, but should not.
            if not isinstance(certmanager, ProviderCertmanagerArgs):
                certmanager = certmanager or {}
                def _setter(key, value):
                    certmanager[key] = value
                ProviderCertmanagerArgs._configure(_setter, **certmanager)
        ...
Provider()
```

---
- https://github.com/pulumi/pulumi/pull/14321

```python
registry_info=accessToken.apply(get_registry_info)

# Build and publish the image.
image = Image(
    'my-image',
    build=DockerBuildArgs(
        context='app',
    ),
    image_name=image_name,
    # Note that this is an Output.
    registry=registry_info,
)

            # registry is not None and it is not an instance of RegistryArgs, so we fall into the if, thinking it is a dict, but it is an Output.

            if registry is not None and not isinstance(registry, RegistryArgs):
                registry = registry or {}
                def _setter(key, value):
                    registry[key] = value
                RegistryArgs._configure(_setter, **registry)
            __props__.__dict__["registry"] = registry
```

---
- https://github.com/pulumi/pulumi/pull/14318

```python
            # foo.core.v1.PodArgs may be an external type and may not be upgraded to have _configure() and will fail, but should not.
            if pod is not None and not isinstance(pod, foo.core.v1.PodArgs):
                pod = pod or {}
                def _setter(key, value):
                    pod[key] = value
                pulumi_kubernetes.core.v1.PodArgs._configure(_setter, **pod)
```

## Checklist

- [x] I have run `make tidy` to update any new dependencies
- [x] I have run `make lint` to verify my code passes the lint check
  - [x] I have formatted my code using `gofumpt`

<!--- Please provide details if the checkbox below is to be left
unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my
feature works
<!--- 
User-facing changes require a CHANGELOG entry.
-->
- [x] I have run `make changelog` and committed the
`changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the
Pulumi Cloud,
then the service should honor older versions of the CLI where this
change would not exist.
You must then bump the API version in
/pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi
Cloud API version
<!-- @Pulumi employees: If yes, you must submit corresponding changes in
the service repo. -->
2023-10-27 22:28:41 +00:00
.devcontainer Update pulumictl 2023-06-29 11:09:56 +01:00
.github Actually disable plugin acquisition (#14134) 2023-10-14 08:32:43 +00:00
.gitpod Update pulumictl 2023-06-29 11:09:56 +01:00
.vscode Remove experimentalWorkspaceModule from vscode settings 2023-03-09 21:00:00 +00:00
build [config] Clean up implementation (#13814) 2023-10-09 04:51:21 +00:00
changelog [sdkgen/python] revert changes introducing `_configure` (#14427) 2023-10-27 22:28:41 +00:00
cmd/pulumi-test-language Changelog and go.mod updates for v3.91.0 (#14411) 2023-10-26 12:19:55 +00:00
coverage Toward replacing MSBuild with make+bash on Windows (#8617) 2022-01-07 22:27:14 -05:00
developer-docs Typos fixed in implementers-guide.md file (#14288) 2023-10-23 15:26:55 +00:00
docker Cleanup of all docker operations since moving to pulumi/pulumi-docker-containers (#8252) 2021-10-26 20:37:33 +03:00
pkg [sdkgen/python] revert changes introducing `_configure` (#14427) 2023-10-27 22:28:41 +00:00
proto Update grpc-tools and use grpc_js option rather than sed (#14426) 2023-10-27 18:14:20 +00:00
scripts Temporary changes to unblock v3.88.1 release (#14163) 2023-10-11 22:58:47 +00:00
sdk Update grpc-tools and use grpc_js option rather than sed (#14426) 2023-10-27 18:14:20 +00:00
tests Changelog and go.mod updates for v3.91.0 (#14411) 2023-10-26 12:19:55 +00:00
.dockerignore Add a Dockerfile for the Pulumi CLI 2018-09-29 11:48:21 -07:00
.envrc.template fix: Allows for parallel pulumi programs to run in the node runtime 2022-10-13 07:15:25 -04:00
.gitignore nodejs pcl components, initial commit 2023-03-14 16:17:14 +01:00
.gitpod.yml Move `PULUMI_ROOT` to `$HOME/.pulumi-dev` (#8512) 2021-12-15 12:32:41 -08:00
.golangci.yml Increase nakedret limit to 60 2023-06-28 13:55:00 +02:00
.goreleaser.yml Make language-python it's own module (#13819) 2023-08-31 16:35:21 +00:00
.readthedocs.yaml Bump the RTD Python version down to 3.6. 2021-08-25 15:23:46 -07:00
.version Freeze v3.91.0 (#14408) 2023-10-26 01:27:28 +00:00
.yarnrc Pass --network-concurrency 1 to yarn 2018-01-29 11:49:42 -08:00
CHANGELOG.md Changelog and go.mod updates for v3.91.0 (#14411) 2023-10-26 12:19:55 +00:00
CODE-OF-CONDUCT.md Update to "learning in public" on CoC 2021-07-06 11:03:19 -05:00
CONTRIBUTING.md Policy remediations feature (#14080) 2023-10-09 18:31:17 +00:00
LICENSE Remove appendix from LICENSE 2023-03-01 16:43:41 +00:00
Makefile Makefile: allow SDKSs to be overridden (#14280) 2023-10-18 17:16:16 +00:00
README.md docs: make variable declaration more consistency (#13834) 2023-08-31 11:12:22 +00:00
codecov.yml sdk/go: Add pulumix subpackage (#13509) 2023-08-28 15:38:23 +00:00
youtube_preview_image.png Make youtube preview smaller 2020-05-15 09:52:23 -07:00

README.md

Slack GitHub Discussions NPM version Python version NuGet version GoDoc License Gitpod ready-to-code

Pulumi's Infrastructure as Code SDK is the easiest way to build and deploy infrastructure, of any architecture and on any cloud, using programming languages that you already know and love. Code and ship infrastructure faster with your favorite languages and tools, and embed IaC anywhere with Automation API.

Simply write code in your favorite language and Pulumi automatically provisions and manages your resources on AWS, Azure, Google Cloud Platform, Kubernetes, and 120+ providers using an infrastructure-as-code approach. Skip the YAML, and use standard language features like loops, functions, classes, and package management that you already know and love.

For example, create three web servers:

const aws = require("@pulumi/aws");
const sg = new aws.ec2.SecurityGroup("web-sg", {
    ingress: [{ protocol: "tcp", fromPort: 80, toPort: 80, cidrBlocks: ["0.0.0.0/0"] }],
});
for (let i = 0; i < 3; i++) {
    new aws.ec2.Instance(`web-${i}`, {
        ami: "ami-7172b611",
        instanceType: "t2.micro",
        vpcSecurityGroupIds: [sg.id],
        userData: `#!/bin/bash
            echo "Hello, World!" > index.html
            nohup python -m SimpleHTTPServer 80 &`,
    });
}

Or a simple serverless timer that archives Hacker News every day at 8:30AM:

const aws = require("@pulumi/aws");

const snapshots = new aws.dynamodb.Table("snapshots", {
    attributes: [{ name: "id", type: "S", }],
    hashKey: "id", billingMode: "PAY_PER_REQUEST",
});

aws.cloudwatch.onSchedule("daily-yc-snapshot", "cron(30 8 * * ? *)", () => {
    require("https").get("https://news.ycombinator.com", res => {
        let content = "";
        res.setEncoding("utf8");
        res.on("data", chunk => content += chunk);
        res.on("end", () => new aws.sdk.DynamoDB.DocumentClient().put({
            TableName: snapshots.name.get(),
            Item: { date: Date.now(), content },
        }).promise());
    }).end();
});

Many examples are available spanning containers, serverless, and infrastructure in pulumi/examples.

Pulumi is open source under the Apache 2.0 license, supports many languages and clouds, and is easy to extend. This repo contains the pulumi CLI, language SDKs, and core Pulumi engine, and individual libraries are in their own repos.

Welcome

  • Get Started with Pulumi: Deploy a simple application in AWS, Azure, Google Cloud, or Kubernetes using Pulumi.

  • Learn: Follow Pulumi learning pathways to learn best practices and architectural patterns through authentic examples.

  • Examples: Browse several examples across many languages, clouds, and scenarios including containers, serverless, and infrastructure.

  • Docs: Learn about Pulumi concepts, follow user-guides, and consult the reference documentation.

  • Registry: Find the Pulumi Package with the resources you need. Install the package directly into your project, browse the API documentation, and start building.

  • Pulumi Roadmap: Review the planned work for the upcoming quarter and a selected backlog of issues that are on our mind but not yet scheduled.

  • Community Slack: Join us in Pulumi Community Slack. All conversations and questions are welcome.

  • GitHub Discussions: Ask questions or share what you're building with Pulumi.

Getting Started

Watch the video

See the Get Started guide to quickly get started with Pulumi on your platform and cloud of choice.

Otherwise, the following steps demonstrate how to deploy your first Pulumi program, using AWS Serverless Lambdas, in minutes:

  1. Install:

    To install the latest Pulumi release, run the following (see full installation instructions for additional installation options):

    $ curl -fsSL https://get.pulumi.com/ | sh
    
  2. Create a Project:

    After installing, you can get started with the pulumi new command:

    $ mkdir pulumi-demo && cd pulumi-demo
    $ pulumi new hello-aws-javascript
    

    The new command offers templates for all languages and clouds. Run it without an argument and it'll prompt you with available projects. This command created an AWS Serverless Lambda project written in JavaScript.

  3. Deploy to the Cloud:

    Run pulumi up to get your code to the cloud:

    $ pulumi up
    

    This makes all cloud resources needed to run your code. Simply make edits to your project, and subsequent pulumi ups will compute the minimal diff to deploy your changes.

  4. Use Your Program:

    Now that your code is deployed, you can interact with it. In the above example, we can curl the endpoint:

    $ curl $(pulumi stack output url)
    
  5. Access the Logs:

    If you're using containers or functions, Pulumi's unified logging command will show all of your logs:

    $ pulumi logs -f
    
  6. Destroy your Resources:

    After you're done, you can remove all resources created by your program:

    $ pulumi destroy -y
    

To learn more, head over to pulumi.com for much more information, including tutorials, examples, and details of the core Pulumi CLI and programming model concepts.

Platform

Languages

Language Status Runtime
JavaScript Stable Node.js 16+
TypeScript Stable Node.js 16+
Python Stable Python 3.7+
Go Stable Go supported versions
.NET (C#/F#/VB.NET) Stable .NET Core 3.1+
Java Public Preview JDK 11+
YAML Public Preview n/a

EOL Releases

The Pulumi CLI v1 and v2 are no longer supported. If you are not yet running v3, please consider migrating to v3 to continue getting the latest and greatest Pulumi has to offer! 💪

Clouds

Visit the Registry for the full list of supported cloud and infrastructure providers.

Contributing

Visit CONTRIBUTING.md for information on building Pulumi from source or contributing improvements.