Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nmanoogian committed Jun 24, 2024
1 parent 934e3fe commit 36cae03
Show file tree
Hide file tree
Showing 15 changed files with 160 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/resources/integration_aws_parameter_store.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ resource "doppler_secrets_sync_aws_parameter_store" "backend_prod" {
path = "/backend/"
secure_string = true
tags = { myTag = "enabled" }
delete_behavior = "leave_in_target"
}
```

Expand Down
2 changes: 2 additions & 0 deletions docs/resources/integration_aws_secrets_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ resource "doppler_secrets_sync_aws_secrets_manager" "backend_prod" {
region = "us-east-1"
path = "/backend/"
tags = { myTag = "enabled" }
delete_behavior = "leave_in_target"
}
```

Expand Down
42 changes: 42 additions & 0 deletions docs/resources/integration_flyio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
page_title: "doppler_integration_flyio Resource - terraform-provider-doppler"
subcategory: ""
description: |-
Manage a Fly.io Doppler integration.
---

# doppler_integration_flyio (Resource)

Manage a Fly.io Doppler integration.

## Example Usage

```terraform
resource "doppler_integration_flyio" "prod" {
name = "TF Fly.io"
api_key = "fo1_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
resource "doppler_secrets_sync_flyio" "backend_prod" {
integration = doppler_integration_flyio.prod.id
project = "backend"
config = "prd"
app_id = "my-app"
restart_machines = true
delete_behavior = "leave_in_target"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `api_key` (String, Sensitive) A Fly.io API key.
- `name` (String) The name of the integration

### Read-Only

- `id` (String) The ID of this resource.
2 changes: 2 additions & 0 deletions docs/resources/integration_terraform_cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ resource "doppler_secrets_sync_terraform_cloud" "backend_prod" {
workspace_id = data.tfe_workspace.prod.id
variable_sync_type = "terraform"
name_transform = "lowercase"
delete_behavior = "leave_in_target"
}
```

Expand Down
3 changes: 3 additions & 0 deletions docs/resources/secrets_sync_aws_parameter_store.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ resource "doppler_secrets_sync_aws_parameter_store" "backend_prod" {
path = "/backend/"
secure_string = true
tags = { myTag = "enabled" }
delete_behavior = "leave_in_target"
}
```

Expand All @@ -93,6 +95,7 @@ resource "doppler_secrets_sync_aws_parameter_store" "backend_prod" {

### Optional

- `delete_behavior` (String) The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either `leave_in_target` (default) or `delete_from_target`.
- `secure_string` (Boolean) Whether or not the parameters are stored as a secure string
- `tags` (Map of String) AWS tags to attach to the parameters

Expand Down
3 changes: 3 additions & 0 deletions docs/resources/secrets_sync_aws_secrets_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ resource "doppler_secrets_sync_aws_secrets_manager" "backend_prod" {
region = "us-east-1"
path = "/backend/"
tags = { myTag = "enabled" }
delete_behavior = "leave_in_target"
}
```

Expand All @@ -88,6 +90,7 @@ resource "doppler_secrets_sync_aws_secrets_manager" "backend_prod" {

### Optional

- `delete_behavior` (String) The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either `leave_in_target` (default) or `delete_from_target`.
- `tags` (Map of String) AWS tags to attach to the secrets

### Read-Only
Expand Down
49 changes: 49 additions & 0 deletions docs/resources/secrets_sync_flyio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
page_title: "doppler_secrets_sync_flyio Resource - terraform-provider-doppler"
subcategory: ""
description: |-
Manage a Fly.io Doppler sync.
---

# doppler_secrets_sync_flyio (Resource)

Manage a Fly.io Doppler sync.

## Example Usage

```terraform
resource "doppler_integration_flyio" "prod" {
name = "TF Fly.io"
api_key = "fo1_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
resource "doppler_secrets_sync_flyio" "backend_prod" {
integration = doppler_integration_flyio.prod.id
project = "backend"
config = "prd"
app_id = "my-app"
restart_machines = true
delete_behavior = "leave_in_target"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `app_id` (String) The app ID
- `config` (String) The name of the Doppler config
- `integration` (String) The slug of the integration to use for this sync
- `project` (String) The name of the Doppler project
- `restart_machines` (Boolean) Whether or not to restart the Fly.io machines when secrets are updated

### Optional

- `delete_behavior` (String) The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either `leave_in_target` (default) or `delete_from_target`.

### Read-Only

- `id` (String) The ID of this resource.
1 change: 1 addition & 0 deletions docs/resources/secrets_sync_github_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ resource "doppler_secrets_sync_github_actions" "backend_prod" {

### Optional

- `delete_behavior` (String) The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either `leave_in_target` (default) or `delete_from_target`.
- `environment_name` (String) The GitHub repo environment name to sync to (only used when `sync_target` is set to "repo")
- `org_scope` (String) Either "all" or "private", based on the which repos you want to have access (only used when `sync_target` is set to "org")
- `repo_name` (String) The GitHub repo name to sync to (only used when `sync_target` is set to "repo")
Expand Down
3 changes: 3 additions & 0 deletions docs/resources/secrets_sync_terraform_cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ resource "doppler_secrets_sync_terraform_cloud" "backend_prod" {
workspace_id = data.tfe_workspace.prod.id
variable_sync_type = "terraform"
name_transform = "lowercase"
delete_behavior = "leave_in_target"
}
```

Expand All @@ -48,6 +50,7 @@ resource "doppler_secrets_sync_terraform_cloud" "backend_prod" {

### Optional

- `delete_behavior` (String) The behavior to be performed on the secrets in the sync target when this resource is deleted or recreated. Either `leave_in_target` (default) or `delete_from_target`.
- `variable_set_id` (String) The Terraform Cloud variable set ID to sync to
- `workspace_id` (String) The Terraform Cloud workspace ID to sync to

Expand Down
2 changes: 2 additions & 0 deletions examples/resources/integration_aws_parameter_store.tf
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,7 @@ resource "doppler_secrets_sync_aws_parameter_store" "backend_prod" {
path = "/backend/"
secure_string = true
tags = { myTag = "enabled" }

delete_behavior = "leave_in_target"
}

2 changes: 2 additions & 0 deletions examples/resources/integration_aws_secrets_manager.tf
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,7 @@ resource "doppler_secrets_sync_aws_secrets_manager" "backend_prod" {
region = "us-east-1"
path = "/backend/"
tags = { myTag = "enabled" }

delete_behavior = "leave_in_target"
}

15 changes: 15 additions & 0 deletions examples/resources/integration_flyio.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
resource "doppler_integration_flyio" "prod" {
name = "TF Fly.io"
api_key = "fo1_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

resource "doppler_secrets_sync_flyio" "backend_prod" {
integration = doppler_integration_flyio.prod.id
project = "backend"
config = "prd"

app_id = "my-app"
restart_machines = true

delete_behavior = "leave_in_target"
}
2 changes: 2 additions & 0 deletions examples/resources/integration_terraform_cloud.tf
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,6 @@ resource "doppler_secrets_sync_terraform_cloud" "backend_prod" {
workspace_id = data.tfe_workspace.prod.id
variable_sync_type = "terraform"
name_transform = "lowercase"

delete_behavior = "leave_in_target"
}
16 changes: 16 additions & 0 deletions templates/resources/integration_flyio.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
page_title: "doppler_integration_flyio Resource - terraform-provider-doppler"
subcategory: ""
description: |-
Manage a Fly.io Doppler integration.
---

# doppler_integration_flyio (Resource)

Manage a Fly.io Doppler integration.

## Example Usage

{{tffile "examples/resources/integration_flyio.tf"}}

{{ .SchemaMarkdown | trimspace }}
16 changes: 16 additions & 0 deletions templates/resources/secrets_sync_flyio.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
page_title: "doppler_secrets_sync_flyio Resource - terraform-provider-doppler"
subcategory: ""
description: |-
Manage a Fly.io Doppler sync.
---

# doppler_secrets_sync_flyio (Resource)

Manage a Fly.io Doppler sync.

## Example Usage

{{tffile "examples/resources/integration_flyio.tf"}}

{{ .SchemaMarkdown | trimspace }}

0 comments on commit 36cae03

Please sign in to comment.