pulumi

command module
v0.17.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

README

Slack NPM version Python version GoDoc License

Pulumi's Cloud Native SDK is the easiest way to create and deploy cloud programs 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:

let cloud = require("@pulumi/cloud");
let snapshots = new cloud.Table("snapshots");
cloud.timer.daily("daily-yc-snapshot", { hourUTC: 8, minuteUTC: 30 }, () => {
    let req = require("https").get("https://news.ycombinator.com", (res) => {
        let content = "";
        res.setEncoding("utf8");
        res.on("data", (chunk) => { content += chunk });
        res.on("end", () => {
           snapshots.insert({ date: Date.now(), content: content });
        });
    });
    req.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.

  • A Tour of Pulumi: interactively walk through the core Pulumi concepts, one at a time, covering the entire CLI and programming model surface area in a handful of bite-sized chunks.

  • 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

Follow these steps 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. Configure your Cloud Provider so that Pulumi can deploy into it.

  3. Create a Project:

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

    $ 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.

  4. Deploy to the Cloud:

    Run pulumi update to get your code to the cloud:

    $ pulumi update
    

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

  5. 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)
    
  6. Access the Logs:

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

    $ pulumi logs -f
    
  7. Destroy your Resources:

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

    $ pulumi destroy -y
    

Please head on over to the project website for much more information, including tutorials, examples, and an interactive tour 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 6.x-10.x
TypeScript Stable Node.js 6.x-10.x
Python Preview Python 2.7
Go Preview Go 1.x

Clouds

Cloud Status Docs
Amazon Web Services Stable Docs
Microsoft Azure Preview Docs
Google Cloud Platform Preview Docs
Kubernetes Preview Docs

Libraries

There are several libraries that encapsulate best practices and common patterns:

Library Status Docs Repo
AWS Serverless Preview Docs pulumi/pulumi-aws-serverless
AWS Infrastructure Preview Docs pulumi/pulumi-aws-infra
Pulumi Multi-Cloud Framework Preview Docs pulumi/pulumi-cloud

Contributing

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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
apitype
Package apitype contains the full set of "exchange types" that are serialized and sent across separately versionable boundaries, including service APIs, plugins, and file formats.
Package apitype contains the full set of "exchange types" that are serialized and sent across separately versionable boundaries, including service APIs, plugins, and file formats.
apitype/migrate
Package migrate is responsible for converting to and from the various API type versions that are in use in Pulumi.
Package migrate is responsible for converting to and from the various API type versions that are in use in Pulumi.
backend
Package backend encapsulates all extensibility points required to fully implement a new cloud provider.
Package backend encapsulates all extensibility points required to fully implement a new cloud provider.
graph
Package graph defines resource graphs.
Package graph defines resource graphs.
graph/dotconv
Package dotconv converts a resource graph into its DOT digraph equivalent.
Package dotconv converts a resource graph into its DOT digraph equivalent.
resource/edit
Package edit contains functions suitable for editing a snapshot in-place.
Package edit contains functions suitable for editing a snapshot in-place.
resource/stack
Package stack contains the serialized and configurable state associated with an stack; or, in other words, a deployment target.
Package stack contains the serialized and configurable state associated with an stack; or, in other words, a deployment target.
tokens
Package tokens contains the core symbol and token types for referencing resources and related entities.
Package tokens contains the core symbol and token types for referencing resources and related entities.
util/rpcutil/rpcerror
Package rpcerror provides helper types and functions for dealing with errors that cross gRPC boundaries.
Package rpcerror provides helper types and functions for dealing with errors that cross gRPC boundaries.
sdk
nodejs/cmd/pulumi-language-nodejs
pulumi-language-nodejs serves as the "language host" for Pulumi programs written in NodeJS.
pulumi-language-nodejs serves as the "language host" for Pulumi programs written in NodeJS.
python/cmd/pulumi-language-python
pulumi-language-python serves as the "language host" for Pulumi programs written in Python.
pulumi-language-python serves as the "language host" for Pulumi programs written in Python.
tests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL