Skip to content

Commit 8d1865e

Browse files
document Pulumi Cloud integration
1 parent d979c37 commit 8d1865e

File tree

3 files changed

+29
-8
lines changed

3 files changed

+29
-8
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/DefangLabs/pulumi-defang?label=Version)
44

5-
The Pulumi provider for [Defang - a radically simpler way to develop, deploy, and debug cloud applications](https://defang.io). The easiest way to deploy your Docker Compose project to the cloud with Pulumi.
5+
The Pulumi Provider for [Defang](https://defang.io) — Take your app from Docker Compose to a secure and scalable cloud deployment with Pulumi.
66

77
## Installation
88

@@ -20,7 +20,7 @@ Sign up for [Defang](https://defang.io) with your Github account.
2020

2121
#### Authenticating in Github Actions workflows
2222

23-
When run in a Github Actions workflow, the Defang Pulumi provider will automatically use environment varialbes Github providew to authenticate your Github user with Defang if you give your workflow the [appropriate permissions](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#adding-permissions-settings). Defang use the `ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN` env vars.
23+
When run in a Github Actions workflow, the Defang Pulumi Provider will automatically use environment varialbes Github providew to authenticate your Github user with Defang if you give your workflow the [appropriate permissions](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#adding-permissions-settings). Defang use the `ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN` env vars.
2424

2525
#### Authenticating with `defang token`
2626

@@ -39,6 +39,13 @@ You will also need to authenticate with your cloud provider.
3939
- `SPACES_SECRET_ACCESS_KEY`
4040
* For Google Cloud, you may wish to use the [`google-github-actions/auth`](https://github.com/google-github-actions/auth) Github Action
4141

42+
## Using Pulumi Cloud
43+
44+
Defang runs the Pulumi CLI in your cloud account. You can use [Pulumi Cloud](https://www.pulumi.com/product/pulumi-cloud/) to manage the Pulumi resources which Defang creates by setting the following environment variables:
45+
46+
* `DEFANG_PULUMI_BACKEND=pulumi-cloud`
47+
* `PULUMI_ACCESS_TOKEN`
48+
4249
## Example usage
4350

4451
You can find working Go, Python, and TypeScript code samples in the [`./examples`](https://github.com/DefangLabs/pulumi-defang/tree/main/examples) directory.

docs/_index.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/DefangLabs/pulumi-defang?label=Version)
44

5-
The Pulumi provider for [Defang - a radically simpler way to develop, deploy, and debug cloud applications](https://defang.io). The easiest way to deploy your Docker Compose project to the cloud with Pulumi.
5+
The Pulumi Provider for [Defang](https://defang.io) — Take your app from Docker Compose to a secure and scalable cloud deployment with Pulumi.
66

77
## Installation
88

@@ -20,7 +20,7 @@ Sign up for [Defang](https://defang.io) with your Github account.
2020

2121
#### Authenticating in Github Actions workflows
2222

23-
When run in a Github Actions workflow, the Defang Pulumi provider will automatically use environment varialbes Github providew to authenticate your Github user with Defang if you give your workflow the [appropriate permissions](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#adding-permissions-settings). Defang use the `ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN` env vars.
23+
When run in a Github Actions workflow, the Defang Pulumi Provider will automatically use environment varialbes Github providew to authenticate your Github user with Defang if you give your workflow the [appropriate permissions](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#adding-permissions-settings). Defang use the `ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN` env vars.
2424

2525
#### Authenticating with `defang token`
2626

@@ -39,6 +39,13 @@ You will also need to authenticate with your cloud provider.
3939
- `SPACES_SECRET_ACCESS_KEY`
4040
* For Google Cloud, you may wish to use the [`google-github-actions/auth`](https://github.com/google-github-actions/auth) Github Action
4141

42+
## Using Pulumi Cloud
43+
44+
Defang runs the Pulumi CLI in your cloud account. You can use [Pulumi Cloud](https://www.pulumi.com/product/pulumi-cloud/) to manage the Pulumi resources which Defang creates by setting the following environment variables:
45+
46+
* `DEFANG_PULUMI_BACKEND=pulumi-cloud`
47+
* `PULUMI_ACCESS_TOKEN`
48+
4249
## Example usage
4350

4451
You can find working Go, Python, and TypeScript code samples in the [`./examples`](https://github.com/DefangLabs/pulumi-defang/tree/main/examples) directory.

docs/installation-configuration.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ layout: package
55
---
66
## Installation
77

8-
The Pulumi provider for [Defang] (https://defang.io) - the easiest way to deploy your Docker Compose project to the cloud with Pulumi.
8+
The Pulumi Provider for [Defang](https://defang.io) — Take your app from Docker Compose to a secure and scalable cloud deployment with Pulumi.
99

10-
The Defang Pulumi provider, is available in most pulumi languages.
10+
The Defang Pulumi Provider is available in most pulumi languages.
1111

1212
* JavaScript/TypeScript: [`@defang-io/pulumi-defang`](https://www.npmjs.com/package/@defang-io/pulumi-defang)
1313
* Python: [`pulumi-defang`](https://pypi.org/project/pulumi-defang/)
1414
* Go: [`github.com/DefangLabs/pulumi-defang/sdk/v1/go/defang`](https://github.com/DefangLabs/pulumi-defang)
1515
* Java: Coming soon
1616
* Dotnet: Coming soon
1717

18-
### Installing the pulumi plugin directly
18+
### Installing the Pulumi Plugin directly
1919
```
2020
pulumi plugin install resource defang --server github://api.github.com/DefangLabs
2121
```
@@ -28,7 +28,7 @@ Sign up for [Defang](https://defang.io) with your Github account.
2828

2929
#### Authenticating in Github Actions workflows
3030

31-
When run in a Github Actions workflow, the Defang Pulumi provider will automatically use environment varialbes Github providew to authenticate your Github user with Defang if you give your workflow the [appropriate permissions](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#adding-permissions-settings). Defang use the `ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN` env vars.
31+
When run in a Github Actions workflow, the Defang Pulumi Provider will automatically use environment varialbes Github providew to authenticate your Github user with Defang if you give your workflow the [appropriate permissions](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#adding-permissions-settings). Defang use the `ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN` env vars.
3232

3333
#### Authenticating with `defang token`
3434

@@ -128,3 +128,10 @@ config:
128128
129129
{{% /choosable %}}
130130
{{< /chooser >}}
131+
132+
## Using Pulumi Cloud
133+
134+
Defang runs the Pulumi CLI in your cloud account. You can use [Pulumi Cloud](https://www.pulumi.com/product/pulumi-cloud/) to manage the Pulumi resources which Defang creates by setting the following environment variables:
135+
136+
* `DEFANG_PULUMI_BACKEND=pulumi-cloud`
137+
* `PULUMI_ACCESS_TOKEN`

0 commit comments

Comments
 (0)