Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docs on request and deploy concepts #922

Merged
merged 1 commit into from Feb 26, 2016
Merged

add docs on request and deploy concepts #922

merged 1 commit into from Feb 26, 2016

Conversation

@ssalinas
Copy link
Member

ssalinas commented Feb 25, 2016

@tpetr
Copy link
Member

tpetr commented Feb 25, 2016

Could be good to get @markhazlewood's eyes on this too

@tpetr
Copy link
Member

tpetr commented Feb 26, 2016

I kind of have a nitpick with the first person tone (doesn't match the test of the docs), but beside that, LGTM

@ssalinas
Copy link
Member Author

ssalinas commented Feb 26, 2016

Updated to sound more like the docs in examples.md

@ssalinas ssalinas force-pushed the request_docs branch from 649b24e to df0c64f Feb 26, 2016


### Creating a `Request`
You have a new web service called `TestService` that you want to run via Singularity. The first thing you need to do is create a `Request` for `TestService`. To create this request, you would `POST` json over http to the Singularity API or create a request via the new request page in the Singularity UI. Example json:

This comment has been minimized.

@tpetr

tpetr Feb 26, 2016 Member

may want to include the endpoint (.../api/requests) or a link to the API reference doc for creating the request


### Creating a `Deploy`

Now you want to actually start a task for `TestService`. To do this, you need to create a `Deploy` for the `TestService` `Request`. This deploy will let Singularity know all of the information necessary to actually build and launch a task. This information includes things like the command to run, environment variables to set, the location of any artifacts to download, or the resources that should be allocated to a task. You would create this deploy by `POST`ing json to the Singularity API's deploy endpoint, or creating a new deploy in the Singularity UI. Example json:

This comment has been minimized.

@tpetr

tpetr Feb 26, 2016 Member

"now you actually want to start a task" may not make sense to new users -- "Now you want TestService to actually run" may make more sense

@ssalinas ssalinas force-pushed the request_docs branch from da5b96d to dc68bb9 Feb 26, 2016
@tpetr
Copy link
Member

tpetr commented Feb 26, 2016

LGTM

ssalinas added a commit that referenced this pull request Feb 26, 2016
add docs on request and deploy concepts
@ssalinas ssalinas merged commit e1fe715 into master Feb 26, 2016
2 checks passed
2 checks passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
@ssalinas ssalinas deleted the request_docs branch Feb 26, 2016
@ssalinas ssalinas modified the milestone: 0.4.12 Apr 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.