Skip to content

Commit 657ebe6

Browse files
committed
first pass README
- fixes #415
1 parent b47f801 commit 657ebe6

File tree

1 file changed

+35
-28
lines changed

1 file changed

+35
-28
lines changed

README.md

+35-28
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
![Terraform Provider Iterative](https://static.iterative.ai/img/cml/banner-terraform.png)
1+
![TPI](https://static.iterative.ai/img/cml/banner-terraform.png)
22

3-
# Iterative Provider [![](https://img.shields.io/badge/-documentation-5c4ee5?logo=terraform)](https://registry.terraform.io/providers/iterative/iterative/latest/docs)
3+
# Terraform Provider Iterative
44

5-
The Iterative Provider is a Terraform plugin that enables full lifecycle
6-
management of computing resources for machine learning pipelines, including GPUs, from your favorite cloud vendors.
5+
[![](https://img.shields.io/badge/-documentation-5c4ee5?logo=terraform)](https://registry.terraform.io/providers/iterative/iterative/latest/docs)
76

8-
The Iterative Provider makes it easy to:
7+
- **Orchestrate Resources**: create cloud compute & storage resources without reading pages of documentation
8+
- **Sync & Execute**: move data & run code in the cloud with minimal configuration
9+
- **Low cost**: auto-recovery from spot/preemptible instances to vastly reduce cost
10+
- **No waste**: auto-cleanup unused resources
11+
- **No lock-in**: switch between cloud vendors with minimal configuration
912

10-
- Rapidly move local machine learning experiments to a cloud infrastructure
11-
- Take advantage of training models on spot instances without losing any progress
12-
- Unify configuration of various cloud compute providers
13-
- Automatically destroy unused cloud resources (compute instances are terminated on job completion/failure, and storage is removed when results are downloaded)
13+
Iterative's Provider is a [Terraform](https://terraform.io) plugin built with machine learning pipelines in mind. It enables full lifecycle management of computing resources (including GPUs) from several cloud vendors:
1414

15-
The Iterative Provider can provision resources with the following cloud providers and orchestrators:
16-
17-
- Amazon Web Services
15+
- Amazon Web Services (AWS)
1816
- Microsoft Azure
19-
- Google Cloud Platform
20-
- Kubernetes
17+
- Google Cloud Platform (GCP)
18+
- Kubernetes (K8s)
19+
20+
The aim is to easily (minimal configuration unified across cloud vendors) move local experiments to the cloud, use low-cost spot instances without losing progress, and avoid being charged for unused cloud resources (terminate compute instances upon job completion/failure, and remove storage upon download of results).
2121

2222
## Documentation
2323

@@ -31,18 +31,7 @@ Have a feature request or found a bug? Let us know via [GitHub issues](https://g
3131

3232
Iterative Provider is released under the [Apache 2.0 License](https://github.com/iterative/terraform-provider-iterative/blob/master/LICENSE).
3333

34-
## Development
35-
36-
### Install Go 1.17+
37-
38-
Refer to the [official documentation](https://golang.org/doc/install) for specific instructions.
39-
40-
### Clone the repository
41-
42-
```console
43-
git clone https://github.com/iterative/terraform-provider-iterative
44-
cd terraform-provider-iterative
45-
```
34+
## Usage
4635

4736
### Install the provider
4837

@@ -64,8 +53,6 @@ provider "iterative" {}
6453
# ... other resource blocks ...
6554
```
6655

67-
**Note:** to use your local build, specify `source = "github.com/iterative/iterative"` (`source = "iterative/iterative"` will download the latest stable release instead).
68-
6956
### Initialize the provider
7057

7158
Run this command after every `make install` to use the new build:
@@ -79,3 +66,23 @@ terraform init --upgrade
7966
```console
8067
terraform apply
8168
```
69+
## Contributing
70+
71+
Instead of using the latest stable release, a local copy of the repository must be used.
72+
73+
### Install Go 1.17+
74+
75+
Refer to the [official documentation](https://golang.org/doc/install) for specific instructions.
76+
77+
### Clone the repository
78+
79+
```console
80+
git clone https://github.com/iterative/terraform-provider-iterative
81+
cd terraform-provider-iterative
82+
```
83+
84+
### Modify test file
85+
86+
Specify `source = "github.com/iterative/iterative"` to use the local repository.
87+
88+
**Note:** `source = "iterative/iterative"` will download the latest release instead.

0 commit comments

Comments
 (0)