Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Jarrodsz/dokku-edgedb

an edgedb plugin for dokku
https://github.com/Jarrodsz/dokku-edgedb

Last synced: 2 months ago
JSON representation

an edgedb plugin for dokku

Host: GitHub
URL: https://github.com/Jarrodsz/dokku-edgedb
Owner: Jarrodsz
License: mit
Created: 2022-11-26T13:02:57.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-03-23T08:13:08.000Z (almost 2 years ago)
Last Synced: 2024-05-21T12:47:47.853Z (8 months ago)
Language: Shell
Homepage:
Size: 85.9 KB
Stars: 10
Watchers: 4
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome-edgedb - EdgeDB Dokku Plugin - A plugin for Dokku that provides EdgeDB related commands. (Integrations)

README

# dokku edgedb

Unofficial edgedb plugin for dokku. Currently defaults to installing [edgedb/edgedb nightly](https://hub.docker.com/r/edgedb/edgedb/).

## Requirements

- dokku 0.19.x+
- docker 1.8.x

## How it works

Since edgedb can be connected only by an authenticated client (TLS certificates MUST be
present), this plugin will create an edgedb credentials file and add the
`EDGEDB_CREDENTIALS_FILE` configuration to the app. All edgedb clients can automatically
use this to connect to the edgedb server.

## Important notes

- The edgedb server usually requires more than 2GB of RAM to _**start**_ (not run). If you do not have
enough RAM, you will have to create a swap file. Please refer to tutorials online on how to
do this.

## Installation

```shell
# on 0.19.x+
sudo dokku plugin:install https://github.com/ignisda/dokku-edgedb.git edgedb
```

## Commands

```
edgedb:app-links
edgedb:backup
edgedb:backup-auth
edgedb:backup-deauth
edgedb:backup-schedule
edgedb:backup-schedule-cat
edgedb:backup-
edgedb:backup-unschedule
edgedb:backup-
edgedb:clone
edgedb:connect
edgedb:create
edgedb:destroy
edgedb:enter
edgedb:exists
edgedb:export
edgedb:expose
edgedb:import
edgedb:info
edgedb:link
edgedb:linked
edgedb:links
edgedb:list
edgedb:logs
edgedb:pause
edgedb:promote
edgedb:restart
edgedb:start
edgedb:stop
edgedb:unexpose
edgedb:unlink
edgedb:upgrade
``` # list all edgedb service links for a given app [--use-iam] # create a backup of the edgedb service to an existing s3 bucket # set up authentication for backups on the edgedb service # remove backup authentication for the edgedb service [--use-iam] # schedule a backup of the edgedb service # cat the contents of the configured backup cronfile for the service set-encryption # set encryption for all future backups of edgedb service # unschedule the backup of the edgedb service unset-encryption # unset encryption for future backups of the edgedb service [--clone-flags...] # create container then copy data from into # connect to the service via the edgedb connection tool [--create-flags...] # create a edgedb service [-f|--force] # delete the edgedb service/data/container if there are no links left # enter or run a command in a running edgedb service container # check if the edgedb service exists # export a dump of the edgedb service database # expose a edgedb service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified) # import a dump into the edgedb service database [--single-info-flag] # print the service information [--link-flags...] # link the edgedb service to the app # check if the edgedb service is linked to an app # list all apps linked to the edgedb service # list all edgedb services [-t|--tail] # print the most recent log(s) for this service # pause a running edgedb service # promote service as EDGEDB_URL in # graceful shutdown and restart of the edgedb service container # start a previously stopped edgedb service # stop a running edgedb service # unexpose a previously exposed edgedb service # unlink the edgedb service from the app [--upgrade-flags...] # upgrade service to the specified versions

## Usage

Help for any commands can be displayed by specifying the command as an argument to edgedb:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `edgedb:help` command for any undocumented commands.

### Basic Usage

### create a edgedb service

```shell
# usage
dokku edgedb:create [--create-flags...]
```

flags:

- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
- `-p|--password PASSWORD`: override the user-level service password
- `-r|--root-password PASSWORD`: override the root-level service password
- `-s|--shm-size SHM_SIZE`: override shared memory size for edgedb docker container

Create a edgedb service named lollipop:

```shell
dokku edgedb:create lollipop
```

You can also specify the image and image version to use for the service. It *must* be compatible with the edgedb/edgedb image.

```shell
export EDGEDB_IMAGE="edgedb/edgedb"
export EDGEDB_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
dokku edgedb:create lollipop
```

You can also specify custom environment variables to start the edgedb service in semi-colon separated form.

```shell
export EDGEDB_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku edgedb:create lollipop
```

### print the service information

```shell
# usage
dokku edgedb:info [--single-info-flag]
```

flags:

- `--config-dir`: show the service configuration directory
- `--data-dir`: show the service data directory
- `--dsn`: show the service DSN
- `--exposed-ports`: show service exposed ports
- `--id`: show the service container id
- `--internal-ip`: show the service internal ip
- `--links`: show the service app links
- `--service-root`: show the service root directory
- `--status`: show the service running status
- `--version`: show the service image version

Get connection information as follows:

```shell
dokku edgedb:info lollipop
```

You can also retrieve a specific piece of service info via flags:

```shell
dokku edgedb:info lollipop --config-dir
dokku edgedb:info lollipop --data-dir
dokku edgedb:info lollipop --dsn
dokku edgedb:info lollipop --exposed-ports
dokku edgedb:info lollipop --id
dokku edgedb:info lollipop --internal-ip
dokku edgedb:info lollipop --links
dokku edgedb:info lollipop --service-root
dokku edgedb:info lollipop --status
dokku edgedb:info lollipop --version
```

### list all edgedb services

```shell
# usage
dokku edgedb:list
```

List all services:

```shell
dokku edgedb:list
```

### print the most recent log(s) for this service

```shell
# usage
dokku edgedb:logs [-t|--tail]
```

flags:

- `-t|--tail []`: do not stop when end of the logs are reached and wait for additional output

You can tail logs for a particular service:

```shell
dokku edgedb:logs lollipop
```

By default, logs will not be tailed, but you can do this with the --tail flag:

```shell
dokku edgedb:logs lollipop --tail
```

The default tail setting is to show all logs, but an initial count can also be specified:

```shell
dokku edgedb:logs lollipop --tail 5
```

### link the edgedb service to the app

```shell
# usage
dokku edgedb:link [--link-flags...]
```

flags:

- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link

A edgedb service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our `playground` app.

> NOTE: this will restart your app

```shell
dokku edgedb:link lollipop playground
```

The following environment variables will be set automatically by docker (not on the app itself, so they won’t be listed when calling dokku config):

```
DOKKU_EDGEDB_LOLLIPOP_NAME=/lollipop/DATABASE
DOKKU_EDGEDB_LOLLIPOP_PORT=tcp://172.17.0.1:5656
DOKKU_EDGEDB_LOLLIPOP_PORT_5656_TCP=tcp://172.17.0.1:5656
DOKKU_EDGEDB_LOLLIPOP_PORT_5656_TCP_PROTO=tcp
DOKKU_EDGEDB_LOLLIPOP_PORT_5656_TCP_PORT=5656
DOKKU_EDGEDB_LOLLIPOP_PORT_5656_TCP_ADDR=172.17.0.1
```

The host exposed here only works internally in docker containers. If you want your container to be reachable from outside, you should use the `expose` subcommand. Another service can be linked to your app:

```shell
dokku edgedb:link other_service playground
```

It is possible to change the protocol for `EDGEDB_URL` by setting the environment variable `EDGEDB_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.

```shell
dokku config:set playground EDGEDB_DATABASE_SCHEME=edgedb2
dokku edgedb:link lollipop playground
```

### unlink the edgedb service from the app

```shell
# usage
dokku edgedb:unlink
```

You can unlink a edgedb service:

> NOTE: this will restart your app and unset related environment variables

```shell
dokku edgedb:unlink lollipop playground
```

### Service Lifecycle

The lifecycle of each service can be managed through the following commands:

### connect to the service via the edgedb connection tool

```shell
# usage
dokku edgedb:connect
```

Connect to the service via the edgedb connection tool:

> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098

```shell
dokku edgedb:connect lollipop
```

### enter or run a command in a running edgedb service container

```shell
# usage
dokku edgedb:enter
```

A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.

> NOTE: disconnecting from ssh while running this command may leave zombie processes due to moby/moby#9098

```shell
dokku edgedb:enter lollipop
```

You may also run a command directly against the service. Filesystem changes will not be saved to disk.

```shell
dokku edgedb:enter lollipop touch /tmp/test
```

### expose a edgedb service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)

```shell
# usage
dokku edgedb:expose
```

Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):

```shell
dokku edgedb:expose lollipop 5656
```

Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1):

```shell
dokku edgedb:expose lollipop 127.0.0.1:5656
```

### unexpose a previously exposed edgedb service

```shell
# usage
dokku edgedb:unexpose
```

Unexpose the service, removing access to it from the public interface (`0.0.0.0`):

```shell
dokku edgedb:unexpose lollipop
```

### promote service as EDGEDB_URL in

```shell
# usage
dokku edgedb:promote
```

If you have a edgedb service linked to an app and try to link another edgedb service another link environment variable will be generated automatically:

```
DOKKU_EDGEDB_BLUE_URL=edgedb://other_service:ANOTHER_PASSWORD@dokku-edgedb-other-service:5656/other_service
```

You can promote the new service to be the primary one:

> NOTE: this will restart your app

```shell
dokku edgedb:promote other_service playground
```

This will replace `EDGEDB_URL` with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:

```
EDGEDB_URL=edgedb://other_service:ANOTHER_PASSWORD@dokku-edgedb-other-service:5656/other_service
DOKKU_EDGEDB_BLUE_URL=edgedb://other_service:ANOTHER_PASSWORD@dokku-edgedb-other-service:5656/other_service
DOKKU_EDGEDB_SILVER_URL=edgedb://lollipop:SOME_PASSWORD@dokku-edgedb-lollipop:5656/lollipop
```

### start a previously stopped edgedb service

```shell
# usage
dokku edgedb:start
```

Start the service:

```shell
dokku edgedb:start lollipop
```

### stop a running edgedb service

```shell
# usage
dokku edgedb:stop
```

Stop the service and removes the running container:

```shell
dokku edgedb:stop lollipop
```

### pause a running edgedb service

```shell
# usage
dokku edgedb:pause
```

Pause the running container for the service:

```shell
dokku edgedb:pause lollipop
```

### graceful shutdown and restart of the edgedb service container

```shell
# usage
dokku edgedb:restart
```

Restart the service:

```shell
dokku edgedb:restart lollipop
```

### upgrade service to the specified versions

```shell
# usage
dokku edgedb:upgrade [--upgrade-flags...]
```

flags:

- `-c|--config-options "--args --go=here"`: extra arguments to pass to the container create command (default: `None`)
- `-C|--custom-env "USER=alpha;HOST=beta"`: semi-colon delimited environment variables to start the service with
- `-i|--image IMAGE`: the image name to start the service with
- `-I|--image-version IMAGE_VERSION`: the image version to start the service with
- `-R|--restart-apps "true"`: whether to force an app restart
- `-s|--shm-size SHM_SIZE`: override shared memory size for edgedb docker container

You can upgrade an existing service to a new image or image-version:

```shell
dokku edgedb:upgrade lollipop
```

### Service Automation

Service scripting can be executed using the following commands:

### list all edgedb service links for a given app

```shell
# usage
dokku edgedb:app-links
```

List all edgedb services that are linked to the `playground` app.

```shell
dokku edgedb:app-links playground
```

### create container then copy data from into

```shell
# usage
dokku edgedb:clone [--clone-flags...]
```

flags:

You can clone an existing service to a new one:

```shell
dokku edgedb:clone lollipop lollipop-2
```

### check if the edgedb service exists

```shell
# usage
dokku edgedb:exists
```

Here we check if the lollipop edgedb service exists.

```shell
dokku edgedb:exists lollipop
```

### check if the edgedb service is linked to an app

```shell
# usage
dokku edgedb:linked
```

Here we check if the lollipop edgedb service is linked to the `playground` app.

```shell
dokku edgedb:linked lollipop playground
```

### list all apps linked to the edgedb service

```shell
# usage
dokku edgedb:links
```

List all apps linked to the `lollipop` edgedb service.

```shell
dokku edgedb:links lollipop
```

### Data Management

The underlying service data can be imported and exported with the following commands:

### import a dump into the edgedb service database

```shell
# usage
dokku edgedb:import
```

Import a datastore dump:

```shell
dokku edgedb:import lollipop /tmp/data.dump
```

### export a dump of the edgedb service database

```shell
# usage
dokku edgedb:export
```

By default, datastore output is exported to stdout:

```shell
dokku edgedb:export lollipop
```

You can redirect this output to a file:

```shell
dokku edgedb:export lollipop > data.dump
```

### Backups

Datastore backups are supported via AWS S3 and S3 compatible services like [minio](https://github.com/minio/minio).

You may skip the `backup-auth` step if your dokku install is running within EC2 and has access to the bucket via an IAM profile. In that case, use the `--use-iam` option with the `backup` command.

Backups can be performed using the backup commands:

### set up authentication for backups on the edgedb service

```shell
# usage
dokku edgedb:backup-auth
```

Setup s3 backup authentication:

```shell
dokku edgedb:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY
```

Setup s3 backup authentication with different region:

```shell
dokku edgedb:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
```

Setup s3 backup authentication with different signature version and endpoint:

```shell
dokku edgedb:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
```

More specific example for minio auth:

```shell
dokku edgedb:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
```

### remove backup authentication for the edgedb service

```shell
# usage
dokku edgedb:backup-deauth
```

Remove s3 authentication:

```shell
dokku edgedb:backup-deauth lollipop
```

### create a backup of the edgedb service to an existing s3 bucket

```shell
# usage
dokku edgedb:backup [--use-iam]
```

flags:

- `-u|--use-iam`: use the IAM profile associated with the current server

Backup the `lollipop` service to the `my-s3-bucket` bucket on `AWS`:`

```shell
dokku edgedb:backup lollipop my-s3-bucket --use-iam
```

Restore a backup file (assuming it was extracted via `tar -xf backup.tgz`):

```shell
dokku edgedb:import lollipop < backup-folder/export
```

### set encryption for all future backups of edgedb service

```shell
# usage
dokku edgedb:backup-set-encryption
```

Set the GPG-compatible passphrase for encrypting backups for backups:

```shell
dokku edgedb:backup-set-encryption lollipop
```

### unset encryption for future backups of the edgedb service

```shell
# usage
dokku edgedb:backup-unset-encryption
```

Unset the `GPG` encryption passphrase for backups:

```shell
dokku edgedb:backup-unset-encryption lollipop
```

### schedule a backup of the edgedb service

```shell
# usage
dokku edgedb:backup-schedule [--use-iam]
```

flags:

- `-u|--use-iam`: use the IAM profile associated with the current server

Schedule a backup:

> 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am

```shell
dokku edgedb:backup-schedule lollipop "0 3 * * *" my-s3-bucket
```

Schedule a backup and authenticate via iam:

```shell
dokku edgedb:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam
```

### cat the contents of the configured backup cronfile for the service

```shell
# usage
dokku edgedb:backup-schedule-cat
```

Cat the contents of the configured backup cronfile for the service:

```shell
dokku edgedb:backup-schedule-cat lollipop
```

### unschedule the backup of the edgedb service

```shell
# usage
dokku edgedb:backup-unschedule
```

Remove the scheduled backup from cron:

```shell
dokku edgedb:backup-unschedule lollipop
```

### Disabling `docker pull` calls

If you wish to disable the `docker pull` calls that the plugin triggers, you may set the `EDGEDB_DISABLE_PULL` environment variable to `true`. Once disabled, you will need to pull the service image you wish to deploy as shown in the `stderr` output.

Please ensure the proper images are in place when `docker pull` is disabled.