github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #6129 from dokku/cleanup-markdown

Browse Source 
Cleanup markdown and use Github Admonitions
This commit is contained in:
Jose Diaz-Gonzalez
2023-08-19 18:55:35 -04:00
committed by GitHub
parent fe117d403b 3306f29c11
commit f433e008e9
70 changed files with 709 additions and 385 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/development/plugin-creation.md
View File

@@ -145,6 +145,7 @@ Any functions that must be kept private should reside in the plugin's `trigger/`
### Use helper functions to fetch app images
> [!IMPORTANT]
> New as of 0.4.0
Dokku allows image tagging and deployment of tagged images. This means hard-coding the `$IMAGE` as `dokku/$APP` is no longer sufficient.
@@ -155,6 +156,7 @@ Plugins should use `get_running_image_tag()` and `get_app_image_name()` as sourc
### Use `$DOCKER_BIN` instead of `docker` directly
> [!IMPORTANT]
> New as of 0.17.5
Certain systems may require a wrapper function around the `docker` binary for proper execution. Utilizing the `$DOCKER_BIN` environment variable when calling docker for those functions is preferred.
@@ -169,6 +171,7 @@ docker run -d $IMAGE /bin/bash -e -c "$COMMAND"
### Include labels for all temporary containers and images
> [!IMPORTANT]
> New as of 0.5.0
As of 0.5.0, labels are used to help cleanup intermediate containers with `dokku cleanup`. Plugins that create containers and images should add the correct labels to the `build`, `commit`, and `run` docker commands.
@@ -208,6 +211,7 @@ Files are copied from the `/app` directory - for images built via buildpacks - o
### Avoid calling the `dokku` binary directly
> [!IMPORTANT]
> New as of 0.6.0
Plugins should **not** call the `dokku` binary directly from within plugins because clients using the `--app` argument are potentially broken when doing so.

82
docs/development/plugin-triggers.md
View File

@@ -691,7 +691,8 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
### `docker-args-build`
> Warning: Deprecated, please use `docker-args-process-build` instead
> [!WARNING]
> Deprecated, please use `docker-args-process-build` instead
- Description:
- Invoked by: `internal function dokku_build() (build phase)`
@@ -716,7 +717,8 @@ echo -n "$STDIN$output"
### `docker-args-deploy`
> Warning: Deprecated, please use `docker-args-process-deploy` instead
> [!WARNING]
> Deprecated, please use `docker-args-process-deploy` instead
- Description:
- Invoked by: `dokku deploy`
@@ -787,7 +789,8 @@ APP="$1"; IMAGE_SOURCE_TYPE="$3"; IMAGE_TAG="$2"; IMAGE=$(get_app_image_name $AP
### `docker-args-run`
> Warning: Deprecated, please use `docker-args-process-run` instead
> [!WARNING]
> Deprecated, please use `docker-args-process-run` instead
- Description:
- Invoked by: `dokku run`
@@ -1014,7 +1017,8 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
# TODO
```
> Warning: The `git-pre-pull` trigger should _not_ be used for authentication since it does not get called for commands that use `git-upload-archive` such as `git archive`. Instead, use the [`user-auth`](#user-auth) trigger.
> [!WARNING]
> The `git-pre-pull` trigger should _not_ be used for authentication since it does not get called for commands that use `git-upload-archive` such as `git archive`. Instead, use the [`user-auth`](#user-auth) trigger.
### `git-revision`
@@ -1221,7 +1225,7 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
- Description: Return the path to a `sigil` template that should be used to generate a given nginx configuration file.
- Invoked by: `nginx-vhosts#build-config`
- Arguments: `$APP $TEMPLATE_TYPE`
- The `TEMPLATE_TYPE` argument can be one of: `[app-config, hsts-config, validate-config]`
- The `TEMPLATE_TYPE` argument can be one of: `[app-config, hsts-config, validate-config]`
- Example:
```shell
@@ -1284,7 +1288,8 @@ echo "$NEW_SUBDOMAIN.$VHOST"
### `nginx-pre-reload`
> Warning: The arguments INTERNAL_PORT and INTERNAL_IP_ADDRESS are no longer sufficient to retrieve all app listeners. Please run `plugn trigger network-get-listeners APP` within any implementation of `nginx-pre-reload` in order to retrieve all application listeners.
> [!WARNING]
> The arguments INTERNAL_PORT and INTERNAL_IP_ADDRESS are no longer sufficient to retrieve all app listeners. Please run `plugn trigger network-get-listeners APP` within any implementation of `nginx-pre-reload` in order to retrieve all application listeners.
- Description: Run before nginx reloads hosts
- Invoked by: `dokku proxy:build-config`
@@ -1485,7 +1490,8 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
### `post-build-pack`
> Warning: The pack plugin trigger apis are under development and may change
> [!WARNING]
> The pack plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run commands after the build image is create for a given app. Only applies to apps using pack.
@@ -1567,7 +1573,7 @@ APP="$1"
### `post-config-update`
- Description: Allows you to get notified when one or more configs is added or removed. Action can be `set` or `unset`.
- Description: Allows you to get notified when one or more configs is added or removed. Action can be `set` or `unset`.
- Invoked by: `dokku config:set`, `dokku config:unset`
- Arguments: `$APP` `set|unset` `key1=VALUE1 key2=VALUE2`
- Example:
@@ -1714,7 +1720,8 @@ haproxy-build-config "$APP"
### `post-release-builder`
> Warning: Image mutation in this trigger may result in an invalid run state, and is heavily discouraged.
> [!WARNING]
> Image mutation in this trigger may result in an invalid run state, and is heavily discouraged.
- Description: Invokes a command after the build process is complete.
- Invoked by: builder plugins
@@ -1796,7 +1803,8 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
### `pre-build-pack`
> Warning: The pack plugin trigger apis are under development and may change
> [!WARNING]
> The pack plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run commands before the build image is created for a given app. For instance, this can be useful to add env vars to your container. Only applies to apps using pack.
@@ -1969,7 +1977,8 @@ APP="$1"; IMAGE_TAG="$2";
### `pre-release-pack`
> Warning: The pack plugin trigger apis are under development and may change
> [!WARNING]
> The pack plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run commands before environment variables are set for the release step of the deploy. Only applies to apps using pack.
@@ -2100,7 +2109,8 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
### `proxy-configure-ports`
> Warning: Deprecated, please use `ports-configure` instead
> [!WARNING]
> Deprecated, please use `ports-configure` instead
- Description: Configures the port mapping
- Invoked by: `internally triggered by proxy plugins`
@@ -2329,7 +2339,8 @@ mail -s "$APP containers on $HOSTNAME failed to retire" ops@dokku.me
### `scheduler-app-status`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Fetch the status of an app
@@ -2348,7 +2359,8 @@ DOKKU_SCHEDULER="$1"; APP="$2";
### `scheduler-deploy`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run scheduler commands when an app is deployed
@@ -2367,7 +2379,8 @@ DOKKU_SCHEDULER="$1"; APP="$2"; IMAGE_TAG="$3";
### `scheduler-detect`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to check which scheduler is in use for an app
@@ -2386,7 +2399,8 @@ APP="$1"
### `scheduler-enter`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to enter a running container for a given app
@@ -2405,7 +2419,8 @@ DOKKU_SCHEDULER="$1"; APP="$2"; ARGS="$@"
### `scheduler-inspect`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run inspect commands for all containers for a given app
@@ -2443,7 +2458,8 @@ DOKKU_SCHEDULER="$1"; APP="$2";
### `scheduler-logs`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run scheduler commands when retrieving container logs
@@ -2462,7 +2478,8 @@ DOKKU_SCHEDULER="$1"; APP="$2"; PROCESS_TYPE="$3"; TAIL="$4"; PRETTY_PRINT="$5";
### `scheduler-logs-failed`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run scheduler commands when retrieving failed container logs
@@ -2481,7 +2498,8 @@ DOKKU_SCHEDULER="$1"; APP="$2";
### `scheduler-pre-restore`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run commands before an app is restored
@@ -2500,7 +2518,8 @@ DOKKU_SCHEDULER="$1"; APP="$2";
### `scheduler-post-delete`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run scheduler commands when an app is deleted
@@ -2538,7 +2557,8 @@ APP="$1"; PROCESS_TYPE="$2";
### `scheduler-post-run`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run scheduler commands after a `dokku run` invocation is called
@@ -2557,7 +2577,8 @@ DOKKU_SCHEDULER="$1"; APP="$2"; CONTAINER_ID="$3";
### `scheduler-register-retired`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows scheduling retiring a local container and any related images
@@ -2577,7 +2598,8 @@ CONTAINER_ID="$2";
### `scheduler-retire`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run scheduler commands when containers should be force retired from the system
@@ -2596,7 +2618,8 @@ DOKKU_SCHEDULER="$1"; APP="$2";
### `scheduler-run`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run scheduler commands when a command is executed for your app
@@ -2615,7 +2638,8 @@ DOKKU_SCHEDULER="$1"; APP="$2"; ARGS="${@:3}";
### `scheduler-run-list`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Lists all run containers for a given app
@@ -2634,7 +2658,8 @@ DOKKU_SCHEDULER="$1"; APP="$2"; FORMAT="$3";
### `scheduler-run-logs`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run scheduler commands when retrieving one-off container logs
@@ -2672,7 +2697,8 @@ DOKKU_SCHEDULER="$1"; APP="$2"; CONTAINER_NAME="$3";
### `scheduler-stop`
> Warning: The scheduler plugin trigger apis are under development and may change
> [!WARNING]
> The scheduler plugin trigger apis are under development and may change
> between minor releases until the 1.0 release.
- Description: Allows you to run scheduler commands when a tag is destroyed