Skip to content

Commit 4e2595b

Browse files
vankovapvankovap
authored
keydb overview (#237)
1 parent 4062e72 commit 4e2595b

File tree

3 files changed

+479
-17
lines changed

3 files changed

+479
-17
lines changed

‎apps/docs/content/keydb/overview.mdx

Lines changed: 110 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,112 @@
11
---
22
title: KeyDB overview
3-
description: Learn about working with KeyDB with ease on Zerops.
4-
---
3+
description: Learn about working with KeyDB on Zerops.
4+
---
5+
6+
import DocCardList from '@theme/DocCardList';
7+
import Icons from '@theme/Icon';
8+
import LargeCardList from '@site/src/components/LargeCardList';
9+
import LargeCard from '@site/src/components/LargeCard';
10+
11+
[KeyDB ↗](https://docs.keydb.dev/) is a fully open source database, a faster drop-in alternative to Redis. It offers enhanced performance, multithreading capabilities, and maintains full compatibility with Redis clients and APIs.
12+
13+
:::important
14+
While KeyDB is available on Zerops, please note that KeyDB development has not been very active recently. For new Redis-compatible deployments, we recommend considering [Valkey](/valkey/overview) as the preferred alternative due to its active development and ongoing support.
15+
:::
16+
17+
## Feature Highlights
18+
19+
<DocCardList
20+
colSize={4}
21+
items={[
22+
{
23+
type: 'link',
24+
href: '/keydb/how-to/create',
25+
label: 'Create KeyDB service',
26+
customProps: {
27+
icon: Icons['computer-desktop'],
28+
description:
29+
'Start with creating a KeyDB service using GUI or zCLI.',
30+
},
31+
},
32+
{
33+
type: 'link',
34+
href: '/keydb/how-to/create#highly-available',
35+
label: 'HA mode',
36+
customProps: {
37+
icon: Icons['squares-plus'],
38+
description: 'Learn how to setup your database to be production-ready with high availability.',
39+
},
40+
},
41+
{
42+
type: 'link',
43+
href: '/keydb/how-to/create#full-example',
44+
label: 'Import config file',
45+
customProps: {
46+
icon: Icons['puzzle'],
47+
description: 'Use an example config file to import your KeyDB service.',
48+
},
49+
},
50+
]}
51+
/>
52+
53+
### Connect to KeyDB service
54+
55+
<DocCardList
56+
colSize={4}
57+
items={[
58+
{
59+
type: 'link',
60+
href: '/keydb/how-to/manage',
61+
label: 'Manage KeyDB database',
62+
customProps: {
63+
icon: Icons['circle-stack'],
64+
},
65+
},
66+
{
67+
type: 'link',
68+
href: '/keydb/how-to/connect#connect-to-keydb-from-runtime-services-of-the-same-project',
69+
label: 'Connect from the same project',
70+
customProps: {
71+
icon: Icons['link'],
72+
},
73+
},
74+
{
75+
type: 'link',
76+
href: '/keydb/how-to/connect#connect-to-keydb-in-zerops-remotely',
77+
label: 'Connect remotely',
78+
customProps: {
79+
icon: Icons['globe-europe'],
80+
},
81+
},
82+
]}
83+
/>
84+
85+
## Popular Guides
86+
87+
<DocCardList
88+
colSize={6}
89+
items={[
90+
{
91+
type: 'link',
92+
href: '/references/cli',
93+
label: 'zCLI',
94+
customProps: {
95+
icon: Icons['command-line'],
96+
description:
97+
'Get even more out of Zerops with the zCLI command line tool.',
98+
},
99+
},
100+
{
101+
type: 'link',
102+
href: '/references/vpn',
103+
label: 'Zerops VPN',
104+
customProps: {
105+
icon: Icons['globe-europe'],
106+
description: 'Connect to your KeyDB service securely with Zerops VPN.',
107+
},
108+
},
109+
]}
110+
/>
111+
112+
*Need help? Join our [Discord community](https://discord.gg/zeropsio).*

‎apps/docs/static/llms-full.txt

Lines changed: 185 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26377,10 +26377,189 @@ Zerops doesn't scale KeyDB service horizontally, it means no containers are adde
2637726377
Zerops provides information about how much hardware resources the KeyDB service is currently using. Go to KeyDB service detail in Zerops GUI and select **Service dashboard & database containers** in the left menu. Zerops also provides the history of resource usage.
2637826378

2637926379

26380-
---
26381-
title: KeyDB overview
26382-
description: Learn about working with KeyDB with ease on Zerops.
26383-
---
26380+
26381+
26382+
[KeyDB ↗](https://docs.keydb.dev/) is a fully open source database, a faster drop-in alternative to Redis. It offers enhanced performance, multithreading capabilities, and maintains full compatibility with Redis clients and APIs.
26383+
26384+
:::important
26385+
While KeyDB is available on Zerops, please note that KeyDB development has not been very active recently. For new Redis-compatible deployments, we recommend considering [Valkey](https://valkey.io/) as the preferred alternative due to its active development and ongoing support.
26386+
:::
26387+
26388+
## Feature Highlights
26389+
26390+
<DocCardList
26391+
colSize={4}
26392+
items={[
26393+
{
26394+
type: 'link',
26395+
href: '/keydb/how-to/create',
26396+
label: 'Create KeyDB service',
26397+
customProps: {
26398+
icon: Icons['computer-desktop'],
26399+
description:
26400+
'Start with creating a KeyDB service using GUI or zCLI.',
26401+
},
26402+
},
26403+
{
26404+
type: 'link',
26405+
href: '/keydb/how-to/create#highly-available',
26406+
label: 'HA mode',
26407+
customProps: {
26408+
icon: Icons['squares-plus'],
26409+
description: 'Learn how to setup your database to be production-ready with high availability.',
26410+
},
26411+
},
26412+
{
26413+
type: 'link',
26414+
href: '/keydb/how-to/create#full-example',
26415+
label: 'Import config file',
26416+
customProps: {
26417+
icon: Icons['puzzle'],
26418+
description: 'Use an example config file to import your KeyDB service.',
26419+
},
26420+
},
26421+
]}
26422+
/>
26423+
26424+
### Connect to KeyDB service
26425+
26426+
<DocCardList
26427+
colSize={4}
26428+
items={[
26429+
{
26430+
type: 'link',
26431+
href: '/keydb/how-to/manage',
26432+
label: 'Manage KeyDB database',
26433+
customProps: {
26434+
icon: Icons['circle-stack'],
26435+
},
26436+
},
26437+
{
26438+
type: 'link',
26439+
href: '/keydb/how-to/connect#connect-to-keydb-from-runtime-services-of-the-same-project',
26440+
label: 'Connect from the same project',
26441+
customProps: {
26442+
icon: Icons['link'],
26443+
},
26444+
},
26445+
{
26446+
type: 'link',
26447+
href: '/keydb/how-to/connect#connect-to-keydb-in-zerops-remotely',
26448+
label: 'Connect remotely',
26449+
customProps: {
26450+
icon: Icons['globe-europe'],
26451+
},
26452+
},
26453+
]}
26454+
/>
26455+
26456+
### Service Management
26457+
26458+
<DocCardList
26459+
colSize={6}
26460+
items={[
26461+
{
26462+
type: 'link',
26463+
href: '/keydb/how-to/scale',
26464+
label: 'Scale KeyDB service',
26465+
customProps: {
26466+
icon: Icons['adjustments'],
26467+
},
26468+
},
26469+
{
26470+
type: 'link',
26471+
href: '/keydb/how-to/stop-start',
26472+
label: 'Stop and start service',
26473+
customProps: {
26474+
icon: Icons['pause'],
26475+
},
26476+
},
26477+
]}
26478+
/>
26479+
26480+
### Additional Operations
26481+
26482+
<DocCardList
26483+
colSize={6}
26484+
items={[
26485+
{
26486+
type: 'link',
26487+
href: '/keydb/how-to/delete',
26488+
label: 'Delete KeyDB service',
26489+
customProps: {
26490+
icon: Icons['trash'],
26491+
},
26492+
},
26493+
{
26494+
type: 'link',
26495+
href: '/keydb/how-to/use-environment-variables',
26496+
label: 'Use environment variables',
26497+
customProps: {
26498+
icon: Icons['variable'],
26499+
},
26500+
},
26501+
]}
26502+
/>
26503+
26504+
## When in doubt, reach out
26505+
26506+
Don't know how to start or got stuck during the process? You might not be the first one, visit the FAQ section to find out.
26507+
26508+
In case you haven't found an answer (and also if you have), we and our community are looking forward to hearing from you on Discord.
26509+
26510+
Have you built something that others might find useful? Don't hesitate to share your knowledge!
26511+
26512+
<DocCardList
26513+
colSize={6}
26514+
items={[
26515+
{
26516+
type: 'link',
26517+
href: '/keydb/faq',
26518+
label: 'FAQ',
26519+
customProps: {
26520+
icon: Icons['chat-bubble-left-right'],
26521+
description: 'Most common questions in one place.',
26522+
},
26523+
},
26524+
{
26525+
type: 'link',
26526+
href: 'https://discord.com/invite/WDvCZ54',
26527+
label: 'Discord',
26528+
customProps: {
26529+
icon: Icons['discord'],
26530+
description:
26531+
'Join our core team and Zerops community on Discord. Ask questions and share your tips with other members.',
26532+
},
26533+
},
26534+
]}
26535+
/>
26536+
26537+
## Popular Guides
26538+
26539+
<DocCardList
26540+
colSize={6}
26541+
items={[
26542+
{
26543+
type: 'link',
26544+
href: '/references/cli',
26545+
label: 'zCLI',
26546+
customProps: {
26547+
icon: Icons['command-line'],
26548+
description:
26549+
'Get even more out of Zerops with the zCLI command line tool.',
26550+
},
26551+
},
26552+
{
26553+
type: 'link',
26554+
href: '/references/vpn',
26555+
label: 'Zerops VPN',
26556+
customProps: {
26557+
icon: Icons['globe-europe'],
26558+
description: 'Connect to your KeyDB service securely with Zerops VPN.',
26559+
},
26560+
},
26561+
]}
26562+
/>
2638426563

2638526564

2638626565

@@ -37607,8 +37786,8 @@ You can securely connect to PostgreSQL from your local workstation via Zerops VP
3760737786
4. When finished, [stop the Zerops VPN](/references/vpn#stop-vpn)
3760837787

3760937788
:::warning Important notes
37610-
* If your connection over VPN doesn't work, try adding `.zerops` suffix to the service hostname (e.g., `database1.zerops`). For additional help, check the [VPN troubleshooting page](/references/vpn/troubleshooting).
3761137789
* Do not use SSL/TLS protocols when connecting over VPN. Security is provided by the VPN tunnel.
37790+
* If your connection over VPN doesn't work, try adding `.zerops` suffix to the service hostname (e.g., `database1.zerops`). For additional help, check the [VPN troubleshooting page](/references/vpn/troubleshooting).
3761237791
:::
3761337792

3761437793
For database management tools and how to manage users and databases, see [Manage PostgreSQL Users and Databases](/postgresql/how-to/manage).
@@ -45547,10 +45726,6 @@ Upon connection, you'll have secure access to your project's private network wit
4554745726
- The VPN daemon maintains connection stability with automatic reconnection
4554845727
- Environment variables are not available through VPN connections
4554945728

45550-
:::caution Known issue
45551-
If your connection over VPN doesn't work, try adding `.zerops` suffix to the service hostname (e.g., `database1.zerops`). For additional help, check the [VPN troubleshooting page](/references/vpn/troubleshooting).
45552-
:::
45553-
4555445729
### Stop VPN
4555545730

4555645731
To stop the VPN session:
@@ -45602,7 +45777,7 @@ zcli vpn up
4560245777
could not translate host name "hostname" to address: nodename nor servname provided, or not known
4560345778
```
4560445779

45605-
* The issue is known to happen on macOS and rarely on Windows
45780+
* The issue is known to happen rarely on Windows
4560645781

4560745782
**Solution**: Append `.zerops` to the hostname, even when VPN shows as connected:
4560845783
```bash

0 commit comments

Comments
 (0)