-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Rebrand from EventStore to Kurrent #828
base: master
Are you sure you want to change the base?
Conversation
Deploying documentation with
|
Latest commit: |
473250b
|
Status: | ✅ Deploy successful! |
Preview URL: | https://43e0979e.documentation-21k.pages.dev |
Branch Preview URL: | https://rebrand.documentation-21k.pages.dev |
@@ -96,7 +96,7 @@ No additional configuration is needed having Rust installed. Go check [https://r | |||
### Connection string | |||
|
|||
Each SDK has its own way of configuring the client, but the connection string can always be used. | |||
The EventStoreDB connection string supports two schemas: `esdb://` for connecting to a single-node server, and `esdb+discover://` for connecting to a multi-node cluster. The difference between the two schemas is that when using `esdb://`, the client will connect directly to the node; with `esdb+discover://` schema the client will use the gossip protocol to retrieve the cluster information and choose the right node to connect to. | |||
The KurrentDB connection string supports two schemas: `esdb://` for connecting to a single-node server, and `esdb+discover://` for connecting to a multi-node cluster. The difference between the two schemas is that when using `esdb://`, the client will connect directly to the node; with `esdb+discover://` schema the client will use the gossip protocol to retrieve the cluster information and choose the right node to connect to. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hayley-jean are the connection strings still "esdb" and "esdb+discover" for 25.0?
@@ -9,7 +9,7 @@ X.509 certificates are digital certificates that use the X.509 public key infras | |||
|
|||
### Prerequisites | |||
|
|||
1. EventStoreDB 24.2.0 or greater with commercial license. | |||
1. KurrentDB 24.2.0 or greater with commercial license. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
24.2 is still EventStoreDB, and not supported - @hayley-jean any suggestions the wording for this one?
@@ -36,7 +36,7 @@ If you were using it in the .NET Standard library, you have to update it to the | |||
</Project> | |||
``` | |||
|
|||
If you use .NET Framework, you'll have to make sure that your application is targeting .NET Framework 4.8 or later. EventStoreDB only supports gRPC calls with HTTP/2, and it is only possible to use HTTP/2 on Windows 11 and Windows Server 2019 when building applications using .NET Framework. This limitation doesn't apply to .NET Core 3+ and .NET 5+. Check the compatibility note in [.NET documentation](https://learn.microsoft.com/en-us/aspnet/core/grpc/supported-platforms?view=aspnetcore-8.0#net-grpc-client-requirements). | |||
If you use .NET Framework, you'll have to make sure that your application is targeting .NET Framework 4.8 or later. KurrentDB only supports gRPC calls with HTTP/2, and it is only possible to use HTTP/2 on Windows 11 and Windows Server 2019 when building applications using .NET Framework. This limitation doesn't apply to .NET Core 3+ and .NET 5+. Check the compatibility note in [.NET documentation](https://learn.microsoft.com/en-us/aspnet/core/grpc/supported-platforms?view=aspnetcore-8.0#net-grpc-client-requirements). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like we should leave the depreciated clients as EventStoreDB
| x64 | Windows | terraform-provider-eventstorecloud_{{ $frontmatter.terraform_current_version }}_windows_amd64.zip | | ||
| arm64 | FreeBSD | terraform-provider-eventstorecloud_{{ $frontmatter.terraform_current_version }}_freebsd_arm64.zip | | ||
| arm64 | Linux | terraform-provider-eventstorecloud_{{ $frontmatter.terraform_current_version }}_linux_arm64.zip | | ||
| x64 | macOS | terraform-provider-kurrentcloud_{{ $frontmatter.terraform_current_version }}_darwin_amd64.zip | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cchanning would you confirm nothing is out of sorts with the updated filenames in this PR?
@@ -1,6 +1,6 @@ | |||
# Indexmap migration | |||
|
|||
From EventStoreDB 5 onwards, the format of the indexmap file changed. The indexmap-migrate tool converts EventStoreDB 5 indexmap files to a format compatible with previous EventStoreDB versions. You will need this if you roll back from EventStoreDB 5 to an earlier version. | |||
From KurrentDB 5 onwards, the format of the indexmap file changed. The indexmap-migrate tool converts KurrentDB 5 indexmap files to a format compatible with previous KurrentDB versions. You will need this if you roll back from KurrentDB 5 to an earlier version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldn't have kurrentdb tied to v5.
|
||
The Auto-scavenge feature is designed to manage and automate cluster scavenges across multiple nodes efficiently. It operates on a scheduled basis using CRON expressions, ensuring that only one node scavenge occurs simultaneously to minimize disruption. To reduce impact on cluster performance the feature prioritizes non-leader nodes for scavenging, with the leader node resigning before its own scavenge is executed. | ||
|
||
Auto-scavenge restarts or cancels scavenges if a node is lost, and allows you to pause and resume cluster scavenges as needed. With this comprehensive, automated approach, you can maintain cluster health and performance more effectively. | ||
|
||
#### Prerequisites: | ||
|
||
* [EventStoreDB 24.10 LTS installed and running](http://@server/quick-start/installation.md) | ||
* [KurrentDB 24.10 LTS installed and running](http://@server/quick-start/installation.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The rebrand is tricky in some areas. This should likely be "EventStoreDB 24.10 or later installed..." Same with the references to EventStoreDB 24.10 later in this section.
|
||
### Step 1: Verify license key | ||
|
||
Ensure you have a valid **license key** to use the Encryption-At-Rest feature. Without this license, the feature will not be functional. | ||
|
||
### Step 2 (optional): Confirm Encryption-At-Rest availability | ||
|
||
By default, Encryption-At-Rest is bundled with EventStoreDB 24.20 LTS. You can confirm its availability in the EventStoreDB logs. Look for the following log message: | ||
By default, Encryption-At-Rest is bundled with KurrentDB 24.20 LTS. You can confirm its availability in the KurrentDB logs. Look for the following log message: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By default, Encryption-At-Rest is bundled with EventStoreDB 24.10 and later versions. You can confirm its availability in the KurrentDB logs. Look for the following log message:
(Note the update from 24.20 to 24.10)
Description
This PR applies the rebrand from EventStore to Kurrent
Page previews
https://rebrand.documentation-21k.pages.dev/