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

docs: split multi-flag internal property table rows

Browse Source 
The internal-properties tables on builds.md (8 --build-* flags),
ssl.md (8 --ssl-* flags), and process-management.md (4 ps flags) each
crammed all the flags into a single comma-separated table row with one
umbrella description. Splits each into a row per flag with a specific
description and the actual code-path source (the build record write
path, the openssl x509 parse target, the ps inspection helper).
This commit is contained in:
Jose Diaz-Gonzalez
2026-05-23 16:30:10 -04:00
parent 6f178afcb6
commit 052ba1fcfc
3 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/advanced-usage/builds.md
View File

@@ -176,4 +176,11 @@ The following properties surface in `builds:report` but are not managed by `buil
| Property | Kind | Description | Source |
|---|---|---|---|
| `--build-id`, `--build-kind`, `--build-status`, `--build-source`, `--build-pid`, `--build-started-at`, `--build-finished-at`, `--build-exit-code` | read-only | Per-build metadata for the most recent deploy | `plugins/builds/functions.go` writes during deploys |
| `--build-id` | read-only | Unique identifier of the most recent build for the app | `plugins/builds/functions.go` writes during deploys |
| `--build-kind` | read-only | Whether the record was a `build` or a `deploy` | `plugins/builds/functions.go` writes during deploys |
| `--build-status` | read-only | Display status (`running`, `succeeded`, `failed`, `canceled`, `abandoned`) | `plugins/builds/functions.go` writes during deploys; status is computed at read time |
| `--build-source` | read-only | Trigger that started the build (e.g. `git-hook`, `ps:rebuild`, `ps:restart`) | `plugins/builds/functions.go` writes during deploys |
| `--build-pid` | read-only | PID of the build process | `plugins/builds/functions.go` writes during deploys |
| `--build-started-at` | read-only | UNIX timestamp the build started | `plugins/builds/functions.go` writes during deploys |
| `--build-finished-at` | read-only | UNIX timestamp the build finished | `plugins/builds/functions.go` writes during deploys |
| `--build-exit-code` | read-only | Exit code of the build process | `plugins/builds/functions.go` writes during deploys |

9
docs/configuration/ssl.md
View File

@@ -157,4 +157,11 @@ The following properties surface in `certs:report` but are not managed by `certs
| Property | Kind | Description | Source |
|---|---|---|---|
| `--ssl-enabled`, `--ssl-dir`, `--ssl-hostnames`, `--ssl-issuer`, `--ssl-subject`, `--ssl-verified`, `--ssl-expires-at`, `--ssl-starts-at` | read-only | Metadata extracted from the on-disk certificate, if present | `plugins/certs/functions` openssl introspection |
| `--ssl-enabled` | read-only | `true` when an SSL certificate is installed for the app | `plugins/certs/internal-functions` checks `$DOKKU_ROOT/$APP/tls` |
| `--ssl-dir` | read-only | Absolute path to the per-app certificate directory | derived from `$DOKKU_ROOT/$APP/tls` |
| `--ssl-hostnames` | read-only | Hostnames the certificate covers (CN plus Subject Alternative Names) | `openssl x509` parse of `server.crt` |
| `--ssl-issuer` | read-only | Certificate issuer DN | `openssl x509 ... Issuer:` parse |
| `--ssl-subject` | read-only | Certificate subject DN | `openssl x509 ... Subject:` parse |
| `--ssl-verified` | read-only | `true` if the certificate chain verifies against the system CA bundle | `openssl verify` |
| `--ssl-expires-at` | read-only | Certificate `notAfter` timestamp | `openssl x509 ... Not After :` parse |
| `--ssl-starts-at` | read-only | Certificate `notBefore` timestamp | `openssl x509 ... Not Before:` parse |

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

@@ -471,4 +471,7 @@ The following properties surface in `ps:report` but are not managed by `ps:set`
| Property | Kind | Description | Source |
|---|---|---|---|
| `--ps-can-scale` | read-only | `false` when the app's procfile or builder forbids horizontal scaling | derived from procfile parse |
| `--deployed`, `--running`, `--processes`, `--status-<proctype>` | read-only | Live process state | `plugins/ps/report.go` inspects running containers |
| `--deployed` | read-only | `true` after the first successful deploy | `common.IsDeployed(appName)` checks the app's deploy marker |
| `--running` | read-only | `true` while any container for the app is running | `getRunningState(appName)` inspects running containers |
| `--processes` | read-only | Total scaled process count across all proctypes | `getProcessCount(appName)` reads the per-proctype scale formation |
| `--status-<proctype>` | read-only | Container status and ID for each running proctype (one entry per Procfile process type) | `plugins/ps/report.go::addStatusFlags` inspects running containers |