docs: use github admonitions

These still need to be properly parsed.
This commit is contained in:
Jose Diaz-Gonzalez
2023-08-19 14:24:12 -04:00
parent 5dd78e2b86
commit d61d91cf87
47 changed files with 277 additions and 89 deletions

View File

@@ -1,5 +1,6 @@
# Entering containers
> [!IMPORTANT]
> New as of 0.4.0
```

View File

@@ -16,6 +16,7 @@ Sometimes it is necessary to run a one-off command under an app. Dokku makes it
The `run` command can be used to run a one-off process for a specific command. This will start a new container and run the desired command within that container. The container image will be the same container image as was used to start the currently deployed app.
> [!IMPORTANT]
> New as of 0.25.0, this container will be removed after the process exits.
```shell
@@ -51,6 +52,7 @@ dokku --label=com.example.test-label=value run node-js-app ls -lah
#### Disabling TTY
> [!IMPORTANT]
> New as of 0.25.0
One-off containers default to interactive mode where possible. To disable this behavior, specify the `--no-tty` flag:
@@ -61,6 +63,7 @@ dokku run --no-tty node-js-app ls -lah
### Running a detached container
> [!IMPORTANT]
> New as of 0.25.0
Finally, a container can be run in "detached" mode via the `run:detached` Dokku command. Running a process in detached mode will immediately return a `CONTAINER_ID`. Detached containers are run without a tty and are also removed at the end of process execution.
@@ -101,6 +104,7 @@ The above command will show logs continually from the `node-js-app.run.1234` one
### Listing one-off containers
> [!IMPORTANT]
> New as of 0.25.0
One-off containers for a given app can be listed via the `run:list` command:
@@ -136,6 +140,7 @@ dokku run:list node-js-app --format json
### Stopping a one-off container
> [!IMPORTANT]
> New as of 0.29.0
Run containers for an app can be stopped via the `run:stop` command. The output will be the container id.

View File

@@ -1,5 +1,6 @@
# Process Management
> [!IMPORTANT]
> New as of 0.3.14, Enhanced in 0.7.0
```
@@ -18,6 +19,7 @@ ps:stop [--parallel count] [--all|<app>] # Stop an app
### Inspecting app containers
> [!IMPORTANT]
> New as of 0.13.0
A common administrative task to perform is calling `docker inspect` on the containers that are running for an app. This can be an error-prone task to perform, and may also reveal sensitive environment variables if not done correctly. Dokku provides a wrapper around this command via the `ps:inspect` command:
@@ -109,7 +111,8 @@ web: 1
#### Procfile
> Note: Dokku supports the Procfile format as defined in [this document](https://github.com/dokku/procfile-util/blob/master/PROCFILE_FORMAT.md) under "Strict Mode" parsing rules.
> [!NOTE]
> Dokku supports the Procfile format as defined in [this document](https://github.com/dokku/procfile-util/blob/master/PROCFILE_FORMAT.md) under "Strict Mode" parsing rules.
Apps can define processes to run by using a `Procfile`. A `Procfile` is a simple text file that can be used to specify multiple commands, each of which is subject to process scaling. In the case where the built image sets a default command to run - either through usage of `CMD` for Dockerfile-based builds, a default process for buildpack-based builds, or any other method for the builder in use - the `Procfile` will take precedence.
@@ -277,6 +280,7 @@ dokku ps:start --all --parallel -1
### Restart policies
> [!IMPORTANT]
> New as of 0.7.0, Command Changed in 0.22.0
By default, Dokku will automatically restart containers that exit with a non-zero status up to 10 times via the [on-failure Docker restart policy](https://docs.docker.com/engine/reference/run/#restart-policies---restart).
@@ -313,6 +317,7 @@ Dokku also runs `dokku-event-listener` in the background via the system's init s
### Displaying reports for an app
> [!IMPORTANT]
> New as of 0.12.0
You can get a report about the deployed apps using the `ps:report` command:

View File

@@ -1,5 +1,6 @@
# Scheduled Cron Tasks
> [!IMPORTANT]
> New as of 0.23.0
```
@@ -125,7 +126,8 @@ dokku cron:report node-js-app --cron-task-count
### Self Managed Cron
> Warning: Self-managed cron tasks should be considered advanced usage. While the instructions are available, users are highly encouraged to use the built-in scheduled cron task support unless absolutely necessary.
> [!WARNING]
> Self-managed cron tasks should be considered advanced usage. While the instructions are available, users are highly encouraged to use the built-in scheduled cron task support unless absolutely necessary.
Some installations may require more fine-grained control over cron usage. The following are advanced instructions for configuring cron.