Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting limitation of managing action secrets out-of-bound #898

Merged
merged 1 commit into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/resources/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

Actions are secure, tenant-specific, versioned functions written in Node.js that execute at certain points during the Auth0 runtime. Actions are used to customize and extend Auth0's capabilities with custom logic.

~> Secrets and dependencies must be managed with Terraform, they cannot be managed out-of-band.

## Example Usage

```terraform
Expand Down Expand Up @@ -65,10 +67,10 @@ resource "auth0_action" "my_action" {

### Optional

- `dependencies` (Block Set) List of third party npm modules, and their versions, that this action depends on. (see [below for nested schema](#nestedblock--dependencies))
- `dependencies` (Block Set) List of third party npm modules, and their versions, that this action depends on. If your action contains dependencies, they must be managed through Terraform; dependencies cannot be managed out-of-band. (see [below for nested schema](#nestedblock--dependencies))
- `deploy` (Boolean) Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.
- `runtime` (String) The Node runtime. Defaults to `node18`. Possible values are: `node16` (not recommended), or `node18` (recommended).
- `secrets` (Block List) List of secrets that are included in an action or a version of an action. Partial management of secrets is not supported. (see [below for nested schema](#nestedblock--secrets))
- `secrets` (Block List) List of secrets that are included in an action or a version of an action. If your action contains secrets, they **must** be managed through Terraform; Secrets cannot be managed out-of-band. (see [below for nested schema](#nestedblock--secrets))

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions internal/auth0/action/resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ func NewResource() *schema.Resource {
"dependencies": {
Type: schema.TypeSet,
Optional: true,
Description: "List of third party npm modules, and their versions, that this action depends on.",
Description: "List of third party npm modules, and their versions, that this action depends on. If your action contains dependencies, they must be managed through Terraform; dependencies cannot be managed out-of-band.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Expand Down Expand Up @@ -95,7 +95,7 @@ func NewResource() *schema.Resource {
"secrets": {
Type: schema.TypeList,
Optional: true,
Description: "List of secrets that are included in an action or a version of an action. Partial management of secrets is not supported.",
Description: "List of secrets that are included in an action or a version of an action. If your action contains secrets, they **must** be managed through Terraform; Secrets cannot be managed out-of-band.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Expand Down
2 changes: 2 additions & 0 deletions templates/resources/action.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

{{ .Description | trimspace }}

~> Secrets and dependencies must be managed with Terraform, they cannot be managed out-of-band.

{{ if .HasExample -}}

## Example Usage
Expand Down