diff --git a/themes/default/content/docs/esc/providers/1password-secrets.md b/themes/default/content/docs/esc/providers/1password-secrets.md new file mode 100644 index 00000000000..ea6dac26efe --- /dev/null +++ b/themes/default/content/docs/esc/providers/1password-secrets.md @@ -0,0 +1,69 @@ +--- +title_tag: 1password-secrets Pulumi ESC Provider +meta_desc: The `1password-secrets` provider enables you to dynamically import Secrets from 1Password into your Environment. +title: 1password-secrets +h1: 1password-secrets +meta_image: /images/docs/meta-images/docs-meta.png +menu: + pulumiesc: + identifier: 1password-secrets + parent: esc-providers + weight: 1 +aliases: +- /docs/pulumi-cloud/esc/providers/1password-secrets/ +--- + +The `1password-secrets` provider enables you to dynamically import Secrets from 1Password into your Environment. The provider will return a map of names to Secrets. + +{{% notes type="warning" %}} +This provider is currently in **preview**. +{{% /notes %}} + +## Example + +```yaml + 1password: + secrets: + fn::open::1password-secrets: + login: + serviceAccountToken: + fn::secret: "ops_123ABC" + get: + email_section_example: + ref: "op://Management/PagerDuty/Admin/email" + anna_sans_section_example: + ref: "op://dev/Stripe/publishable-key" + olaf_attr_example: + ref: "op://development/GitHub/Security/one-time password?attribute=otp" + sven_ssh_example: + ref: "op://Private/ssh keys/ssh key/private key?ssh-format=openssh" + nokk_whitespace_example: + ref: "op://development/aws/Access Keys/access_key_id" + gale_unique_id_example: + ref: "op://prod/yj3jfj2vzsbiwqabprflnl27lm/password" +``` + +## Inputs + +| Property | Type | Description | +|----------|--------------------------------------------------------|-------------------------------------------| +| `login` | [1PasswordSecretsLogin](#1passwordsecretslogin) | Credentials used to log in to 1Password. | +| `get` | map[string][1PasswordSecretsGet](#1passwordsecretsget) | The secrets to get. | + +### 1PasswordSecretsLogin + +| Property | Type | Description | +|-----------------------|--------|-------------------------------------------------------------------------------| +| `serviceAccountToken` | string | The service account token to use for authentication.. | + +### 1PasswordSecretsGet + +| Property | Type | Description | +|----------|--------|----------------------------------------------| +| `ref` | string | A [reference to a secret](https://developer.1password.com/docs/cli/secrets-reference-syntax) of the form `op://vault-name/item-name/[section-name/]field-name` to read from 1Password. | + +### Outputs + +| Property | Type | Description | +|----------|--------|------------------------------------| +| N/A | object | A map from names to secret values. | diff --git a/themes/default/content/docs/esc/providers/_index.md b/themes/default/content/docs/esc/providers/_index.md index 68c46bd8cda..a7f35fa07c4 100644 --- a/themes/default/content/docs/esc/providers/_index.md +++ b/themes/default/content/docs/esc/providers/_index.md @@ -16,14 +16,15 @@ Pulumi ESC providers enable you to dynamically import secrets and configuration To learn how to set up and use each provider, follow the links below. To learn how to configure OpenID Connect (OIDC) for the providers that support it, see [OpenID Connect integration](/docs/pulumi-cloud/oidc/) in the Pulumi Cloud documentation. -| Provider | Description | -|------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| -| [aws-login](/docs/pulumi-cloud/esc/providers/aws-login/) | The `aws-login` provider enables you to log in to your AWS account using OpenID Connect or static credentials. | -| [aws-secrets](/docs/pulumi-cloud/esc/providers/aws-secrets/) | The `aws-secrets` provider enables you to dynamically import Secrets from AWS Secrets Manager into your Environment. | -| [azure-login](/docs/pulumi-cloud/esc/providers/azure-login/) | The `azure-login` provider enables you to log in to Azure using OpenID Connect or static credentials. | -| [azure-secrets](/docs/pulumi-cloud/esc/providers/azure-secrets/) | The `azure-secrets` provider enables you to dynamically import Secrets from Azure Key Vault into your Environment. | -| [gcp-login](/docs/pulumi-cloud/esc/providers/gcp-login/) | The `gcp-login` provider enables you to log in to Google Cloud using OpenID Connect or static credentials. | -| [gcp-secrets](/docs/pulumi-cloud/esc/providers/gcp-secrets/) | The `gcp-secrets` provider enables you to dynamically import Secrets from Google Cloud Secrets Manager into your Environment. | -| [pulumi-stacks](/docs/pulumi-cloud/esc/providers/pulumi-stacks/) | The `pulumi-stacks` provider enables you to import Stack outputs from Pulumi into your Environment. | -| [vault-login](/docs/pulumi-cloud/esc/providers/vault-login/) | The `vault-login` provider enables you to log in to HashiCorp Vault using OpenID Connect or static credentials. | -| [vault-secrets](/docs/pulumi-cloud/esc/providers/vault-secrets/) | The `vault-secrets` provider enables you to dynamically import Secrets from HashiCorp Vault into your Environment. | +| Provider | Description | +|--------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| [1password-secrets](/docs/pulumi-cloud/esc/providers/1password-secrets/) | The `1password-secrets` provider enables you to dynamically import Secrets from 1Password into your Environment. | +| [aws-login](/docs/pulumi-cloud/esc/providers/aws-login/) | The `aws-login` provider enables you to log in to your AWS account using OpenID Connect or static credentials. | +| [aws-secrets](/docs/pulumi-cloud/esc/providers/aws-secrets/) | The `aws-secrets` provider enables you to dynamically import Secrets from AWS Secrets Manager into your Environment. | +| [azure-login](/docs/pulumi-cloud/esc/providers/azure-login/) | The `azure-login` provider enables you to log in to Azure using OpenID Connect or static credentials. | +| [azure-secrets](/docs/pulumi-cloud/esc/providers/azure-secrets/) | The `azure-secrets` provider enables you to dynamically import Secrets from Azure Key Vault into your Environment. | +| [gcp-login](/docs/pulumi-cloud/esc/providers/gcp-login/) | The `gcp-login` provider enables you to log in to Google Cloud using OpenID Connect or static credentials. | +| [gcp-secrets](/docs/pulumi-cloud/esc/providers/gcp-secrets/) | The `gcp-secrets` provider enables you to dynamically import Secrets from Google Cloud Secrets Manager into your Environment. | +| [pulumi-stacks](/docs/pulumi-cloud/esc/providers/pulumi-stacks/) | The `pulumi-stacks` provider enables you to import Stack outputs from Pulumi into your Environment. | +| [vault-login](/docs/pulumi-cloud/esc/providers/vault-login/) | The `vault-login` provider enables you to log in to HashiCorp Vault using OpenID Connect or static credentials. | +| [vault-secrets](/docs/pulumi-cloud/esc/providers/vault-secrets/) | The `vault-secrets` provider enables you to dynamically import Secrets from HashiCorp Vault into your Environment. | diff --git a/themes/default/content/docs/esc/reference.md b/themes/default/content/docs/esc/reference.md index 2b16c744ad6..4e63422c51b 100644 --- a/themes/default/content/docs/esc/reference.md +++ b/themes/default/content/docs/esc/reference.md @@ -110,6 +110,27 @@ values: # environment is opened. # --------------------------------------------------------------------------------------- + # 1Password Provider examples + 1password: + secrets: + fn::open::1password-secrets: + login: + serviceAccountToken: + fn::secret: "ops_123ABC" + get: + email_section_example: + ref: "op://Management/PagerDuty/Admin/email" + anna_sans_section_example: + ref: "op://dev/Stripe/publishable-key" + olaf_attr_example: + ref: "op://development/GitHub/Security/one-time password?attribute=otp" + sven_ssh_example: + ref: "op://Private/ssh keys/ssh key/private key?ssh-format=openssh" + nokk_whitespace_example: + ref: "op://development/aws/Access Keys/access_key_id" + gale_unique_id_example: + ref: "op://prod/yj3jfj2vzsbiwqabprflnl27lm/password" + # AWS Provider examples aws: login: