Skip to content

Commit bd84d1c

Browse files
docs(serverless_jobs): add documentation for command, timezone and schedule fields (#3749)
Co-authored-by: Mia-Cross <[email protected]>
1 parent b752247 commit bd84d1c

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

cmd/scw/testdata/test-all-usage-jobs-definition-create-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ARGS:
1111
memory-limit Memory limit of the job (in MiB)
1212
[local-storage-capacity] Local storage capacity of the job (in MiB)
1313
[image-uri] Image to use for the job
14-
[command] Startup command
14+
[command] Startup command. If empty or not defined, the image's default command is used.
1515
[project-id] Project ID to use. If none is passed the default project ID will be used
1616
[environment-variables.{key}] Environment variables of the job
1717
[description] Description of the job

docs/commands/jobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ scw jobs definition create [arg=value ...]
4141
| memory-limit | Required | Memory limit of the job (in MiB) |
4242
| local-storage-capacity | | Local storage capacity of the job (in MiB) |
4343
| image-uri | | Image to use for the job |
44-
| command | | Startup command |
44+
| command | | Startup command. If empty or not defined, the image's default command is used. |
4545
| project-id | | Project ID to use. If none is passed the default project ID will be used |
4646
| environment-variables.{key} | | Environment variables of the job |
4747
| description | | Description of the job |

internal/namespaces/jobs/v1alpha1/jobs_cli.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ func jobsDefinitionCreate() *core.Command {
107107
},
108108
{
109109
Name: "command",
110-
Short: `Startup command`,
110+
Short: `Startup command. If empty or not defined, the image's default command is used.`,
111111
Required: false,
112112
Deprecated: false,
113113
Positional: false,

0 commit comments

Comments
 (0)