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

DX-1267: Deprecate Kafka Clusters #47

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 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
2 changes: 0 additions & 2 deletions docs/data-sources/kafka_cluster_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,3 @@ data "upstash_kafka_cluster_data" "clusterData" {
- `tcp_endpoint` (String) TCP Endpoint of the cluster
- `type` (String) Type of the cluster
- `username` (String) Base64 encoded username for the cluster


2 changes: 0 additions & 2 deletions docs/data-sources/kafka_connector_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,3 @@ data "upstash_kafka_connector_data" "kafkaConnectorData" {
- `topics` (List of String) Topics for the connector
- `ttl` (Number) TTL for the connector
- `user_password` (String, Sensitive) User password for the connector


2 changes: 0 additions & 2 deletions docs/data-sources/kafka_credential_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,3 @@ data "upstash_kafka_credential_data" "kafkaCredentialData" {
- `state` (String) State of the credential(active or deleted)
- `topic` (String) Name of the kafka topic
- `username` (String) Username to be used for the kafka credential


2 changes: 0 additions & 2 deletions docs/data-sources/kafka_topic_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,3 @@ data "upstash_kafka_topic_data" "kafkaTopicData" {
- `tcp_endpoint` (String) TCP Endpoint of the topic
- `topic_name` (String) Name of the kafka topic
- `username` (String) Base64 encoded username to be used in authenticating to the cluster


2 changes: 0 additions & 2 deletions docs/data-sources/qstash_endpoint_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,3 @@ data "upstash_qstash_endpoint_data" "exampleQstashEndpointData" {
- `endpoint_id` (String) Unique Qstash Endpoint ID
- `id` (String) The ID of this resource.
- `url` (String) URL of the endpoint


2 changes: 0 additions & 2 deletions docs/data-sources/qstash_schedule_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ data "upstash_qstash_schedule_data" "exampleQstashScheduleData" {
- `id` (String) The ID of this resource.
- `not_before` (Number) Start time for Qstash Schedule
- `retries` (Number) Retries for Qstash Schedule. Either Topic ID or valid URL


2 changes: 0 additions & 2 deletions docs/data-sources/qstash_schedule_v2_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ description: |-
- `destination` (String) Destination for Qstash Schedule. Either Topic Name or valid URL
- `id` (String) The ID of this resource.
- `method` (String) Method of Http Request on QStash


2 changes: 0 additions & 2 deletions docs/data-sources/qstash_topic_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,3 @@ description: |-
- `endpoints` (List of Map of String) Endpoints for the Qstash Topic
- `id` (String) The ID of this resource.
- `name` (String) Name of the Qstash Topic


2 changes: 0 additions & 2 deletions docs/data-sources/qstash_topic_v2_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,3 @@ description: |-
- `endpoints` (Set of String) Endpoints for the Qstash Topic
- `id` (String) The ID of this resource.
- `updated_at` (Number) Last Update time for Qstash Topic.


4 changes: 1 addition & 3 deletions docs/data-sources/redis_database_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,10 @@ data "upstash_redis_database_data" "exampleDBData" {
- `password` (String, Sensitive) Password of the database
- `port` (Number) Port of the endpoint
- `primary_region` (String) Primary region for the database
- `read_only_rest_token` (String) Rest Token for the database.
- `read_only_rest_token` (String, Sensitive) Rest Token for the database.
- `read_regions` (Set of String) Read regions for the database
- `region` (String) region of the database. Possible values are: "global", "eu-west-1", "us-east-1", "us-west-1", "ap-northeast-1" , "eu-central1"
- `rest_token` (String, Sensitive) Rest Token for the database.
- `state` (String) State of the database
- `tls` (Boolean) When enabled data is encrypted in transit
- `user_email` (String) User email for the database


2 changes: 0 additions & 2 deletions docs/data-sources/team_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,3 @@ data "upstash_team_data" "teamData" {
- `id` (String) The ID of this resource.
- `team_members` (Map of String) Members of the team. Email addresses are given as the keys with their roles as the values.
- `team_name` (String) Name of the team


11 changes: 2 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,10 @@ provider "upstash" {
}
```

## Authenticate the Provider

The Upstash provider requires `email` and `api_key` in order to authenticate.
Email is your email address while registering Upstash.
API KEY can be generated from the [Upstash Console](https://console.upstash.com).
Plese see our [API KEY documentation](https://docs.upstash.com/howto/developerapi).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we manually paste this, so that it is not lost

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

### Required

- **api_key** (String, Sensitive)
- **email** (String)
- `api_key` (String, Sensitive)
- `email` (String)
2 changes: 0 additions & 2 deletions docs/resources/kafka_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,3 @@ resource "upstash_kafka_cluster" "exampleCluster" {
- `tcp_endpoint` (String) TCP Endpoint of the cluster
- `type` (String) Type of the cluster
- `username` (String) Base64 encoded username for the cluster


2 changes: 0 additions & 2 deletions docs/resources/kafka_connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,3 @@ resource "upstash_kafka_connector" "exampleKafkaConnector" {
- `connector_id` (String) Unique Connector ID for created connector
- `creation_time` (Number) Creation of the connector
- `id` (String) The ID of this resource.


2 changes: 0 additions & 2 deletions docs/resources/kafka_credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,3 @@ resource "upstash_kafka_credential" "exampleKafkaCredentialAllTopics" {
- `password` (String, Sensitive) Password to be used in authenticating to the cluster
- `state` (String) State of the credential(active or deleted)
- `username` (String) Username to be used for the kafka credential


2 changes: 0 additions & 2 deletions docs/resources/kafka_topic.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,3 @@ resource "upstash_kafka_topic" "exampleKafkaTopic" {
- `tcp_endpoint` (String) TCP Endpoint of the kafka topic
- `topic_id` (String) Unique Cluster ID for created topic
- `username` (String) Base64 encoded username to be used in authenticating to the cluster


2 changes: 0 additions & 2 deletions docs/resources/qstash_endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,3 @@ resource "upstash_qstash_endpoint" "exampleQstashEndpoint" {
- `endpoint_id` (String) Unique Qstash Endpoint ID
- `id` (String) The ID of this resource.
- `topic_name` (String) Unique Qstash Topic Name for Endpoint


2 changes: 0 additions & 2 deletions docs/resources/qstash_schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,3 @@ resource "upstash_qstash_schedule" "exampleQstashSchedule" {
- `created_at` (Number) Creation time for Qstash Schedule.
- `id` (String) The ID of this resource.
- `schedule_id` (String) Unique Qstash Schedule ID for requested schedule


2 changes: 0 additions & 2 deletions docs/resources/qstash_schedule_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,3 @@ description: |-
- `header` (String) Headers for the QStash schedule
- `id` (String) The ID of this resource.
- `schedule_id` (String) Unique Qstash Schedule ID for requested schedule


2 changes: 0 additions & 2 deletions docs/resources/qstash_topic.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,3 @@ resource "upstash_qstash_topic" "exampleQstashTopic" {
- `endpoints` (List of Map of String) Endpoints for the Qstash Topic
- `id` (String) The ID of this resource.
- `topic_id` (String) Unique Qstash Topic ID for requested topic


2 changes: 0 additions & 2 deletions docs/resources/qstash_topic_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,3 @@ description: |-
- `created_at` (Number) Creation time for Qstash Topic.
- `id` (String) The ID of this resource.
- `updated_at` (Number) Last Update time for Qstash Topic.


8 changes: 3 additions & 5 deletions docs/resources/redis_database.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ description: |-
```terraform
resource "upstash_redis_database" "exampleDB" {
database_name = "Terraform DB6"
region = "eu-west-1"
region = "global"
tls = "true"
multizone = "true"
primary_region = "eu-west-1"
}
```

Expand Down Expand Up @@ -55,9 +55,7 @@ resource "upstash_redis_database" "exampleDB" {
- `id` (String) The ID of this resource.
- `password` (String, Sensitive) Password of the database
- `port` (Number) Port of the endpoint
- `read_only_rest_token` (String) Rest Token for the database.
- `read_only_rest_token` (String, Sensitive) Rest Token for the database.
- `rest_token` (String, Sensitive) Rest Token for the database.
- `state` (String) State of the database
- `user_email` (String) User email for the database


2 changes: 0 additions & 2 deletions docs/resources/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,3 @@ resource "upstash_team" "exampleTeam" {

- `id` (String) The ID of this resource.
- `team_id` (String) Unique Cluster ID for created cluster


1 change: 1 addition & 0 deletions upstash/kafka/cluster/data_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,6 @@ func DataSourceCluster() *schema.Resource {
Description: "Creation time of the cluster",
},
},
DeprecationMessage: "Upstash Kafka service is deprecated. It's no longer possible to create new clusters, but existing clusters will be continued until March 2025. For further information regarding this issue, see https://upstash.com/blog/workflow-kafka",
}
}