Pulumi - Infrastructure as Code in any programming language. Build infrastructure intuitively on any cloud using familiar languages 🚀
Go to file
bors[bot] e48af89950
Merge #13289
13289: programgen(go): Handle conflicting names in imported packages r=abhinav a=abhinav

This fixes how programgen generates import statements
to handle conflicting imports when two imported packages
have the same name, e.g.

    github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ecs
    github.com/pulumi/pulumi-awsx/sdk/go/awsx/ecs

To do this, we add a fileImporter type that tracks these imports.
It prefers unnamed imports for packages unless one of the following is
true:

- the name of the package has already been used by another import
- the name of the package does not match the last component
  of the import path (e.g., `example.com/foo-go` with `package foo`).

If the name has already been used by another import,
it attempts the following in-order:

- Combine the last two path components of the import path
  into an identifier and use that if available.
  e.g., `awsxs3` from `sdk/go/awsx/s3`.
- Append a number to the package name and increment it
  until an unused name is found.
  e.g. `ecs2`, `ecs3`, and so on.

There's a change in how this information is tracked as well.
Previously, this was a pull approach: various calls returned
programImports objects which all got merged together.

This change switches to a push approach:
as code is generated and imports are requested,
they're submitted to the fileImporter which keeps track of them
until the next `Reset()` call.
The above also has a nice side effect of dropping a parameter.

Another change worth explicitly calling out:
Previously, getModOrAlias partially duplicated some of the logic
implemented in getPulumiImport, and used `mod`, `originalMod`
in a non-obvious way.
This generated incorrect imports like the following
(note the two `/aws` at the end):

    github.com/pulumi/pulumi-aws/sdk/v5/go/aws/aws

This change replicates more of the logic of getPulumiImport
(now called addPulumiImport) into this function,
and addresses the discrepancy in codegen caused by `mod`/`originalMod`.
The result leaves most existing code unchanged,
except in a couple existing cases where the resulting changes make sense
given the logic for named imports outlined above.

Resolves #11176

Co-authored-by: Abhinav Gupta <abhinav@pulumi.com>
2023-07-25 20:51:19 +00:00
.devcontainer Update pulumictl 2023-06-29 11:09:56 +01:00
.github ci(test): Fix setup-go caching 2023-07-06 11:59:22 -07: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 Fix makefiles 2023-05-26 11:00:45 +01:00
changelog programgen(go): Handle conflicting names in imported packages 2023-07-25 12:49:37 -07:00
coverage Toward replacing MSBuild with make+bash on Windows (#8617) 2022-01-07 22:27:14 -05:00
developer-docs Use slice.Prealloc instead of make([]T, 0, ...) 2023-06-29 11:27:50 +01:00
docker Cleanup of all docker operations since moving to pulumi/pulumi-docker-containers (#8252) 2021-10-26 20:37:33 +03:00
pkg programgen(go): Handle conflicting names in imported packages 2023-07-25 12:49:37 -07:00
proto [engine] Add support for source positions 2023-07-10 14:35:40 -07:00
scripts Add regression test for #13301 2023-07-11 16:22:15 -07:00
sdk Extend unknown providers test to cover Construct 2023-07-25 17:13:28 +01:00
tests chore: post-release go.mod updates 2023-07-20 22:54:09 +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 Plumb codegen rpc into nodejs 2023-05-25 14:56:45 +01:00
.readthedocs.yaml Bump the RTD Python version down to 3.6. 2021-08-25 15:23:46 -07:00
.version Lock .version for 3.76.0 release 2023-07-20 15:24:31 +01:00
.yarnrc Pass --network-concurrency 1 to yarn 2018-01-29 11:49:42 -08:00
CHANGELOG.md chore: changelog for v3.76.0 2023-07-20 22:52:35 +00:00
CODE-OF-CONDUCT.md Update to "learning in public" on CoC 2021-07-06 11:03:19 -05:00
CONTRIBUTING.md CONTRIBUTING: Clarify gofumpt further 2023-05-10 17:08:08 -07:00
LICENSE Remove appendix from LICENSE 2023-03-01 16:43:41 +00:00
Makefile ci: Track code coverage 2023-06-28 13:30:13 -07:00
README.md remove migrating to 2 link from readme 2023-05-19 19:43:42 -07:00
bors.toml bors: Drop lint requirement 2023-02-19 00:18:56 -08:00
codecov.yml ci: Track code coverage 2023-06-28 13:30:13 -07: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:

let aws = require("@pulumi/aws");
let 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.