From d72138aad37bc915b6df7c7fe3c9530d29813695 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Mon, 13 Sep 2021 00:57:34 -0400 Subject: [PATCH] docs: properly spell lollipop I've been misspelling my stand-in variable name for years... --- README.md | 126 ++++++++++++++-------------- subcommands/backup | 6 +- subcommands/backup-auth | 8 +- subcommands/backup-deauth | 2 +- subcommands/backup-schedule | 4 +- subcommands/backup-schedule-cat | 2 +- subcommands/backup-set-encryption | 2 +- subcommands/backup-unschedule | 2 +- subcommands/backup-unset-encryption | 2 +- subcommands/clone | 2 +- subcommands/connect | 2 +- subcommands/create | 8 +- subcommands/destroy | 2 +- subcommands/enter | 4 +- subcommands/exists | 4 +- subcommands/export | 4 +- subcommands/expose | 4 +- subcommands/import | 2 +- subcommands/info | 22 ++--- subcommands/link | 20 ++--- subcommands/linked | 4 +- subcommands/links | 4 +- subcommands/logs | 4 +- subcommands/promote | 2 +- subcommands/restart | 2 +- subcommands/start | 2 +- subcommands/stop | 2 +- subcommands/unexpose | 2 +- subcommands/unlink | 2 +- subcommands/upgrade | 2 +- 30 files changed, 127 insertions(+), 127 deletions(-) diff --git a/README.md b/README.md index c59b088..4d4a144 100644 --- a/README.md +++ b/README.md @@ -74,10 +74,10 @@ flags: - `-r|--root-password PASSWORD`: override the root-level service password - `-s|--shm-size SHM_SIZE`: override shared memory size for postgres docker container -Create a postgres service named lolipop: +Create a postgres service named lollipop: ```shell -dokku postgres:create lolipop +dokku postgres:create lollipop ``` You can also specify the image and image version to use for the service. It *must* be compatible with the postgres image. @@ -85,14 +85,14 @@ You can also specify the image and image version to use for the service. It *mus ```shell export POSTGRES_IMAGE="postgres" export POSTGRES_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}" -dokku postgres:create lolipop +dokku postgres:create lollipop ``` You can also specify custom environment variables to start the postgres service in semi-colon separated form. ```shell export POSTGRES_CUSTOM_ENV="USER=alpha;HOST=beta" -dokku postgres:create lolipop +dokku postgres:create lollipop ``` ### print the service information @@ -118,22 +118,22 @@ flags: Get connection information as follows: ```shell -dokku postgres:info lolipop +dokku postgres:info lollipop ``` You can also retrieve a specific piece of service info via flags: ```shell -dokku postgres:info lolipop --config-dir -dokku postgres:info lolipop --data-dir -dokku postgres:info lolipop --dsn -dokku postgres:info lolipop --exposed-ports -dokku postgres:info lolipop --id -dokku postgres:info lolipop --internal-ip -dokku postgres:info lolipop --links -dokku postgres:info lolipop --service-root -dokku postgres:info lolipop --status -dokku postgres:info lolipop --version +dokku postgres:info lollipop --config-dir +dokku postgres:info lollipop --data-dir +dokku postgres:info lollipop --dsn +dokku postgres:info lollipop --exposed-ports +dokku postgres:info lollipop --id +dokku postgres:info lollipop --internal-ip +dokku postgres:info lollipop --links +dokku postgres:info lollipop --service-root +dokku postgres:info lollipop --status +dokku postgres:info lollipop --version ``` ### list all postgres services @@ -163,13 +163,13 @@ flags: You can tail logs for a particular service: ```shell -dokku postgres:logs lolipop +dokku postgres:logs lollipop ``` By default, logs will not be tailed, but you can do this with the --tail flag: ```shell -dokku postgres:logs lolipop --tail +dokku postgres:logs lollipop --tail ``` ### link the postgres service to the app @@ -189,24 +189,24 @@ A postgres service can be linked to a container. This will use native docker lin > NOTE: this will restart your app ```shell -dokku postgres:link lolipop playground +dokku postgres: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_POSTGRES_LOLIPOP_NAME=/lolipop/DATABASE -DOKKU_POSTGRES_LOLIPOP_PORT=tcp://172.17.0.1:5432 -DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP=tcp://172.17.0.1:5432 -DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP_PROTO=tcp -DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP_PORT=5432 -DOKKU_POSTGRES_LOLIPOP_PORT_5432_TCP_ADDR=172.17.0.1 +DOKKU_POSTGRES_LOLLIPOP_NAME=/lollipop/DATABASE +DOKKU_POSTGRES_LOLLIPOP_PORT=tcp://172.17.0.1:5432 +DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP=tcp://172.17.0.1:5432 +DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_PROTO=tcp +DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_PORT=5432 +DOKKU_POSTGRES_LOLLIPOP_PORT_5432_TCP_ADDR=172.17.0.1 ``` The following will be set on the linked application by default: ``` -DATABASE_URL=postgres://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop +DATABASE_URL=postgres://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop ``` 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: @@ -219,13 +219,13 @@ It is possible to change the protocol for `DATABASE_URL` by setting the environm ```shell dokku config:set playground POSTGRES_DATABASE_SCHEME=postgres2 -dokku postgres:link lolipop playground +dokku postgres:link lollipop playground ``` This will cause `DATABASE_URL` to be set as: ``` -postgres2://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop +postgres2://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop ``` ### unlink the postgres service from the app @@ -240,7 +240,7 @@ You can unlink a postgres service: > NOTE: this will restart your app and unset related environment variables ```shell -dokku postgres:unlink lolipop playground +dokku postgres:unlink lollipop playground ``` ### Service Lifecycle @@ -257,7 +257,7 @@ dokku postgres:connect Connect to the service via the postgres connection tool: ```shell -dokku postgres:connect lolipop +dokku postgres:connect lollipop ``` ### enter or run a command in a running postgres service container @@ -270,13 +270,13 @@ dokku postgres:enter A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk. ```shell -dokku postgres:enter lolipop +dokku postgres:enter lollipop ``` You may also run a command directly against the service. Filesystem changes will not be saved to disk. ```shell -dokku postgres:enter lolipop touch /tmp/test +dokku postgres:enter lollipop touch /tmp/test ``` ### expose a postgres service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified) @@ -289,13 +289,13 @@ dokku postgres:expose Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`): ```shell -dokku postgres:expose lolipop 5432 +dokku postgres:expose lollipop 5432 ``` Expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1): ```shell -dokku postgres:expose lolipop 127.0.0.1:5432 +dokku postgres:expose lollipop 127.0.0.1:5432 ``` ### unexpose a previously exposed postgres service @@ -308,7 +308,7 @@ dokku postgres:unexpose Unexpose the service, removing access to it from the public interface (`0.0.0.0`): ```shell -dokku postgres:unexpose lolipop +dokku postgres:unexpose lollipop ``` ### promote service as DATABASE_URL in @@ -337,7 +337,7 @@ This will replace `DATABASE_URL` with the url from other_service and generate an ``` DATABASE_URL=postgres://other_service:ANOTHER_PASSWORD@dokku-postgres-other-service:5432/other_service DOKKU_DATABASE_BLUE_URL=postgres://other_service:ANOTHER_PASSWORD@dokku-postgres-other-service:5432/other_service -DOKKU_DATABASE_SILVER_URL=postgres://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop +DOKKU_DATABASE_SILVER_URL=postgres://lollipop:SOME_PASSWORD@dokku-postgres-lollipop:5432/lollipop ``` ### start a previously stopped postgres service @@ -350,7 +350,7 @@ dokku postgres:start Start the service: ```shell -dokku postgres:start lolipop +dokku postgres:start lollipop ``` ### stop a running postgres service @@ -363,7 +363,7 @@ dokku postgres:stop Stop the service and the running container: ```shell -dokku postgres:stop lolipop +dokku postgres:stop lollipop ``` ### graceful shutdown and restart of the postgres service container @@ -376,7 +376,7 @@ dokku postgres:restart Restart the service: ```shell -dokku postgres:restart lolipop +dokku postgres:restart lollipop ``` ### upgrade service to the specified versions @@ -398,7 +398,7 @@ flags: You can upgrade an existing service to a new image or image-version: ```shell -dokku postgres:upgrade lolipop +dokku postgres:upgrade lollipop ``` ### Service Automation @@ -439,7 +439,7 @@ flags: You can clone an existing service to a new one: ```shell -dokku postgres:clone lolipop lolipop-2 +dokku postgres:clone lollipop lollipop-2 ``` ### check if the postgres service exists @@ -449,10 +449,10 @@ dokku postgres:clone lolipop lolipop-2 dokku postgres:exists ``` -Here we check if the lolipop postgres service exists. +Here we check if the lollipop postgres service exists. ```shell -dokku postgres:exists lolipop +dokku postgres:exists lollipop ``` ### check if the postgres service is linked to an app @@ -462,10 +462,10 @@ dokku postgres:exists lolipop dokku postgres:linked ``` -Here we check if the lolipop postgres service is linked to the `playground` app. +Here we check if the lollipop postgres service is linked to the `playground` app. ```shell -dokku postgres:linked lolipop playground +dokku postgres:linked lollipop playground ``` ### list all apps linked to the postgres service @@ -475,10 +475,10 @@ dokku postgres:linked lolipop playground dokku postgres:links ``` -List all apps linked to the `lolipop` postgres service. +List all apps linked to the `lollipop` postgres service. ```shell -dokku postgres:links lolipop +dokku postgres:links lollipop ``` ### Data Management @@ -495,7 +495,7 @@ dokku postgres:import Import a datastore dump: ```shell -dokku postgres:import lolipop < database.dump +dokku postgres:import lollipop < database.dump ``` ### export a dump of the postgres service database @@ -508,13 +508,13 @@ dokku postgres:export By default, datastore output is exported to stdout: ```shell -dokku postgres:export lolipop +dokku postgres:export lollipop ``` You can redirect this output to a file: ```shell -dokku postgres:export lolipop > lolipop.dump +dokku postgres:export lollipop > lollipop.dump ``` ### Backups @@ -535,25 +535,25 @@ dokku postgres:backup-auth Setup s3 backup authentication: ```shell -dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY +dokku postgres:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY ``` Setup s3 backup authentication with different region: ```shell -dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION +dokku postgres: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 postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL +dokku postgres: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 postgres:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE +dokku postgres:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE ``` ### remove backup authentication for the postgres service @@ -566,7 +566,7 @@ dokku postgres:backup-deauth Remove s3 authentication: ```shell -dokku postgres:backup-deauth lolipop +dokku postgres:backup-deauth lollipop ``` ### create a backup of the postgres service to an existing s3 bucket @@ -580,16 +580,16 @@ 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`:` +Backup the `lollipop` service to the `my-s3-bucket` bucket on `AWS`:` ```shell -dokku postgres:backup lolipop my-s3-bucket --use-iam +dokku postgres:backup lollipop my-s3-bucket --use-iam ``` Restore a backup file (assuming it was extracted via `tar -xf backup.tgz`): ```shell -dokku postgres:import lolipop < backup-folder/export +dokku postgres:import lollipop < backup-folder/export ``` ### set encryption for all future backups of postgres service @@ -602,7 +602,7 @@ dokku postgres:backup-set-encryption Set the GPG-compatible passphrase for encrypting backups for backups: ```shell -dokku postgres:backup-set-encryption lolipop +dokku postgres:backup-set-encryption lollipop ``` ### unset encryption for future backups of the postgres service @@ -615,7 +615,7 @@ dokku postgres:backup-unset-encryption Unset the `GPG` encryption passphrase for backups: ```shell -dokku postgres:backup-unset-encryption lolipop +dokku postgres:backup-unset-encryption lollipop ``` ### schedule a backup of the postgres service @@ -634,13 +634,13 @@ Schedule a backup: > 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am ```shell -dokku postgres:backup-schedule lolipop "0 3 * * *" my-s3-bucket +dokku postgres:backup-schedule lollipop "0 3 * * *" my-s3-bucket ``` Schedule a backup and authenticate via iam: ```shell -dokku postgres:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam +dokku postgres:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam ``` ### cat the contents of the configured backup cronfile for the service @@ -653,7 +653,7 @@ dokku postgres:backup-schedule-cat Cat the contents of the configured backup cronfile for the service: ```shell -dokku postgres:backup-schedule-cat lolipop +dokku postgres:backup-schedule-cat lollipop ``` ### unschedule the backup of the postgres service @@ -666,7 +666,7 @@ dokku postgres:backup-unschedule Remove the scheduled backup from cron: ```shell -dokku postgres:backup-unschedule lolipop +dokku postgres:backup-unschedule lollipop ``` ### Disabling `docker pull` calls diff --git a/subcommands/backup b/subcommands/backup index 51d1626..161c191 100755 --- a/subcommands/backup +++ b/subcommands/backup @@ -6,10 +6,10 @@ source "$PLUGIN_BASE_PATH/common/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-backup-cmd() { - #E backup the 'lolipop' service to the 'my-s3-bucket' bucket on AWS - #E dokku $PLUGIN_COMMAND_PREFIX:backup lolipop my-s3-bucket --use-iam + #E backup the 'lollipop' service to the 'my-s3-bucket' bucket on AWS + #E dokku $PLUGIN_COMMAND_PREFIX:backup lollipop my-s3-bucket --use-iam #E restore a backup file (assuming it was extracted via 'tar -xf backup.tgz') - #E dokku $PLUGIN_COMMAND_PREFIX:import lolipop < backup-folder/export + #E dokku $PLUGIN_COMMAND_PREFIX:import lollipop < backup-folder/export #F -u|--use-iam, use the IAM profile associated with the current server #A service, service to run command against #A bucket-name, name of the s3 bucket to upload backups to diff --git a/subcommands/backup-auth b/subcommands/backup-auth index a90d895..992b295 100755 --- a/subcommands/backup-auth +++ b/subcommands/backup-auth @@ -7,13 +7,13 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-backup-auth-cmd() { #E setup s3 backup authentication - #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY + #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY #E setup s3 backup authentication with different region - #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION + #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION #E setup s3 backup authentication with different signature version and endpoint - #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL + #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL #E more specific example for minio auth - #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE + #E dokku $PLUGIN_COMMAND_PREFIX:backup-auth lollipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE #A service, service to run command against #A access-key-id, an amazon AWS_ACCESS_KEY_ID #A aws-secret-access-key, an amazon AWS_SECRET_ACCESS_KEY diff --git a/subcommands/backup-deauth b/subcommands/backup-deauth index 85a2c2b..d1d70cd 100755 --- a/subcommands/backup-deauth +++ b/subcommands/backup-deauth @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-backup-deauth-cmd() { #E remove s3 authentication - #E dokku $PLUGIN_COMMAND_PREFIX:backup-deauth lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:backup-deauth lollipop #A service, service to run command against declare desc="remove backup authentication for the $PLUGIN_SERVICE service" local cmd="$PLUGIN_COMMAND_PREFIX:backup-deauth" argv=("$@") diff --git a/subcommands/backup-schedule b/subcommands/backup-schedule index d6c8b00..448f930 100755 --- a/subcommands/backup-schedule +++ b/subcommands/backup-schedule @@ -8,9 +8,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-backup-schedule-cmd() { #E schedule a backup #E > 'schedule' is a crontab expression, eg. "0 3 * * *" for each day at 3am - #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket + #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lollipop "0 3 * * *" my-s3-bucket #E schedule a backup and authenticate via iam - #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lolipop "0 3 * * *" my-s3-bucket --use-iam + #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule lollipop "0 3 * * *" my-s3-bucket --use-iam #F -u|--use-iam, use the IAM profile associated with the current server #A service, service to run command against #A schedule, a cron schedule to run backups on diff --git a/subcommands/backup-schedule-cat b/subcommands/backup-schedule-cat index eff6304..0e3f2df 100755 --- a/subcommands/backup-schedule-cat +++ b/subcommands/backup-schedule-cat @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-backup-schedule-cat-cmd() { #E cat the contents of the configured backup cronfile for the service - #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule-cat lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:backup-schedule-cat lollipop #A service, service to run command against declare desc="cat the contents of the configured backup cronfile for the service" local cmd="$PLUGIN_COMMAND_PREFIX:backup-schedule-cat" argv=("$@") diff --git a/subcommands/backup-set-encryption b/subcommands/backup-set-encryption index abe04de..3ad29e5 100755 --- a/subcommands/backup-set-encryption +++ b/subcommands/backup-set-encryption @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-backup-set-encryption-cmd() { #E set the GPG-compatible passphrase for encrypting backups for backups - #E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:backup-set-encryption lollipop #A service, service to run command against #A passphrase, a GPG-compatible passphrase declare desc="set encryption for all future backups of $PLUGIN_SERVICE service" diff --git a/subcommands/backup-unschedule b/subcommands/backup-unschedule index 999a273..c3d3e31 100755 --- a/subcommands/backup-unschedule +++ b/subcommands/backup-unschedule @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-backup-unschedule-cmd() { #E remove the scheduled backup from cron - #E dokku $PLUGIN_COMMAND_PREFIX:backup-unschedule lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:backup-unschedule lollipop #A service, service to run command against declare desc="unschedule the backup of the $PLUGIN_SERVICE service" local cmd="$PLUGIN_COMMAND_PREFIX:backup-unschedule" argv=("$@") diff --git a/subcommands/backup-unset-encryption b/subcommands/backup-unset-encryption index 066b883..f783220 100755 --- a/subcommands/backup-unset-encryption +++ b/subcommands/backup-unset-encryption @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-backup-unset-encryption-cmd() { #E unset the GPG encryption passphrase for backups - #E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-encryption lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:backup-unset-encryption lollipop #A service, service to run command against declare desc="unset encryption for future backups of the $PLUGIN_SERVICE service" local cmd="$PLUGIN_COMMAND_PREFIX:backup-unset-encryption" argv=("$@") diff --git a/subcommands/clone b/subcommands/clone index fe40599..e444478 100755 --- a/subcommands/clone +++ b/subcommands/clone @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-clone-cmd() { #E you can clone an existing service to a new one - #E dokku $PLUGIN_COMMAND_PREFIX:clone lolipop lolipop-2 + #E dokku $PLUGIN_COMMAND_PREFIX:clone lollipop lollipop-2 #A service, service to run command against #A new-service, name of new service #F -c|--config-options "--args --go=here", extra arguments to pass to the container create command diff --git a/subcommands/connect b/subcommands/connect index 8173faf..8f2a0d7 100755 --- a/subcommands/connect +++ b/subcommands/connect @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-connect-cmd() { #E connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool - #E dokku $PLUGIN_COMMAND_PREFIX:connect lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:connect lollipop #A service, service to run command against declare desc="connect to the service via the $PLUGIN_COMMAND_PREFIX connection tool" local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@") diff --git a/subcommands/create b/subcommands/create index cc88910..a2f5ef5 100755 --- a/subcommands/create +++ b/subcommands/create @@ -6,17 +6,17 @@ source "$PLUGIN_BASE_PATH/common/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-create-cmd() { - #E create a $PLUGIN_COMMAND_PREFIX service named lolipop - #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop + #E create a $PLUGIN_COMMAND_PREFIX service named lollipop + #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop #E you can also specify the image and image version to use for the service. #E it *must* be compatible with the ${PLUGIN_IMAGE} image. #E export ${PLUGIN_VARIABLE}_IMAGE="${PLUGIN_IMAGE}" #E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}" - #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop #E you can also specify custom environment variables to start #E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form. #E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta" - #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop #A service, service to run command against #F -c|--config-options "--args --go=here", extra arguments to pass to the container create command #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with diff --git a/subcommands/destroy b/subcommands/destroy index 570b1b5..e912058 100755 --- a/subcommands/destroy +++ b/subcommands/destroy @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-destroy-cmd() { #E destroy the service, it's data, and the running container - #E dokku $PLUGIN_COMMAND_PREFIX:destroy lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:destroy lollipop #A service, service to run command against #F -f|--force, force destroy without asking for confirmation declare desc="delete the $PLUGIN_SERVICE service/data/container if there are no links left" diff --git a/subcommands/enter b/subcommands/enter index d706eec..bfe9f50 100755 --- a/subcommands/enter +++ b/subcommands/enter @@ -8,10 +8,10 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-enter-cmd() { #E a bash prompt can be opened against a running service. #E filesystem changes will not be saved to disk. - #E dokku $PLUGIN_COMMAND_PREFIX:enter lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:enter lollipop #E you may also run a command directly against the service. #E filesystem changes will not be saved to disk. - #E dokku $PLUGIN_COMMAND_PREFIX:enter lolipop touch /tmp/test + #E dokku $PLUGIN_COMMAND_PREFIX:enter lollipop touch /tmp/test #A service, service to run command against declare desc="enter or run a command in a running $PLUGIN_SERVICE service container" local cmd="$PLUGIN_COMMAND_PREFIX:enter" argv=("$@") diff --git a/subcommands/exists b/subcommands/exists index d611b3d..ae59eee 100755 --- a/subcommands/exists +++ b/subcommands/exists @@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-exists-cmd() { - #E here we check if the lolipop $PLUGIN_COMMAND_PREFIX service exists. - #E dokku $PLUGIN_COMMAND_PREFIX:exists lolipop + #E here we check if the lollipop $PLUGIN_COMMAND_PREFIX service exists. + #E dokku $PLUGIN_COMMAND_PREFIX:exists lollipop #A service, service to run command against declare desc="check if the $PLUGIN_SERVICE service exists" local cmd="$PLUGIN_COMMAND_PREFIX:exists" argv=("$@") diff --git a/subcommands/export b/subcommands/export index 651416c..f9248bc 100755 --- a/subcommands/export +++ b/subcommands/export @@ -7,9 +7,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-export-cmd() { #E by default, datastore output is exported to stdout - #E dokku $PLUGIN_COMMAND_PREFIX:export lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:export lollipop #E you can redirect this output to a file - #E dokku $PLUGIN_COMMAND_PREFIX:export lolipop > lolipop.dump + #E dokku $PLUGIN_COMMAND_PREFIX:export lollipop > lollipop.dump #A service, service to run command against declare desc="export a dump of the $PLUGIN_SERVICE service database" local cmd="$PLUGIN_COMMAND_PREFIX:export" argv=("$@") diff --git a/subcommands/expose b/subcommands/expose index 09674aa..57ead49 100755 --- a/subcommands/expose +++ b/subcommands/expose @@ -7,9 +7,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-expose-cmd() { #E expose the service on the service's normal ports, allowing access to it from the public interface (0.0.0.0) - #E dokku $PLUGIN_COMMAND_PREFIX:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]} + #E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop ${PLUGIN_DATASTORE_PORTS[@]} #E expose the service on the service's normal ports, with the first on a specified ip adddress (127.0.0.1) - #E dokku $PLUGIN_COMMAND_PREFIX:expose lolipop 127.0.0.1:${PLUGIN_DATASTORE_PORTS[@]} + #E dokku $PLUGIN_COMMAND_PREFIX:expose lollipop 127.0.0.1:${PLUGIN_DATASTORE_PORTS[@]} #A service, service to run command against #A ports, a list of ports to run against declare desc="expose a $PLUGIN_SERVICE service on custom host:port if provided (random port on the 0.0.0.0 interface if otherwise unspecified)" diff --git a/subcommands/import b/subcommands/import index 9528b1d..685200b 100755 --- a/subcommands/import +++ b/subcommands/import @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-import-cmd() { #E import a datastore dump - #E dokku $PLUGIN_COMMAND_PREFIX:import lolipop < database.dump + #E dokku $PLUGIN_COMMAND_PREFIX:import lollipop < database.dump #A service, service to run command against declare desc="import a dump into the $PLUGIN_SERVICE service database" local cmd="$PLUGIN_COMMAND_PREFIX:import" argv=("$@") diff --git a/subcommands/info b/subcommands/info index 6aca3f1..7f4b7aa 100755 --- a/subcommands/info +++ b/subcommands/info @@ -7,18 +7,18 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-info-cmd() { #E get connection information as follows: - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop #E you can also retrieve a specific piece of service info via flags: - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --config-dir - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --data-dir - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --dsn - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --exposed-ports - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --id - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --internal-ip - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --links - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --service-root - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --status - #E dokku $PLUGIN_COMMAND_PREFIX:info lolipop --version + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --config-dir + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --data-dir + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --dsn + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --exposed-ports + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --id + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --internal-ip + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --links + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --service-root + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --status + #E dokku $PLUGIN_COMMAND_PREFIX:info lollipop --version #A service, service to run command against #F --config-dir, show the service configuration directory #F --data-dir, show the service data directory diff --git a/subcommands/link b/subcommands/link index 7f1de62..73c6291 100755 --- a/subcommands/link +++ b/subcommands/link @@ -10,20 +10,20 @@ service-link-cmd() { #E this will use native docker links via the docker-options plugin. #E here we link it to our 'playground' app. #E > NOTE: this will restart your app - #E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground + #E dokku $PLUGIN_COMMAND_PREFIX:link lollipop playground #E the following environment variables will be set automatically by docker #E (not on the app itself, so they won’t be listed when calling dokku config): #E - #E DOKKU_${PLUGIN_VARIABLE}_LOLIPOP_NAME=/lolipop/DATABASE - #E DOKKU_${PLUGIN_VARIABLE}_LOLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]} - #E DOKKU_${PLUGIN_VARIABLE}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]} - #E DOKKU_${PLUGIN_VARIABLE}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp - #E DOKKU_${PLUGIN_VARIABLE}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]} - #E DOKKU_${PLUGIN_VARIABLE}_LOLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1 + #E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_NAME=/lollipop/DATABASE + #E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]} + #E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP=tcp://172.17.0.1:${PLUGIN_DATASTORE_PORTS[0]} + #E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PROTO=tcp + #E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_PORT=${PLUGIN_DATASTORE_PORTS[0]} + #E DOKKU_${PLUGIN_VARIABLE}_LOLLIPOP_PORT_${PLUGIN_DATASTORE_PORTS[0]}_TCP_ADDR=172.17.0.1 #E #E the following will be set on the linked application by default: #E - #E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop + #E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop #E #E the host exposed here only works internally in docker containers. #E if you want your container to be reachable from outside, you should @@ -34,10 +34,10 @@ service-link-cmd() { #E after linking will cause the plugin to think the service is not #E linked, and we advise you to unlink before proceeding. #E dokku config:set playground ${PLUGIN_VARIABLE}_DATABASE_SCHEME=${PLUGIN_SCHEME}2 - #E dokku $PLUGIN_COMMAND_PREFIX:link lolipop playground + #E dokku $PLUGIN_COMMAND_PREFIX:link lollipop playground #E this will cause ${PLUGIN_DEFAULT_ALIAS}_URL to be set as: #E - #E ${PLUGIN_SCHEME}2://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop + #E ${PLUGIN_SCHEME}2://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop #A service, service to run command against #A app, app to run command against #F -a|--alias "BLUE_DATABASE", an alternative alias to use for linking to an app via environment variable diff --git a/subcommands/linked b/subcommands/linked index baf2970..38cbc67 100755 --- a/subcommands/linked +++ b/subcommands/linked @@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-linked-cmd() { - #E here we check if the lolipop $PLUGIN_COMMAND_PREFIX service is linked to the 'playground' app. - #E dokku $PLUGIN_COMMAND_PREFIX:linked lolipop playground + #E here we check if the lollipop $PLUGIN_COMMAND_PREFIX service is linked to the 'playground' app. + #E dokku $PLUGIN_COMMAND_PREFIX:linked lollipop playground #A service, service to run command against #A app, app to run command against declare desc="check if the $PLUGIN_SERVICE service is linked to an app" diff --git a/subcommands/links b/subcommands/links index a2e49b0..9f3609b 100755 --- a/subcommands/links +++ b/subcommands/links @@ -6,8 +6,8 @@ source "$PLUGIN_BASE_PATH/common/functions" source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-links-cmd() { - #E list all apps linked to the 'lolipop' $PLUGIN_COMMAND_PREFIX service. - #E dokku $PLUGIN_COMMAND_PREFIX:links lolipop + #E list all apps linked to the 'lollipop' $PLUGIN_COMMAND_PREFIX service. + #E dokku $PLUGIN_COMMAND_PREFIX:links lollipop #A service, service to run command against declare desc="list all apps linked to the $PLUGIN_SERVICE service" local cmd="$PLUGIN_COMMAND_PREFIX:links" argv=("$@") diff --git a/subcommands/logs b/subcommands/logs index 5f4ef8c..38c8209 100755 --- a/subcommands/logs +++ b/subcommands/logs @@ -7,9 +7,9 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-logs-cmd() { #E you can tail logs for a particular service: - #E dokku $PLUGIN_COMMAND_PREFIX:logs lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop #E by default, logs will not be tailed, but you can do this with the --tail flag: - #E dokku $PLUGIN_COMMAND_PREFIX:logs lolipop --tail + #E dokku $PLUGIN_COMMAND_PREFIX:logs lollipop --tail #A service, service to run command against #F -t|--tail, do not stop when end of the logs are reached and wait for additional output declare desc="print the most recent log(s) for this service" diff --git a/subcommands/promote b/subcommands/promote index eec7e02..cbd5cda 100755 --- a/subcommands/promote +++ b/subcommands/promote @@ -20,7 +20,7 @@ service-promote-cmd() { #E #E ${PLUGIN_DEFAULT_ALIAS}_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service #E DOKKU_${PLUGIN_DEFAULT_ALIAS}_BLUE_URL=${PLUGIN_SCHEME}://other_service:ANOTHER_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-other-service:${PLUGIN_DATASTORE_PORTS[0]}/other_service - #E DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lolipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lolipop:${PLUGIN_DATASTORE_PORTS[0]}/lolipop + #E DOKKU_${PLUGIN_DEFAULT_ALIAS}_SILVER_URL=${PLUGIN_SCHEME}://lollipop:SOME_PASSWORD@dokku-${PLUGIN_COMMAND_PREFIX}-lollipop:${PLUGIN_DATASTORE_PORTS[0]}/lollipop #A service, service to run command against #A app, app to run command against declare desc="promote service as ${PLUGIN_DEFAULT_ALIAS}_URL in " diff --git a/subcommands/restart b/subcommands/restart index 8fbc9a3..df9a051 100755 --- a/subcommands/restart +++ b/subcommands/restart @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-restart-cmd() { #E restart the service - #E dokku $PLUGIN_COMMAND_PREFIX:restart lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:restart lollipop #A service, service to run command against declare desc="graceful shutdown and restart of the $PLUGIN_SERVICE service container" local cmd="$PLUGIN_COMMAND_PREFIX:restart" argv=("$@") diff --git a/subcommands/start b/subcommands/start index 7f58822..8416745 100755 --- a/subcommands/start +++ b/subcommands/start @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-start-cmd() { #E start the service - #E dokku $PLUGIN_COMMAND_PREFIX:start lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:start lollipop #A service, service to run command against declare desc="start a previously stopped $PLUGIN_SERVICE service" local cmd="$PLUGIN_COMMAND_PREFIX:start" argv=("$@") diff --git a/subcommands/stop b/subcommands/stop index 7ccd0e2..0ac3a17 100755 --- a/subcommands/stop +++ b/subcommands/stop @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-stop-cmd() { #E stop the service and the running container - #E dokku $PLUGIN_COMMAND_PREFIX:stop lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:stop lollipop #A service, service to run command against declare desc="stop a running $PLUGIN_SERVICE service" local cmd="$PLUGIN_COMMAND_PREFIX:stop" argv=("$@") diff --git a/subcommands/unexpose b/subcommands/unexpose index ae748f7..83e5239 100755 --- a/subcommands/unexpose +++ b/subcommands/unexpose @@ -7,7 +7,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-unexpose-cmd() { #E unexpose the service, removing access to it from the public interface (0.0.0.0) - #E dokku $PLUGIN_COMMAND_PREFIX:unexpose lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:unexpose lollipop #A service, service to run command against declare desc="unexpose a previously exposed $PLUGIN_SERVICE service" local cmd="$PLUGIN_COMMAND_PREFIX:unexpose" argv=("$@") diff --git a/subcommands/unlink b/subcommands/unlink index 0c9729a..b1e37d6 100755 --- a/subcommands/unlink +++ b/subcommands/unlink @@ -8,7 +8,7 @@ source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions" service-unlink-cmd() { #E you can unlink a $PLUGIN_COMMAND_PREFIX service #E > NOTE: this will restart your app and unset related environment variables - #E dokku $PLUGIN_COMMAND_PREFIX:unlink lolipop playground + #E dokku $PLUGIN_COMMAND_PREFIX:unlink lollipop playground #A service, service to run command against #A app, app to run command against declare desc="unlink the $PLUGIN_SERVICE service from the app" diff --git a/subcommands/upgrade b/subcommands/upgrade index abdf426..899f7e2 100755 --- a/subcommands/upgrade +++ b/subcommands/upgrade @@ -8,7 +8,7 @@ source "$PLUGIN_AVAILABLE_PATH/ps/functions" service-upgrade-cmd() { #E you can upgrade an existing service to a new image or image-version - #E dokku $PLUGIN_COMMAND_PREFIX:upgrade lolipop + #E dokku $PLUGIN_COMMAND_PREFIX:upgrade lollipop #A service, service to run command against #F -c|--config-options "--args --go=here", extra arguments to pass to the container create command #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with