Skip to content

Commit

Permalink
Updating readme (#479)
Browse files Browse the repository at this point in the history
### Summary
- Updating description, PSP is much more now than it was
- Adding a point on how to use PSP + Java (Tested locally against a
revstack)
- Update template link in test to prevent collisions (You can't have
repeating repo links as template sources)
- Fixes: #380

---------

Co-authored-by: Komal <[email protected]>
  • Loading branch information
IaroslavTitov and komalali authored Dec 19, 2024
1 parent c7a6c05 commit 125de76
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 32 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,13 @@
[![PkgGoDev](https://pkg.go.dev/badge/github.com/pulumi/pulumi-pulumiservice/sdk/go/pulumiservice)](https://pkg.go.dev/github.com/pulumi/pulumi-pulumiservice/sdk/go)
[![License](https://img.shields.io/npm/l/%40pulumi%2Fpulumiservice.svg)](https://github.com/pulumi/pulumi-pulumiservice/blob/main/LICENSE)

A Pulumi Resource Provider for The Pulumi Service.
Pulumi Service Provider for creating Pulumi Cloud resources.

The Pulumi Service Provider is built on top of the [Pulumi Service REST API](https://pulumi.com/docs/reference/service-rest-api) which is another feature available to our customers to programmatically configuring the Pulumi Service. The Pulumi Service REST API includes functionality to interact with and manipulate any kind of metadata managed by Pulumi. That includes Projects and Stacks, Previews and Updates, Organizations and Audit Logs. We have already seen Cloud Engineering teams using the Pulumi REST API to build all sorts of custom functionality. These new capabilities are especially powerful when used in combination with the [Automation API](https://pulumi.com/automation).
The Pulumi Service Provider (PSP) is built on top of the [Pulumi Cloud REST API](https://www.pulumi.com/docs/pulumi-cloud/reference/cloud-rest-api/), allowing Pulumi customers to create Pulumi Cloud resources using Pulumi programs. That includes Stacks, Environments, Teams, Tokens, Webhooks, Tags, Deployment Settings, Deployment Schedules and much more! Pulumi Service Provider is especially powerful when used in combination with the [Automation API](https://pulumi.com/automation).

#### Supported Resources
For a full list of supported resources, visit the [Pulumi Registry](https://www.pulumi.com/registry/packages/pulumiservice/). For the REST API reference documentation, visit [Pulumi Cloud API Documentation](https://www.pulumi.com/docs/pulumi-cloud/reference/cloud-rest-api/).

- [Webhooks](https://pulumi.com/docs/intro/pulumi-service/webhooks)
- [Teams](https://pulumi.com/docs/intro/pulumi-service/teams)
- You can grant a team access to stacks via the `TeamStackPermission` resource
- [StackTags](https://pulumi.com/docs/reference/cli/pulumi_stack_tag)
- [AccessTokens](https://pulumi.com/docs/intro/pulumi-service/accounts)

For reference documentation, visit the [Pulumi Service API Documentation](https://www.pulumi.com/registry/packages/pulumiservice/api-docs/) on the [Pulumi Registry](https://www.pulumi.com/registry/packages/pulumiservice/)
For now, PSP is in public preview, but we're working on releasing v1.0 in the near future.

## Installing

Expand Down Expand Up @@ -53,6 +47,20 @@ To use from .NET, install using `dotnet add package`:

$ dotnet add package Pulumi.PulumiService

### Java

To use from Java, add an entry to your `build.gradle` file:

$ implementation 'com.pulumi:pulumiservice:%Fill in latest version from the badge up top%'

Or to your `pom.xml` file:

$ <dependency>
$ <groupId>com.pulumi</groupId>
$ <artifactId>pulumiservice</artifactId>
$ <version>%Fill in latest version from the badge up top%</version>
$ </dependency>

## Setup

Ensure that you have ran `pulumi login`. Run `pulumi whoami` to verify that you are logged in.
Expand Down Expand Up @@ -96,8 +104,3 @@ export const members = team.members;
```

Check out the [examples/](examples/) directory for more examples.

[1]: https://pulumi.com/registry/packages/pulumiservice/api-docs/provider
[2]: https://www.pulumi.com/docs/intro/pulumi-service/accounts/#access-tokens
[3]: https://www.pulumi.com/docs/reference/service-rest-api
[4]: https://www.pulumi.com/docs/guides/self-hosted/
4 changes: 2 additions & 2 deletions examples/yaml-template-sources/Pulumi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ resources:
properties:
organizationName: service-provider-test-org
sourceName: bootstrap-${digits}
sourceURL: "https://github.com/pulumi/pulumi-pulumiservice"
sourceURL: "https://github.com/pulumi/pulumi"
destination:
url: "https://github.com/pulumi/pulumi-pulumiservice"
url: "https://github.com/pulumi/pulumi"
33 changes: 18 additions & 15 deletions sdk/python/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 125de76

Please sign in to comment.