Metadata-Version: 2.1
Name: pulumi
Version: 0.17.2.dev1551905838
Summary: Pulumi's Python SDK
Home-page: https://github.com/pulumi/pulumi
Author: UNKNOWN
Author-email: UNKNOWN
License: Apache 2.0
Platform: UNKNOWN
Requires-Dist: protobuf (>=3.6.0)
Requires-Dist: grpcio (>=1.9.1)

|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 <https://pulumi.io/reference/aws.html>`__,
`Azure <https://pulumi.io/reference/azure.html>`__, `Google Cloud
Platform <https://pulumi.io/reference/gcp.html>`__, and/or
`Kubernetes <https://pulumi.io/reference/kubernetes.html>`__ resources,
using an
`infrastructure-as-code <https://en.wikipedia.org/wiki/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:

.. code:: typescript

   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:

.. code:: typescript

   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 <https://github.com/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 <#getting-started>`__: get up and running quickly.

-  `Tutorials <https://pulumi.io/quickstart>`__: walk through end-to-end
   workflows for creating containers, serverless functions, and other
   cloud services and infrastructure.

-  `Examples <https://github.com/pulumi/examples>`__: browse a number of
   useful examples across many languages, clouds, and scenarios
   including containers, serverless, and infrastructure.

-  `A Tour of Pulumi <https://pulumi.io/tour>`__: 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 <https://pulumi.io/reference>`__: 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 <https://slack.pulumi.io>`__: join us over at our
   community Slack channel. Any and all discussion or questions are
   welcome.

-  `Roadmap <https://github.com/pulumi/pulumi/wiki/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 <https://pulumi.io/install>`__ for
   additional installation options):

   .. code:: bash

      $ curl -fsSL https://get.pulumi.com/ | sh

2. `Configure your Cloud
   Provider <https://pulumi.io/install#cloud-configuration>`__ so that
   Pulumi can deploy into it.

3. **Create a Project**:

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

   .. code:: bash

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

   .. code:: bash

      $ pulumi update

   This makes all cloud resources needed to run your code. Simply make
   edits to your project, and subsequent ``pulumi update``\ s 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:

   .. code:: bash

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

   .. code:: bash

      $ pulumi logs -f

7. **Destroy your Resources**:

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

   .. code:: bash

      $ pulumi destroy -y

Please head on over to `the project website <https://pulumi.io>`__ for
much more information, including
`tutorials <https://pulumi.io/quickstart>`__,
`examples <https://github.com/pulumi/examples>`__, and `an interactive
tour <https://pulumi.io/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 <./sdk/nodejs>`__ Stable  Node.js 6.x-10.x
\  `TypeScript <./sdk/nodejs>`__ Stable  Node.js 6.x-10.x
\  `Python <./sdk/python>`__     Preview Python 2.7
\  `Go <./sdk/go>`__             Preview Go 1.x
== ============================= ======= ================

Clouds
~~~~~~

== ================================================================ ======= =====================================================================
\  Cloud                                                            Status  Docs
== ================================================================ ======= =====================================================================
\  `Amazon Web Services <https://github.com/pulumi/pulumi-aws>`__   Stable  `Docs <https://pulumi.io/reference/pkg/nodejs/@pulumi/aws/>`__
\  `Microsoft Azure <https://github.com/pulumi/pulumi-azure>`__     Preview `Docs <https://pulumi.io/reference/pkg/nodejs/@pulumi/azure/>`__
\  `Google Cloud Platform <https://github.com/pulumi/pulumi-gcp>`__ Preview `Docs <https://pulumi.io/reference/pkg/nodejs/@pulumi/gcp/>`__
\  `Kubernetes <https://github.com/pulumi/pulumi-kubernetes>`__     Preview `Docs <https://pulumi.io/reference/pkg/nodejs/@pulumi/kubernetes/>`__
== ================================================================ ======= =====================================================================

Libraries
~~~~~~~~~

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

============================ ======= ========================================================================= ==================================================================================
Library                      Status  Docs                                                                      Repo
============================ ======= ========================================================================= ==================================================================================
AWS Serverless               Preview `Docs <https://pulumi.io/reference/pkg/nodejs/@pulumi/aws-serverless/>`__ `pulumi/pulumi-aws-serverless <https://github.com/pulumi/pulumi-aws-serverless>`__
AWS Infrastructure           Preview `Docs <https://pulumi.io/reference/pkg/nodejs/@pulumi/aws-infra/>`__      `pulumi/pulumi-aws-infra <https://github.com/pulumi/pulumi-aws-infra>`__
Pulumi Multi-Cloud Framework Preview `Docs <https://pulumi.io/reference/pkg/nodejs/@pulumi/cloud/>`__          `pulumi/pulumi-cloud <https://github.com/pulumi/pulumi-cloud>`__
============================ ======= ========================================================================= ==================================================================================

Contributing
------------

Please See
`CONTRIBUTING.md <https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md>`__
for information on building Pulumi from source or contributing
improvments.

.. |Slack| image:: https://pulumi.io/images/badges/slack.svg
   :target: https://slack.pulumi.io
.. |NPM version| image:: https://badge.fury.io/js/%40pulumi%2Fpulumi.svg
   :target: https://npmjs.com/package/@pulumi/pulumi
.. |Python version| image:: https://badge.fury.io/py/pulumi.svg
   :target: https://pypi.org/project/pulumi
.. |GoDoc| image:: https://godoc.org/github.com/pulumi/pulumi?status.svg
   :target: https://godoc.org/github.com/pulumi/pulumi
.. |License| image:: https://img.shields.io/npm/l/%40pulumi%2Fpulumi.svg
   :target: https://github.com/pulumi/pulumi/blob/master/LICENSE
.. |Linux x64 Build Status| image:: https://travis-ci.com/pulumi/pulumi.svg?token=cTUUEgrxaTEGyecqJpDn&branch=master
   :target: https://travis-ci.com/pulumi/pulumi
.. |Windows x64 Build Status| image:: https://ci.appveyor.com/api/projects/status/uqrduw6qnoss7g4i?svg=true&branch=master
   :target: https://ci.appveyor.com/project/pulumi/pulumi


