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

docs & readme: what/why/how #433

Merged
merged 33 commits into from
Mar 15, 2022
Merged
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
1bcd9fc
first pass README
casperdcl Mar 8, 2022
5368f7e
Restyled by prettier-markdown
restyled-commits Mar 8, 2022
7cfe25b
readme: more restructuring
casperdcl Mar 8, 2022
6992d0e
readme: have a basic script
casperdcl Mar 8, 2022
76e11f6
docs: unify examples
casperdcl Mar 8, 2022
f0b6814
intuitive output
casperdcl Mar 8, 2022
e932990
docs/task: input realtive to script
casperdcl Mar 8, 2022
a4e14d7
minor tweak
casperdcl Mar 8, 2022
b1fa61b
some rewording
casperdcl Mar 8, 2022
2a11af5
docs: rename `workdir.input` => `storage.workdir`
casperdcl Mar 10, 2022
66a5a42
describe machine type better
casperdcl Mar 10, 2022
794304c
docs: update site landing
casperdcl Mar 10, 2022
c17f707
update badges
casperdcl Mar 10, 2022
ddf4910
note on workdir/output relation
casperdcl Mar 10, 2022
fb2ac4f
Restyled by prettier-markdown
restyled-commits Mar 10, 2022
5b18120
misc review updates
casperdcl Mar 10, 2022
40aabcc
readme: shorten contributing
casperdcl Mar 10, 2022
87a76ec
docs: licence badge, tidy installation instructions
casperdcl Mar 10, 2022
97583de
Restyled by prettier-markdown
restyled-commits Mar 10, 2022
6a0ffa2
re-add contrib build details
casperdcl Mar 11, 2022
68fe91d
review suggestions
casperdcl Mar 11, 2022
ac1dfc4
more sync & minification
casperdcl Mar 11, 2022
3f81ab0
docs: note/warning consistency
casperdcl Mar 11, 2022
18f7130
more feedback
casperdcl Mar 11, 2022
c5c1f1b
readme: re-added copyright
casperdcl Mar 11, 2022
d4b3736
remove licence year
casperdcl Mar 11, 2022
3b05aa3
docs: separate authentication guide
casperdcl Mar 11, 2022
4381e65
docs: minify landing further
casperdcl Mar 11, 2022
474ace9
explicit CPU/GPU/RAM
casperdcl Mar 11, 2022
6b91aa3
spotify
casperdcl Mar 14, 2022
9f2a105
re-separate commands, add `disk_size`
casperdcl Mar 14, 2022
aac92bc
update banner
casperdcl Mar 14, 2022
fd848e2
Restyled by prettier-markdown
restyled-commits Mar 14, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
re-separate commands, add disk_size
casperdcl committed Mar 14, 2022
commit 9f2a105e73cede4b4b015f5bcb6f0af84574fa8d
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -51,6 +51,7 @@ resource "iterative_task" "example" {
cloud = "aws" # or any of: gcp, az, k8s
machine = "m" # medium. Or any of: l, xl, m+k80, xl+v100, ...
spot = 0 # auto-price. Or -1 to disable, or >0 to set a hourly USD limit
disk_size = 30 # GB

storage {
workdir = "."
@@ -72,11 +73,32 @@ Run this once (in the directory containing `main.tf`) to download the `required_
terraform init
```

### Run a Task
### Run Task

- `terraform apply`: launch cloud instance(s), upload `workdir`, and run `script`
- `terraform refresh && terraform show`: query and display cloud status
- `terraform destroy`: terminate cloud instance(s), download `output`, and remove cloud storage
```
terraform apply
```

casperdcl marked this conversation as resolved.
Show resolved Hide resolved
This launches a `machine` in the `cloud`, uploads `workdir`, and runs the `script`. Upon completion (or error), the `machine` is terminated.

With spot/preemptible instances (`spot >= 0`), auto-recovery logic and persistent storage will be used to relaunch interrupted tasks.

### Query Status

Results and logs are periodically synced to persistent cloud storage. To query this status and view logs:

```
terraform refresh
terraform show
```

### Stop Tasks

```
terraform destroy
```

This terminates the `machine` (if still running), downloads `output`, and removes the persistent `disk_size` storage.

## Help

1 change: 1 addition & 0 deletions docs/guides/getting-started.md
Original file line number Diff line number Diff line change
@@ -34,6 +34,7 @@ resource "iterative_task" "example" {
cloud = "aws" # or any of: gcp, az, k8s
machine = "m" # medium. Or any of: l, xl, m+k80, xl+v100, ...
spot = 0 # auto-price. Or -1 to disable, or >0 to set a hourly USD limit
disk_size = 30 # GB

storage {
workdir = "."