1 parent
25e44b5492
commit
f1897c7a86
3 files changed
+121
-20
No files matched your search
@@ -5,15 +5,15 @@
|
|||||||
Pass [options](https://docs.docker.com/engine/reference/run/) to Docker during Dokku's `build`, `deploy` and `run` phases
|
Pass [options](https://docs.docker.com/engine/reference/run/) to Docker during Dokku's `build`, `deploy` and `run` phases
|
||||||
|
|
||||||
```
|
```
|
||||||
docker-options <app> [phase(s)] # Display app's Docker options for all phases (or comma separated phase list)
|
|
||||||
docker-options:add <app> <phase(s)> OPTION # Add Docker option to app for phase (comma-separated phase list)
|
docker-options:add <app> <phase(s)> OPTION # Add Docker option to app for phase (comma-separated phase list)
|
||||||
docker-options:remove <app> <phase(s)> OPTION # Remove Docker option from app for phase (comma-separated phase list)
|
docker-options:remove <app> <phase(s)> OPTION # Remove Docker option from app for phase (comma-separated phase list)
|
||||||
|
docker-options:report [<app>] [<flag>] # Displays a docker options report for one or more apps
|
||||||
```
|
```
|
||||||
|
|
||||||
> When specifying multiple phases, they **must** be comma-separated _without_ spaces in between each phase, like so:
|
> When specifying multiple phases, they **must** be comma-separated _without_ spaces in between each phase, like so:
|
||||||
>
|
>
|
||||||
> ```shell
|
> ```shell
|
||||||
> dokku docker-options:add myapp deploy,run "-v /home/dokku/logs/myapp:/app/logs"
|
> dokku docker-options:add node-js-app deploy,run "-v /var/log/node-js-app:/app/logs"
|
||||||
> ```
|
> ```
|
||||||
|
|
||||||
## About Dokku phases
|
## About Dokku phases
|
||||||
@@ -22,7 +22,7 @@ Dokku deploys your application in multiple "phases" and the `docker-options` plu
|
|||||||
|
|
||||||
- `build`: the container that executes the appropriate buildpack
|
- `build`: the container that executes the appropriate buildpack
|
||||||
- `deploy`: the container that executes your running/deployed application
|
- `deploy`: the container that executes your running/deployed application
|
||||||
- `run`: the container that executes any arbitrary command via `dokku run myapp`
|
- `run`: the container that executes any arbitrary command via `dokku run`
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -32,31 +32,63 @@ Add some options for the deployed/running app and when executing [`dokku run`](/
|
|||||||
|
|
||||||
```shell
|
```shell
|
||||||
# Mount a host volume in a Docker container: "-v /host/path:/container/path"
|
# Mount a host volume in a Docker container: "-v /host/path:/container/path"
|
||||||
dokku docker-options:add myapp deploy "-v /home/dokku/logs/myapp:/app/logs"
|
dokku docker-options:add node-js-app deploy "-v /var/log/node-js-app:/app/logs"
|
||||||
dokku docker-options:add myapp run "-v /home/dokku/logs/myapp:/app/logs"
|
dokku docker-options:add node-js-app run "-v /var/log/node-js-app:/app/logs"
|
||||||
```
|
```
|
||||||
|
|
||||||
> Note: When [mounting a host directory](https://docs.docker.com/engine/reference/run/#volume-shared-filesystems) in a Dokku app you should first create that directory as user `dokku` and then mount the directory under `/app` in the container using `docker-options` as above. Otherwise the app will lack write permission in the directory.
|
> Note: When [mounting a host directory](https://docs.docker.com/engine/reference/run/#volume-shared-filesystems) in a Dokku app you should first create that directory as user `dokku` and then mount the directory under `/app` in the container using `docker-options` as above. Otherwise the app will lack write permission in the directory.
|
||||||
|
|
||||||
### Output Docker options
|
|
||||||
|
|
||||||
```shell
|
|
||||||
dokku docker-options myapp
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
Deploy options:
|
|
||||||
-v /home/dokku/logs/myapp:/app/logs
|
|
||||||
Run options:
|
|
||||||
-v /home/dokku/logs/myapp:/app/logs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Remove a Docker option
|
### Remove a Docker option
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
dokku docker-options:remove myapp run "-v /home/dokku/logs/myapp:/app/logs"
|
dokku docker-options:remove node-js-app run "-v /var/log/node-js-app:/app/logs"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Displaying docker-options reports about an app
|
||||||
|
|
||||||
|
> New as of 0.8.1
|
||||||
|
|
||||||
|
You can get a report about the app's docker-options status using the `docker-options:report` command:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku docker-options:report
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
=====> node-js-app docker options information
|
||||||
|
Docker options build:
|
||||||
|
Docker options deploy: -v /var/log/node-js-app:/app/logs
|
||||||
|
Docker options run: -v /var/log/node-js-app:/app/logs
|
||||||
|
=====> python-sample docker options information
|
||||||
|
Docker options build:
|
||||||
|
Docker options deploy:
|
||||||
|
Docker options run:
|
||||||
|
=====> ruby-sample docker options information
|
||||||
|
Docker options build:
|
||||||
|
Docker options deploy:
|
||||||
|
Docker options run:
|
||||||
|
```
|
||||||
|
|
||||||
|
You can run the command for a specific app also.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku docker-options:report node-js-app
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
=====> node-js-app docker options information
|
||||||
|
Storage build mounts:
|
||||||
|
Storage deploy mounts: -v /var/log/node-js-app:/app/logs
|
||||||
|
Storage run mounts: -v /var/log/node-js-app:/app/logs
|
||||||
|
```
|
||||||
|
|
||||||
|
You can pass flags which will output only the value of the specific information you want. For example:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dokku docker-options:report node-js-app --docker-options-build
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Advanced usage
|
## Advanced usage
|
||||||
|
|
||||||
In your applications folder `/home/dokku/app_name` create a file called `DOCKER_OPTIONS_RUN` (or `DOCKER_OPTIONS_BUILD` or `DOCKER_OPTIONS_DEPLOY`).
|
In your applications folder `/home/dokku/app_name` create a file called `DOCKER_OPTIONS_RUN` (or `DOCKER_OPTIONS_BUILD` or `DOCKER_OPTIONS_DEPLOY`).
|
||||||
|
|||||||
@@ -7,9 +7,10 @@ case "$1" in
|
|||||||
help_content_func () {
|
help_content_func () {
|
||||||
declare desc="return docker-options plugin help content"
|
declare desc="return docker-options plugin help content"
|
||||||
cat<<help_content
|
cat<<help_content
|
||||||
docker-options <app> [phase(s)], Display app's Docker options for all phases (or comma separated phase list)
|
docker-options <app> [phase(s)], [DEPRECATED] Alternative for docker-options:report
|
||||||
docker-options:add <app> <phase(s)> OPTION, Add Docker option to app for phase (comma separated phase list)
|
docker-options:add <app> <phase(s)> OPTION, Add Docker option to app for phase (comma separated phase list)
|
||||||
docker-options:remove <app> <phase(s)> OPTION, Remove Docker option from app for phase (comma separated phase list)
|
docker-options:remove <app> <phase(s)> OPTION, Remove Docker option from app for phase (comma separated phase list)
|
||||||
|
docker-options:report [<app>] [<flag>], Displays a docker options report for one or more apps
|
||||||
help_content
|
help_content
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Executable
+68
@@ -0,0 +1,68 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
|
||||||
|
source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
|
||||||
|
|
||||||
|
fn-docker-options() {
|
||||||
|
declare APP="$1" PHASE="$2"
|
||||||
|
local PHASE_FILE="$(fn-get-phase-file-path "$APP" "$PHASE")"
|
||||||
|
if [[ -r "$PHASE_FILE" ]]; then
|
||||||
|
cat "$PHASE_FILE" | tr '\n' ' '
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
docker_options_report_single_app() {
|
||||||
|
local APP="$1"; local APP_DIR="$DOKKU_ROOT/$APP"; local INFO_FLAG="$2"
|
||||||
|
if [[ "$INFO_FLAG" == "true" ]]; then
|
||||||
|
INFO_FLAG=""
|
||||||
|
fi
|
||||||
|
verify_app_name "$APP"
|
||||||
|
local flag_map=(
|
||||||
|
"--docker-options-build: $(fn-docker-options "$APP" build)"
|
||||||
|
"--docker-options-deploy: $(fn-docker-options "$APP" deploy)"
|
||||||
|
"--docker-options-run: $(fn-docker-options "$APP" run)"
|
||||||
|
)
|
||||||
|
|
||||||
|
if [[ -z "$INFO_FLAG" ]]; then
|
||||||
|
dokku_log_info2 "$APP docker options information"
|
||||||
|
for flag in "${flag_map[@]}"; do
|
||||||
|
key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')"
|
||||||
|
dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")"
|
||||||
|
done
|
||||||
|
else
|
||||||
|
local match=false; local value_exists=false
|
||||||
|
for flag in "${flag_map[@]}"; do
|
||||||
|
valid_flags="${valid_flags} $(echo "$flag" | cut -d':' -f1)"
|
||||||
|
if [[ "$flag" == "${INFO_FLAG}:"* ]]; then
|
||||||
|
value=${flag#*: }
|
||||||
|
size="${#value}"
|
||||||
|
if [[ "$size" -ne 0 ]]; then
|
||||||
|
echo "$value" && match=true && value_exists=true
|
||||||
|
else
|
||||||
|
match=true
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
if [[ "$match" == "true" ]]; then
|
||||||
|
[[ "$value_exists" == "true" ]] || dokku_log_fail "not deployed"
|
||||||
|
else
|
||||||
|
dokku_log_fail "Invalid flag passed, valid flags:${valid_flags}"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
docker_options_report_cmd() {
|
||||||
|
declare desc="displays a docker options report for one or more apps"
|
||||||
|
local cmd="docker-options:report"
|
||||||
|
local INSTALLED_APPS=$(dokku_apps); local APP
|
||||||
|
|
||||||
|
if [[ -z $2 ]]; then
|
||||||
|
for APP in $INSTALLED_APPS; do
|
||||||
|
docker_options_report_single_app "$APP" "true"
|
||||||
|
done
|
||||||
|
else
|
||||||
|
docker_options_report_single_app "$2" "$3"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
docker_options_report_cmd "$@"
|
||||||
Reference in new issue
Block a user