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

docs: add deprecation note to migration guide

Browse Source 
Also add documentation for formations key.
This commit is contained in:
Jose Diaz-Gonzalez
2021-08-01 00:30:53 -04:00
parent bc49a2e124
commit fee6773ef3
2 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/processes/process-management.md
View File

@@ -106,7 +106,7 @@ web: 1
#### Via CLI
> This functionality is disabled if the formation is managed via a file such as `DOKKU_SCALE`.
> This functionality is disabled if the formation is managed via the `formations` key of `app.json`.
Dokku can also manage scaling itself via the `ps:scale` command. This command can be used to scale multiple process types at the same time.
@@ -128,22 +128,30 @@ dokku ps:scale --skip-deploy node-js-app web=1
#### Manually managing process scaling
> Using a `DOKKU_SCALE` formation file disables the ability to use `ps:scale` for scaling.
> Using a `formations` key in an `app.json` file disables the ability to use `ps:scale` for scaling.
A `DOKKU_SCALE` file can be committed to the root of the pushed app repository, and must be within the built image artifact in the image's working directory as shown below.
An `app.json` file can be committed to the root of the pushed app repository, and must be within the built image artifact in the image's working directory as shown below.
- Buildpacks: `/app/DOKKU_SCALE`
- Dockerfile: `WORKDIR/DOKKU_SCALE` or `/DOKKU_SCALE`
- Docker Image: `WORKDIR/DOKKU_SCALE` or `/DOKKU_SCALE`
- Buildpacks: `/app/app.json`
- Dockerfile: `WORKDIR/app.json` or `/app.json` (if no working directory specified)
- Docker Image: `WORKDIR/app.json` or `/app.json` (if no working directory specified)
The `DOKKU_SCALE` file format is as follows:
The `formations` key should be specified as follows in the `app.json` file:
```Procfile
web=1
worker=2
{
"formations": {
"web": {
"quantity": 1
},
"worker": {
"quantity": 4
}
}
}
```
Removing the file will result in Dokku respecting the `ps:scale` command for setting scale values.
Removing the file will result in Dokku respecting the `ps:scale` command for setting scale values. The values set via the `app.json` file from a previous deploy will be respected.
#### The `web` process