-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expand on the datastore explanation (#298)
* Expand on the datastore explanation Signed-off-by: manuelbuil <[email protected]> --------- Signed-off-by: manuelbuil <[email protected]>
- Loading branch information
1 parent
f81545e
commit 049f99a
Showing
4 changed files
with
60 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
title: Embedded datastore | ||
--- | ||
|
||
Using an embedded datastore means leveraging a database that runs within the Kubernetes cluster, typically as a containerized service, e.g. etcd. This option simplifies deployment and could improve performance and security. The alternative is [external databases](external.md) | ||
|
||
## Datastore options | ||
|
||
:::warning Experimental | ||
RKE2 officially supports Embedded etcd, embedded SQLite is considered experimental | ||
::: | ||
|
||
* **Embedded [Etcd](https://etcd.io/)** | ||
Embedded Etcd is the default datastore, and will be used if no other datastore configuration is present. | ||
* **Embedded [SQLite](https://www.sqlite.org/index.html)** | ||
SQLite cannot be used on clusters with multiple servers. It uses project [kine](https://github.com/k3s-io/kine) | ||
|
||
|
||
|
||
## Embedded [Etcd](https://etcd.io/) | ||
|
||
Embedded Etcd is the default datastore, and will be used if no other datastore configuration is present. It is the only embedded option that allows to deploy RKE2 in [HA mode](../install/ha.md). Unless explicitely unset, one etcd pod will be deployed per RKE2 server and all the etcd instances will maintain a quorum. RKE2 includes tools to easily create snapshots when using this datastore as explained in the [backup/restore](backup_restore.md). | ||
|
||
|
||
## Embedded [SQLite](https://www.sqlite.org/index.html) | ||
|
||
This embedded option is not recommended for production but can be useful if you need to run a simple, short-lived cluster, for example in a CI/CD environment. HA mode is not supported when deploying with SQLite. | ||
|
||
### Single Server with SQLite | ||
|
||
1. Set `disable-etcd` without the `server` parameter in the config file | ||
|
||
```yaml | ||
disable-etcd: true | ||
``` | ||
2. Install RKE2 | ||
```bash | ||
curl -sfL https://get.rke2.io | sh - | ||
``` | ||
|
||
3. Enable rke2-server service | ||
```sh | ||
systemctl enable rke2-server.service | ||
``` | ||
|
||
4. start the rke2-server service | ||
|
||
```sh | ||
systemctl start rke2-server.service | ||
``` | ||
|
||
You can follow the server starting by `kubectl get nodes` to see the server get the `Ready` status. See [Cluster access](../cluster_access.md) for more info about how to access RKE2. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
i18n/zh/docusaurus-plugin-content-docs/current/datastore/embedded.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
该页面尚未翻译 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters