Skip to content

Add no-cody deployment settings to Rest API docs #15353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/docs/pulumi-cloud/reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ The Pulumi Cloud REST API is organized into the following resource categories:
- [Resources Under Management](/docs/pulumi-cloud/reference/resources-under-management/) - Query managed resources
- [Schedules](/docs/pulumi-cloud/reference/schedules/) - Configure scheduled tasks
- [Services](/docs/pulumi-cloud/reference/services/) - Interact with service information
- [Stack Config](/docs/pulumi-cloud/reference/stack-config/) - Manage configuration settings for stacks
- [Stack Policy](/docs/pulumi-cloud/reference/stack-policy/) - Apply and manage policy on stacks
- [Stack Tags](/docs/pulumi-cloud/reference/stack-tags/) - Manage metadata tags on stacks
- [Stack Updates](/docs/pulumi-cloud/reference/stack-updates/) - Manage the update lifecycle for stacks
Expand Down
24 changes: 21 additions & 3 deletions content/docs/pulumi-cloud/reference/deployments/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -937,7 +937,9 @@ or with credentials:

### SourceContext

The source context contains information about where the source code for your project is located. Currently, only git repos are supported as a source.
The source context contains information about where the source code for your project is located. Currently, git repos or templates are supported as a source.

#### Git

```json
{
Expand All @@ -949,8 +951,6 @@ The source context contains information about where the source code for your pro
}
```

#### Properties

| Name | Type | Description |
|---------------|----------------|--------------------------------------------------|
| `git.repoURL` | string | **Optional.** URL of the git repository. |
Expand All @@ -959,6 +959,24 @@ The source context contains information about where the source code for your pro
| `git.commit` | string | **Optional.** Hash of the commit to deploy. Mutually exclusive with branch. |
| `git.gitAuth` | object | **Optional.** Authentication information for the git repo. |

#### Template

Using templates as the source for the deployment enables deploying Pulumi programs without having to manage the underlying IaC code.
Leverage [Stack Config](/docs/pulumi-cloud/reference/stack-config/) to manage configuration settings for these template based stacks, including environment settings and secrets management configuration.

```json
{
"template": {
"sourceUrl": "https://github.com/pulumi/templates/kubernetes-aws-yaml"
}
}
```

| Name | Type | Description |
|-------------------------|--------|-----------------------------------------------------------------------------|
| `template.sourceURL` | string | URL of the template. |
| `template.gitAuth` | object | **Optional.** Authentication information for templates hosted in git repos. |

### OperationContext

The operation context describes any context required for Pulumi operations to execute such as pre-run commands and environment variables.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/pulumi-cloud/reference/stack-config/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ menu:
weight: 20
---

Stack config endpoints allow you to manage configuration settings for your Pulumi stacks, including environment settings and secrets management configuration. If stack configuration is returned by the API, it used in place of the local stack config file (e.g. `Pulumi.[stack].yaml`).
Stack config endpoints allow you to manage configuration settings for your Pulumi stacks, including environment settings and secrets management configuration. If stack configuration is returned by the API, it is used in place of the local stack config file (e.g. `Pulumi.[stack].yaml`).

## Stack Config Operations

Expand Down
Loading