Go to file
Joe Duffy 12e5e46c73
Handle blank project names in 'new' (#5504)
The logic for validating prompted values in 'new' wasn't quite right,
leading to the possibility of creating Pulumi.yaml files with blank
project names.

This manifests in various ways and I've hit it a number of times
over the past few months because of the way we handle project/stack
name conflicts in 'new' -- which itself is a bit annoying too:

https://github.com/pulumi/pulumi/blob/master/pkg/cmd/pulumi/new.go#L206-L207

Because we substitue a default value of "", and because the prompting
logic assumed default values are always valid, we would skip validation
and therefore accept a blank Pulumi.yaml file.

This generates an invalid project which causes errors elsewhere, such as

    error: failed to load Pulumi project located at ".../Pulumi.yaml":
        project is missing a 'name' attribute

I hit this all the time with our getting started guide because I've
gone through it so many times and have leftover stacks from prior
run-throughs. I wouldn't be surprised if a lot of people hit this.

The solution here validates all values, including the default.

Note also that we failed to validate the value used by 'new --yes'
which meant you could bypass all validation by passing --yes, leading
to similar outcomes.

I've added a couple new tests for these cases. There is a risk we
depend on illegal default values somewhere which will now be rejected,
but that would seem strange, and assuming the tests pass, I would
assume that's not true. Let me know if that's wrong.

Fixes pulumi/pulumi#3255.
2020-10-05 13:40:24 -07:00
.github Updating the build ref for the docker images actions 2020-10-01 09:01:19 +01:00
build add initial pull-request workflow (#5276) 2020-09-09 13:37:03 -07:00
dist Bump the Go version in our containers to be latest v1.14.x version - our latest tested version 2020-09-25 15:10:46 +01:00
docker add analyzer policy to Docker images (#5495) 2020-10-01 16:11:55 -07:00
pkg Handle blank project names in 'new' (#5504) 2020-10-05 13:40:24 -07:00
scripts add master branch workflow (#5386) 2020-09-21 16:20:05 -07:00
sdk Handle blank project names in 'new' (#5504) 2020-10-05 13:40:24 -07:00
tests [sdk/python] Fix secret regression (#5496) 2020-10-01 14:57:51 -07:00
.appveyor.yml Upgrade to Go 1.14.x (#4697) 2020-05-28 12:01:33 +01:00
.dockerignore Add a Dockerfile for the Pulumi CLI 2018-09-29 11:48:21 -07:00
.gitignore update builds to handle new go mod layout 2020-03-18 16:41:23 -07:00
.golangci.yml add initial pull-request workflow (#5276) 2020-09-09 13:37:03 -07:00
.goreleaser.prerelease.yml add master branch workflow (#5386) 2020-09-21 16:20:05 -07:00
.goreleaser.yml prep for release (#5481) 2020-09-30 18:09:49 +01:00
.travis.yml revert builds back to travis (#5486) 2020-09-30 15:46:52 -07:00
.yarnrc Pass --network-concurrency 1 to yarn 2018-01-29 11:49:42 -08:00
build.proj Initial support for remote component construction. (#5280) 2020-09-07 19:33:55 -07:00
CHANGELOG.md Handle blank project names in 'new' (#5504) 2020-10-05 13:40:24 -07:00
CODE-OF-CONDUCT.md Adopt Contributor Covenant code of conduct 2018-05-30 11:01:52 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md 2020-06-23 15:52:43 -07:00
gcp-credentials.json.enc Add tests for templates (#3126) 2019-09-13 00:41:46 +02:00
LICENSE Relicense under Apache 2.0 2018-05-22 13:52:41 -07:00
Makefile revert builds back to travis (#5486) 2020-09-30 15:46:52 -07:00
README.md Add nuget badge to README (#5117) 2020-08-05 20:31:33 -07:00
tslint.json Enable 'use const' linter rule. (#405) 2017-10-10 14:50:55 -07:00
youtube_preview_image.png Make youtube preview smaller 2020-05-15 09:52:23 -07:00

Slack NPM version Python version NuGet version GoDoc License

Pulumi's Infrastructure as Code SDK is the easiest way to create and deploy cloud software that use containers, serverless functions, hosted services, and infrastructure, on any cloud.

Simply write code in your favorite language and Pulumi automatically provisions and manages your AWS, Azure, Google Cloud Platform, and/or Kubernetes resources, 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",
        securityGroups: [ sg.name ],
        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

  • Getting Started: get up and running quickly.

  • Tutorials: walk through end-to-end workflows for creating containers, serverless functions, and other cloud services and infrastructure.

  • Examples: browse a number of useful examples across many languages, clouds, and scenarios including containers, serverless, and infrastructure.

  • Reference Docs: read conceptual documentation, in addition to details on how to configure Pulumi to deploy into your AWS, Azure, or Google Cloud accounts, and/or Kubernetes cluster.

  • Community Slack: join us over at our community Slack channel. Any and all discussion or questions are welcome.

  • Roadmap: check out what's on the roadmap for the Pulumi project over the coming months.

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

CLI

Architecture Build Status
Linux/macOS x64 Linux x64 Build Status
Windows x64 Windows x64 Build Status

Languages

Language Status Runtime
JavaScript Stable Node.js 10+
TypeScript Stable Node.js 10+
Python Stable Python 3.6+
Go Stable Go 1.13.x
.NET (C#/F#/VB.NET) Stable .NET Core 3.1

Clouds

See Supported Clouds for the full list of supported cloud and infrastructure providers.

Contributing

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