fix: honor storage attachment process types at deploy time
An attachment's process type was recorded, reported and used to scope `storage:mount --replace` and `storage:unmount --all`, but nothing read it when the volume was actually mounted, so `storage:mount <app> <entry> --container-dir <path> --process-type web` bound the volume into every process rather than only `web`. Both schedulers now scope a mount to the process type it was declared for, and containers that belong to no process type - a `dokku run` one-off, an `app.json` deploy task, a k3s cron job - receive default-scoped mounts only. A container path can now be claimed by a single mount per process type, and `storage:migrate` drains process-scoped `-v` lines out of `docker-options` rather than only the default-scoped ones.
This commit is contained in:
20 files changed
+1075
-114
No files matched your search
@@ -247,7 +247,7 @@ dokku storage:mount node-js-app /var/lib/dokku/data/storage/node-js-app:/app/sto
|
||||
dokku storage:mount node-js-app some-docker-volume:/app/storage
|
||||
```
|
||||
|
||||
In the first example, Dokku will then mount the shared contents of `/var/lib/dokku/data/storage/node-js-app` to `/app/storage` inside the container. The mount point is *not* relative to your app's working directory, and is instead relative to the root (`/`) of the container. Mounts are only available for containers created via `run` and by the deploy process, and not during the build process. In addition, the host path is never auto-created by either Dokku or Docker, and should be an explicit path, not one relative to the current working directory.
|
||||
In the first example, Dokku will then mount the shared contents of `/var/lib/dokku/data/storage/node-js-app` to `/app/storage` inside the container. The mount point is *not* relative to your app's working directory, and is instead relative to the root (`/`) of the container. Mounts are only available for containers created via `run` and by the deploy process, and not during the build process. A mount is bound into every process type unless `--process-type` narrows it - see [scoping a mount to a process type](#scoping-a-mount-to-a-process-type). In addition, the host path is never auto-created by either Dokku or Docker, and should be an explicit path, not one relative to the current working directory.
|
||||
|
||||
> If the `/storage` path within the container had pre-existing content, the container files will be over-written. This may be an issue for users that create assets at build time but then mount a directory at the same place during runtime. Files are not merged.
|
||||
|
||||
@@ -268,6 +268,40 @@ Once persistent storage is mounted, the app requires a restart. See the [process
|
||||
dokku ps:restart app-name
|
||||
```
|
||||
|
||||
#### Scoping a mount to a process type
|
||||
|
||||
> [!IMPORTANT]
|
||||
> New as of 0.38.28
|
||||
|
||||
By default a mount is bound into every one of an app's containers. `--process-type` narrows it to a single Procfile process type, which is how a worker gets a scratch volume the web process has no business seeing:
|
||||
|
||||
```shell
|
||||
dokku storage:create node-js-scratch
|
||||
dokku storage:mount node-js-app node-js-scratch --container-dir /scratch --process-type worker
|
||||
```
|
||||
|
||||
The magic `_default_` process type is the unscoped case, and it is what a mount gets when `--process-type` is omitted. Default-scoped mounts are bound into every process; a mount scoped to a named process type is bound only into that one.
|
||||
|
||||
Some containers belong to no process type at all - a `dokku run` one-off, the ephemeral containers that run `app.json` deploy tasks, and k3s cron jobs. Those receive default-scoped mounts only, since there is no process type for a named scope to match. On k3s this applies to the deploy phase; `--phase run` attachments are not mounted there at all.
|
||||
|
||||
A container path can be claimed by only one mount per process type, so `storage:mount` rejects a container path that an overlapping scope already holds. The default scope overlaps every named one:
|
||||
|
||||
```shell
|
||||
dokku storage:create node-js-data
|
||||
dokku storage:create node-js-cache
|
||||
|
||||
dokku storage:mount node-js-app node-js-data --container-dir /app/storage
|
||||
# fails: the default-scoped mount above also applies to web
|
||||
dokku storage:mount node-js-app node-js-cache --container-dir /app/storage --process-type web
|
||||
```
|
||||
|
||||
Two *named* scopes never apply to the same container, so they may each bind a different entry at the same container path:
|
||||
|
||||
```shell
|
||||
dokku storage:mount node-js-app node-js-data --container-dir /app/storage --process-type web
|
||||
dokku storage:mount node-js-app node-js-cache --container-dir /app/storage --process-type worker
|
||||
```
|
||||
|
||||
#### Replacing the entire mount set
|
||||
|
||||
> [!IMPORTANT]
|
||||
|
||||
Reference in new issue
Block a user