Skip to content
This repository was archived by the owner on Sep 12, 2024. It is now read-only.

Commit e2cacf6

Browse files
committed
Update helios create topic in user_manual.md
1 parent eea666a commit e2cacf6

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/user_manual.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Reviewed by [rculbertson](https://github.com/rculbertson) on 2014-08-11
1+
Reviewed by [dxia](https://github.com/rculbertson) on 2014-09-09
22

33
***
44

@@ -13,6 +13,7 @@ Note that this guide assumes that you are familiar with [Docker](http://docker.i
1313
* [A basic job](#a-basic-job)
1414
* [Specifying a command to run](#specifying-a-command-to-run)
1515
* [Passing environment variables](#passing-environment-variables)
16+
* [Using a helios job config file](#using-a-helios-job-config-file)
1617
* [Deploying Your Job](#deploying-your-job)
1718
* [Checking deployment status and history](#checking-deployment-status-and-history)
1819
* [Undeploying](#undeploying)
@@ -87,12 +88,9 @@ For some use cases, you may want to pass some environment variables to the job t
8788

8889
The last line of output in the command output is the canonical job ID. Most times, you will only need the `jobName:jobVersion` parts, but in the event that you create two jobs with the same name and version, you can unambiguously choose which one you intend to operate on by supplying the full ID.
8990

90-
As a current best practice, it is advised to put your `create` command lines into
91-
version-controlled files in your project directory, one file per create statement. This way,
92-
when you go to do subsequent job creations and deployments, you've got a record of what you did the
93-
last time.
91+
### Using a Helios job config file
9492

95-
`helios create -d <DOMAINS> -f <HELIOS_JOB_CONFIG_FILE_PATH> JOB_NAME IMAGE_NAME` will merge
93+
`helios create -d <DOMAINS> -f <HELIOS_JOB_CONFIG_FILE_PATH> <MORE> <CLI> <ARGS>` will merge
9694
job parameters in the file `<HELIOS_JOB_CONFIG_FILE_PATH>` with other command line arguments. CLI
9795
args take precedence. The job configuration file should be valid JSON with a schema that matches the
9896
output of `helios inspect -d <DOMAINS> <EXISTING_JOB_NAME> --json`. Here's an example:
@@ -126,6 +124,11 @@ output of `helios inspect -d <DOMAINS> <EXISTING_JOB_NAME> --json`. Here's an ex
126124
}
127125
```
128126

127+
A current best practice is to save all your job creation parameters in
128+
version-controlled files in your project directory. This allows you to tie
129+
your helios job params to changes in your application code.
130+
131+
129132
Deploying Your Job
130133
---
131134
Now that you've created a Helios job, you can deploy it to Helios hosts. You'll need to find a running Helios host to do so. You can see which hosts are available using the CLI. For example:

0 commit comments

Comments
 (0)