From 402372d1437bf1839eb2904597a63dfd0d61c7cf Mon Sep 17 00:00:00 2001 From: IaroslavTitov Date: Wed, 18 Dec 2024 14:20:40 -0700 Subject: [PATCH] Updating readme --- README.md | 33 ++++++++++--------- .../pulumi-resource-pulumiservice/schema.json | 2 +- sdk/python/README.md | 33 ++++++++++--------- 3 files changed, 37 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index f7cfa7f2..616b25a9 100644 --- a/README.md +++ b/README.md @@ -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 Service REST API](https://pulumi.com/docs/reference/service-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 Service API Documentation](https://www.pulumi.com/registry/packages/pulumiservice/api-docs/). -- [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 @@ -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: + + $ + $ com.pulumi + $ pulumiservice + $ %Fill in latest version from the badge up top% + $ + ## Setup Ensure that you have ran `pulumi login`. Run `pulumi whoami` to verify that you are logged in. @@ -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/ diff --git a/provider/cmd/pulumi-resource-pulumiservice/schema.json b/provider/cmd/pulumi-resource-pulumiservice/schema.json index d228171a..5f85b12c 100644 --- a/provider/cmd/pulumi-resource-pulumiservice/schema.json +++ b/provider/cmd/pulumi-resource-pulumiservice/schema.json @@ -1,6 +1,6 @@ { "name": "pulumiservice", - "displayName": "Pulumi Cloud", + "displayName": "Pulumi Service", "description": "A native Pulumi package for creating and managing Pulumi Cloud constructs", "homepage": "https://pulumi.com", "repository": "https://github.com/pulumi/pulumi-pulumiservice", diff --git a/sdk/python/README.md b/sdk/python/README.md index f7cfa7f2..616b25a9 100644 --- a/sdk/python/README.md +++ b/sdk/python/README.md @@ -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 Service REST API](https://pulumi.com/docs/reference/service-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 Service API Documentation](https://www.pulumi.com/registry/packages/pulumiservice/api-docs/). -- [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 @@ -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: + + $ + $ com.pulumi + $ pulumiservice + $ %Fill in latest version from the badge up top% + $ + ## Setup Ensure that you have ran `pulumi login`. Run `pulumi whoami` to verify that you are logged in. @@ -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/