docs: properly spell lollipop
I've been misspelling my stand-in variable name for years...
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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)"
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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 <service> as ${PLUGIN_DEFAULT_ALIAS}_URL in <app>"
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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=("$@")
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user