Skip to content
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
28 changes: 28 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,32 @@
FEATURES:

* **New Resource:** `quicknode_endpoint`
* **New Resource:** `quicknode_endpoint_ip`
* **New Resource:** `quicknode_endpoint_domain_mask`
* **New Resource:** `quicknode_endpoint_referrer`
* **New Resource:** `quicknode_endpoint_jwt`
* **New Resource:** `quicknode_endpoint_request_filter`
* **New Resource:** `quicknode_endpoint_token`
* **New Resource:** `quicknode_endpoint_rate_limits`
* **New Resource:** `quicknode_endpoint_method_rate_limit`
* **New Data Source:** `quicknode_chains`
* **New Data Source:** `quicknode_endpoint`
* **New Data Source:** `quicknode_endpoints`

NOTES:

* Endpoint URLs with the credential removed are named `safe_http_url` and
`safe_wss_url`, and carry the literal `TOKEN` where the credential belongs
rather than having it cut out. The real URL's shape survives, including any
path suffix the chain appends after the token, so
`replace(..., "TOKEN", token)` reproduces a working address on every chain.

* `quicknode_endpoint` gains `security_options`, which decides what the endpoint
enforces, and `ip_custom_header` for endpoints behind a proxy. A toggle left
out of the configuration keeps whatever value the endpoint already has.
* Allowlist entries are imported by value rather than by the id the API
assigned, so `terraform import quicknode_endpoint_ip.office 652052/203.0.113.7`
needs nothing looked up first.
* Adding an allowlist entry while its toggle is disabled warns rather than
fails. Building an allowlist before enabling enforcement is the safe order for
an endpoint already serving traffic.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Terraform Provider for Quicknode

The official [Terraform](https://developer.hashicorp.com/terraform) provider for
[Quicknode](https://www.quicknode.com). Manage RPC endpoints, security rules and
rate limits with `terraform plan` and `terraform apply`.
The official [Terraform](https://developer.hashicorp.com/terraform)-compatible
provider for [Quicknode](https://www.quicknode.com). Manage RPC endpoints,
security rules and rate limits with `terraform plan` and `terraform apply`.

- [Provider documentation](./docs) — also published to the Terraform Registry
- [Contributing](./CONTRIBUTING.md)
Expand Down Expand Up @@ -34,9 +34,18 @@ resource "quicknode_endpoint" "payments" {
}
```

Authentication uses a Quicknode [Admin API](https://www.quicknode.com/docs/admin-api)
key, available on paid plans. Set `QUICKNODE_API_KEY` in the environment rather
than writing it into a configuration file.
Authentication uses a Quicknode [API key](https://www.quicknode.com/docs/admin-api),
available on paid plans. Set `QUICKNODE_API_KEY` in the environment rather than
writing it into a configuration file.

The provider covers endpoints, the security mechanisms they enforce and who is
allowed past them, RPC method filtering, and rate limits both endpoint-wide and
per method. Endpoints created elsewhere are readable through
`data.quicknode_endpoint` and `data.quicknode_endpoints`.

A security mechanism is enabled on the endpoint and the entries it applies to
are separate resources, so an entry added outside Terraform is left alone rather
than deleted on the next apply.

Full resource and attribute reference lives in [`docs/`](./docs).

Expand Down
Loading
Loading