Skip to content

Commit

Permalink
update docs to match provider
Browse files Browse the repository at this point in the history
  • Loading branch information
bshelton committed Apr 2, 2024
1 parent 93d0571 commit 5ae6c30
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
14 changes: 7 additions & 7 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,24 @@ meta_desc: Learn how you can use Event Store Cloud Provider for Pulumi to provis
layout: package
---

The Event Store Cloud (ESC) provider for Pulumi can provision many of the cloud resources available in [ESC](https://eventstore.com/cloud/). It uses the ESC API to manage and provision resources.
The Event Store Cloud provider for Pulumi can provision many of the cloud resources available in [Event Store Cloud](https://eventstore.com/cloud/). It uses the Event Store Cloud API to manage and provision resources.

The ESC provider must be configured with credentials to deploy and update resources; see [Installation & Configuration]({{<relref "./installation-configuration">}}) for instructions.
The Event Store Cloud provider must be configured with credentials to deploy and update resources; see [Installation & Configuration](./installation-configuration) for instructions.

## Example

```typescript
import * as esc from "@eventstore/pulumi-eventstorecloud";
import * as eventstore from "@eventstore/pulumi-eventstorecloud";

const project = new esc.Project("sample-project", {
name: "Improved Chicken Window"
const project = new eventstore.Project("sample-project", {
name: "Improved Chicken Window",
});

const network = new esc.Network("sample-network", {
const network = new eventstore.Network("sample-network", {
name: "Chicken Window Net",
projectId: project.id,
resourceProvider: "aws",
region: "eu-west1",
cidrBlock: "172.21.0.0/16"
cidrBlock: "172.21.0.0/16",
});
```
24 changes: 12 additions & 12 deletions docs/installation-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ layout: package

## Installation

The Event Store Cloud (ESC) provider is available as a package in all Pulumi languages:
The Event Store Cloud provider is available as a package in all Pulumi languages:

* JavaScript/TypeScript: [`@eventstore/pulumi-eventstorecloud`](https://www.npmjs.com/package/@eventstore/pulumi-eventstorecloud)
* Go: [`github.com/EventStore/pulumi-eventstorecloud/sdk/go/eventstorecloud`](https://github.com/EventStore/pulumi-eventstorecloud)
* .NET: [`Pulumi.EventStoreCloud`](https://www.nuget.org/packages/Pulumi.EventStoreCloud)
- JavaScript/TypeScript: [`@eventstore/pulumi-eventstorecloud`](https://www.npmjs.com/package/@eventstore/pulumi-eventstorecloud)
- Go: [`github.com/EventStore/pulumi-eventstorecloud/sdk/go/eventstorecloud`](https://github.com/EventStore/pulumi-eventstorecloud)
- .NET: [`Pulumi.EventStoreCloud`](https://www.nuget.org/packages/Pulumi.EventStoreCloud)

## Setup

Expand All @@ -33,8 +33,8 @@ First, you need an [access token](https://developers.eventstore.com/cloud/automa

Then, go to the list of organizations you have access to in Event Store Cloud console, choose the organization that you will be provisioning resources for, and look the organization id in the settings.

* `<YOUR_ACCESS_TOKEN>`: your access token
* `<YOUR_ORGANIZATION_ID>`: the Event Store Cloud organization id
- `<YOUR_ACCESS_TOKEN>`: your access token
- `<YOUR_ORGANIZATION_ID>`: the Event Store Cloud organization id

Once the credentials are obtained, there are two ways to communicate your authorization tokens to Pulumi:

Expand All @@ -56,9 +56,9 @@ Once the credentials are obtained, there are two ways to communicate your author
Required options can be omitted if you configure them using environment variables.
{{% /notes %}}

| Option | Required/Optional | Description |
|------------------|-------------------|---------------------------------------------------------------------------------------------------------|
| `token` | Required | Access token. You can retrieve this from the ‘Access Tokens’ section of the Event Store Cloud console. |
| `organizationId` | Required | The organization id. You can find it in the organization settings page if the ESC console. |
| `url` | Optional | The URL of the Event Store Cloud API. This defaults to the public cloud instance of Event Store Cloud. |
| `tokenStore` | Optional | The location on the local filesystem of the token cache. This is shared with the Event Store Cloud CLI. |
| Option | Required/Optional | Description |
| ---------------- | ----------------- | -------------------------------------------------------------------------------------------------------- |
| `token` | Required | Access token. You can retrieve this from the ‘Access Tokens’ section of the Event Store Cloud console. |
| `organizationId` | Required | The organization id. You can find it in the organization settings page of the Event Store Cloud console. |
| `url` | Optional | The URL of the Event Store Cloud API. This defaults to the public cloud instance of Event Store Cloud. |
| `tokenStore` | Optional | The location on the local filesystem of the token cache. This is shared with the Event Store Cloud CLI. |

0 comments on commit 5ae6c30

Please sign in to comment.