docs: correctly doc apps:report output

The `not deployed` message was removed in 0.20.0, and that state can be queried via `ps:report` now.

Closes #4134
This commit is contained in:
Jose Diaz-Gonzalez
2020-11-22 15:59:35 -05:00
parent 5f1dc46392
commit fcebbd67df
3 changed files with 68 additions and 5 deletions

View File

@@ -54,6 +54,10 @@ Dokku will no longer distribute packages for Debian versions that are not `stabl
The `--git-sha` flag was moved from the `apps:report` command to the `git:report` command. The `--git-sha` flag was moved from the `apps:report` command to the `git:report` command.
## App report output
When an app is not deployed, the `apps:report` command no longer shows the message `not deployed`. Please use the `--deployed` flag on `ps:report` instead to see if the app has been deployed.
## Changes ## Changes
### App report flags ### App report flags

View File

@@ -244,13 +244,15 @@ dokku apps:report
``` ```
``` ```
=====> node-js-app =====> node-js-app app information
App dir: /home/dokku/node-js-app App dir: /home/dokku/node-js-app
App deploy source: git App deploy source: git
App locked: false App locked: false
=====> python-sample =====> python-sample app information
not deployed App dir: /home/dokku/python-sample
=====> ruby-sample App deploy source:
App locked: false
=====> ruby-sample app information
App dir: /home/dokku/ruby-sample App dir: /home/dokku/ruby-sample
App deploy source: git App deploy source: git
App locked: false App locked: false
@@ -263,7 +265,7 @@ dokku apps:report node-js-app
``` ```
``` ```
=====> node-js-app =====> node-js-app app information
App dir: /home/dokku/node-js-app App dir: /home/dokku/node-js-app
App deploy source: git App deploy source: git
App locked: false App locked: false

View File

@@ -238,3 +238,60 @@ dokku ps:set node-js-app restart-policy on-failure:20
``` ```
Restart policies have no bearing on server reboot, and Dokku will always attempt to restart your apps at that point unless they were manually stopped. Restart policies have no bearing on server reboot, and Dokku will always attempt to restart your apps at that point unless they were manually stopped.
### Displaying reports for an app
> New as of 0.12.0
You can get a report about the deployed apps using the `ps:report` command:
```shell
dokku ps:report
```
```
=====> node-js-app ps information
Deployed: false
Processes: 0
Ps can scale: true
Ps restart policy: on-failure:10
Restore: true
Running: false
=====> python-sample ps information
Deployed: false
Processes: 0
Ps can scale: true
Ps restart policy: on-failure:10
Restore: true
Running: false
=====> ruby-sample ps information
Deployed: false
Processes: 0
Ps can scale: true
Ps restart policy: on-failure:10
Restore: true
Running: false
```
You can run the command for a specific app also.
```shell
dokku ps:report node-js-app
```
```
=====> node-js-app ps information
Deployed: false
Processes: 0
Ps can scale: true
Ps restart policy: on-failure:10
Restore: true
Running: false
```
You can pass flags which will output only the value of the specific information you want. For example:
```shell
dokku ps:report node-js-app --deployed
```