From 8ecfed45449a807ca97b3b148d993ce39432a787 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Fri, 8 Dec 2023 10:28:12 -0500 Subject: [PATCH] Expand one-off task details This changeset adds a bit more information to the one-off task details and helps clarify what to include in the command to pass to Cloud Foundry. --- docs/all.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/all.md b/docs/all.md index fc6bd414e..32c2216c4 100644 --- a/docs/all.md +++ b/docs/all.md @@ -477,7 +477,18 @@ Appending `--help` to any command will give you more information about parameter To run a command on cloud.gov, use this format: -`cf run-task CLOUD-GOV-APP --commmand "YOUR COMMAND HERE" --name YOUR-COMMAND` +`cf run-task CLOUD-GOV-APP --commmand "YOUR COMMAND HERE" --name YOUR-COMMAND-NAME` + +**NOTE:** Do not include `poetry run` in the command you provide for `cf run-task`! cloud.gov is already aware +of the Python virtual environment and Python dependencies; it's all handled through the Python brokerpak we use +to deploy the application. + +For example, if you want to update the templates in one of the remote environments after a change to the JSON +file, you would run this: + +```sh +cf run-task CLOUD-GOV-APP --command "flask command update-templates" --name YOUR-COMMAND-NAME +``` [Here's more documentation](https://docs.cloudfoundry.org/devguide/using-tasks.html) about Cloud Foundry tasks.