Skip to content

Commit

Permalink
Update SQLite docs (#107)
Browse files Browse the repository at this point in the history 

---------

Co-authored-by: braginini <[email protected]>
  • Loading branch information
@mlsmaycon @braginini
mlsmaycon and braginini authored Oct 19, 2023
1 parent 0506de9 commit 8046bee
Show file tree
Hide file tree
Showing 2 changed files with 110 additions and 39 deletions.
3 changes: 1 addition & 2 deletions src/components/NavigationDocs.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ export const docsNavigation = [
links: [
{ title: 'Quickstart guide', href: '/selfhosted/selfhosted-quickstart' },
{ title: 'Advanced guide', href: '/selfhosted/selfhosted-guide' },
// hide the sqlite guid as this is work in progress
//{ title: 'Management SQLite Store', href: '/selfhosted/sqlite-store'},
{ title: 'Management SQLite Store', href: '/selfhosted/sqlite-store'},
{ title: 'Supported IdPs', href: '/selfhosted/identity-providers' },
],
},
Expand Down
146 changes: 109 additions & 37 deletions src/pages/selfhosted/sqlite-store.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,39 +1,51 @@
# Management SQLite Store
# Management SQLite store

In NetBird, the management system traditionally relies on JSON file storage.
Starting from version 0.24.0, we have introduced **experimental** support for SQLite.
In NetBird, the Management system traditionally relies on JSON file storage.
Starting from version [0.24.0](https://github.com/netbirdio/netbird/releases/tag/v0.24.0), we have introduced **experimental** support for SQLite.
This addition aims to provide users with enhanced performance and scalability options.

## SQLite Entity Relationship Diagram
## SQLite entity relationship diagram

For a high-level overview of the SQLite schema, refer to the Entity Relationship Diagram (ERD) below:

<p>
<img src="/docs-static/img/selfhosted/sqlite-erd.png" alt="high-level-dia" className="imagewrapper"/>
</p>

## Using SQLite for Fresh Installations
## Using SQLite for fresh installations

As of version 0.24.0, the default configuration for fresh installations is JSON file storage.
However, users have the option to leverage the benefits of SQLite for new instances.
To enable SQLite, update your management.json as follows:

```json
"StoreKind": "Sqlite",
To enable SQLite, add to your setup.env the following variable:
```bash
NETBIRD_STORE_CONFIG_ENGINE=sqlite
```

Alternatively, you can explicitly set the store to JSON file storage:

This will result in a configuration similar to the following in your management.json file:
```json
"StoreKind": "JsonFile",
"StoreConfig": {
"Engine": "sqlite"
}
```

## Migration from JSON Store

Starting from version 0.24.0, NetBird management provides a subcommand to facilitate migration to SQLite:

You can switch back to JSON file storage by setting the `NETBIRD_STORE_CONFIG_ENGINE` variable to `jsonfile`.
<Note>
Switching between storage options requires migration steps to prevent data loss.
</Note>

## Migrating from JSON store to SQLite store
This migration process allows users to seamlessly transition between storage options while maintaining data integrity.
Ensure that you are running the commands described below after upgrading to version 0.24.0 or later.

### Migration commands

Starting from version 0.24.0, NetBird Management provides a subcommand to facilitate migration to SQLite. This command is part of the binary shipped within the official docker image.
<Note>
The following commands assume you use the latest docker version with the compose plugin. If you have docker-compose installed as a standalone, please use docker-compose as a command.
</Note>
```bash
$ docker compose exec management /go/bin/netbird-mgmt sqlite-migration
```
$ netbird-mgmt sqlite-migration
This will produce an output similar to:
```bash
Contains sub-commands to perform JSON file store to SQLite store migration and rollback

Usage:
Expand All @@ -54,24 +66,84 @@ Global Flags:
Use "netbird-mgmt sqlite-migration [command] --help" for more information about a command.
```

Follow these steps for migration:

1. Stop NetBird management service.
### Follow these steps for migration:
To migrate from JSON file store to SQLite, follow these steps:
<Note>
The following commands assume you use the latest docker version with the compose plugin. If you have docker-compose installed as a standalone, please use docker-compose as a command.
</Note>
1. After accessing the path that contains your docker-compose.yml and management.json files, stop the NetBird Management service.
```bash
docker compose stop management
```
2. Backup your data store (`store.json` in `datadir` - default "/var/lib/netbird/").
3. Run the migration to SQLite subcommand. Example: `netbird-mgmt sqlite-migration upgrade --log-file console`
4. Enable SQLite in management following [the instruction in the previous section](#using-sq-lite-for-fresh-installations).
5. Run NetBird management service.


## Rollback to JSON File Store
```bash
mkdir backup
docker compose cp -a management:/var/lib/netbird/ backup/
```
3. Start NetBird Management service:
```bash
docker compose start management
```
4. Run the migration to SQLite subcommand:
```bash
docker compose exec management /go/bin/netbird-mgmt sqlite-migration upgrade --log-file console
```
5. Enable SQLite by updating the management.json file and setting the `Engine` field to `sqlite` as the following example:
```json
"StoreConfig": {
"Engine": "sqlite"
}
```
6. Restart the Management service.
```bash
docker compose restart management
```
7. Check logs to confirm the store switch:
```bash
docker compose logs management
```
You should see an entry similar to:
```
2023-10-19T18:55:29Z INFO management/server/store.go:75: using SQLite store engine
```

### Rollback to JSON file store
To rollback to the JSON file store, follow these steps:

1. Stop the NetBird management service.
2. Backup your SQLite data store (`store.db` in `datadir` - default "/var/lib/netbird/").
3. Run the rollback to JSON file subcommand (Example: `netbird-mgmt sqlite-migration downgrade --log-file console`).
4. Enable JSON file store in management following [the instructions for fresh installations](#using-sq-lite-for-fresh-installations).
5. Restart the NetBird management service.

This migration process allows users to seamlessly transition between storage options while maintaining data integrity.
Ensure you perform backups before any migration or rollback operations.
<Note>
The following commands assume you use the latest docker version with the compose plugin. If you have docker-compose installed as a standalone, please use docker-compose as a command.
</Note>
1. After accessing the path that contains your docker-compose.yml and management.json files, stop the NetBird Management service.
```bash
docker compose stop management
```
2. Backup your data store (`store.db` in `datadir` - default "/var/lib/netbird/").
```bash
mkdir backup
docker compose cp -a management:/var/lib/netbird/ backup/
```
3. Start NetBird Management service:
```bash
docker compose start management
```
4. Run the migration to SQLite subcommand:
```bash
docker compose exec management /go/bin/netbird-mgmt sqlite-migration downgrade --log-file console
```
5. Enable JSON file by updating the management.json file and setting the `Engine` field to `jsonfile` as the following example:
```json
"StoreConfig": {
"Engine": "jsonfile
}
```
6. Restart the Management service.
```bash
docker compose restart management
```
7. Check logs to confirm the store switch:
```bash
docker compose logs management
```
You should see an entry similar to:
```
2023-10-19T18:55:29Z INFO management/server/store.go:72: using JSON file store engine
```

0 comments on commit 8046bee

Please sign in to comment.