docs: document all flags in readme

This commit is contained in:
Jose Diaz-Gonzalez
2020-05-14 23:37:57 -04:00
parent 19b4960ea2
commit d0060ad532
2 changed files with 59 additions and 6 deletions

View File

@@ -64,6 +64,14 @@ Help for any commands can be displayed by specifying the command as an argument
dokku mongo:create <service> [--create-flags...]
```
flags:
- `-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
- `-p|--password PASSWORD`: override the user-level service password
- `-r|--root-password PASSWORD`: override the root-level service password
Create a mongo service named lolipop:
```shell
@@ -92,6 +100,19 @@ dokku mongo:create lolipop
dokku mongo:info <service> [--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
@@ -133,6 +154,10 @@ dokku mongo:list
dokku mongo:logs <service> [-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
@@ -152,6 +177,11 @@ dokku mongo:logs lolipop --tail
dokku mongo:link <service> <app> [--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 mongo 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
@@ -348,6 +378,13 @@ dokku mongo:restart lolipop
dokku mongo:upgrade <service> [--upgrade-flags...]
```
flags:
- `-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
You can upgrade an existing service to a new image or image-version:
```shell
@@ -378,6 +415,14 @@ dokku mongo:app-links playground
dokku mongo:clone <service> <new-service> [--clone-flags...]
```
flags:
- `-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
- `-p|--password PASSWORD`: override the user-level service password
- `-r|--root-password PASSWORD`: override the root-level service password
You can clone an existing service to a new one:
```shell
@@ -518,6 +563,10 @@ dokku mongo:backup-deauth lolipop
dokku mongo:backup <service> <bucket-name> [--use-iam]
```
flags:
- `-u|--use-iam`: use the IAM profile associated with the current server
Backup the 'lolipop' service to the 'my-s3-bucket' bucket on aws:
```shell
@@ -557,6 +606,10 @@ dokku mongo:backup-unset-encryption lolipop
dokku mongo:backup-schedule <service> <schedule> <bucket-name> [--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

View File

@@ -226,12 +226,12 @@ def command_help(command, service, alias, scheme, ports, unimplemented):
# for argument in data["arguments"]:
# content.append(f"- {argument}")
# if len(data["flags"]) > 0:
# content.append("")
# content.append("flags:")
# content.append("")
# for flag in data["flags"]:
# content.append(f"- {flag}")
if len(data["flags"]) > 0:
content.append("")
content.append("flags:")
content.append("")
for flag in data["flags"]:
content.append(f"- {flag}")
if len(data["examples"]) > 0:
content.append("")