generated from pulumi/pulumi-tf-provider-boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
74 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters