Skip to content

Commit

Permalink
feat: add docs for registry publish
Browse files Browse the repository at this point in the history
  • Loading branch information
rawkode committed Aug 19, 2022
1 parent db4c4a9 commit 5889a28
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 1 deletion.
24 changes: 24 additions & 0 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Doppler
meta_desc: Provides an overview of the Doppler Provider for Pulumi.
layout: overview
---

The Doppler provider for Pulumi can be used to provision any of the monitoring resources available in [Doppler](https://dopplerhq.com/).

## Example

{{< chooser language "typescript" >}}

{{% choosable language typescript %}}

```typescript
import * as doppler from "@pulumiverse/doppler";

// Improve example
```

{{% /choosable %}}
{{< /chooser >}}

> You could find more complete and detailed examples in the [pulumi-Doppler repository](https://github.com/pulumiverse/pulumi-doppler/tree/main/examples)
47 changes: 47 additions & 0 deletions docs/installation-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Doppler Setup
meta_desc: Provides an overview on how to configure credentials for the Pulumi Doppler Provider.
layout: installation
---

## Installation

1. To use this package, please [install the Pulumi CLI first](https://www.pulumi.com/docs/get-started/install/).
1. This package is only available for JavaScript and TypeScript but support for other languages will be available soon.

### Node.js (JavaScript/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either `npm` or `yarn`:

```bash
$ npm install @pulumiverse/doppler
$ yarn add @pulumiverse/doppler
```

### Python, Go & .NET

> *TBA*
## Authentication

The Pulumi Doppler Provider needs to be configured with a Doppler `API Key` and `Account ID` before it can be used to create resources.

> If you don't have an `API Key`, you can create one [here](https://app.dopplerhq.com/settings/user/api-keys).
Once you generated the `API Key` there are two ways to communicate your authorization tokens to Pulumi:

1. Set the environment variables `DOPPLER_API_KEY` and `DOPPLER_ACCOUNT_ID`:

```bash
$ export DOPPLER_API_KEY=cu_xxx
$ export DOPPLER_ACCOUNT_ID=xxx
```

2. Set them using `pulumi config` command, if you prefer that they be stored alongside your Pulumi stack for easy multi-user access:

```bash
$ pulumi config set doppler:apiKey cu_xxx --secret
$ pulumi config set doppler:accountId xxx
```

> Remember to pass `--secret` when setting `doppler:apiKey` so it is properly encrypted.
4 changes: 3 additions & 1 deletion provider/cmd/pulumi-resource-doppler/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
"name": "doppler",
"displayName": "Doppler",
"description": "A Pulumi package for creating and managing doppler cloud resources.",
"logoUrl": "https://assets.website-files.com/5de9972f49103c5df3964004/5f0c1146992a5e9e4fa553e6_logo.svg",
"keywords": [
"pulumi",
"doppler",
"category/cloud"
"secrets",
"category/utility"
],
"homepage": "https://www.pulumi.com",
"license": "Apache-2.0",
Expand Down

0 comments on commit 5889a28

Please sign in to comment.