terraform-provider-paperspace

README

terraform-provider-paperspace

This is a Terraform provider for Paperspace infrastructure.

It is offered currently as a Terraform 'private cloud' provider while under early development. We are moving toward contributing it back to the terraform open source project, which will remove the need for a separate download and installation step in the future.

Installation and Testing

1. Install terraform and make sure it is in your path.

2. Acquire a Paperspace API key for your account. See Paperspace API for instructions on creating an api key.

3. Copy the sample Terraform config file at src/terraform-provider-paperspace/main.tf into your project directory.
   
   Modify this file to use your actual API Key, valid user email address, and team id for the account associated with the API Key.
   
   Note: if you clone down this repo, you can build/download the binary as a sibling to src/terraform-provider-paperspace/main.tf, replace the values described in #4 above with yours, and follow #5 below to use the Paperspace Terraform provider directly from this directory.

4. Run the following terraform commands interactively to exercise the configuration and examine the output.
   
   Note: the sample configuration will create a machine with a public ip; testing this configuration will result in charges for the machine and public ip resources in most cases.

   terraform plan
   terraform apply
   terraform show
   terraform refresh
   terraform show
   terraform plan
   

5. When you are done with testing, run the following to destroy the configuration (and thus destroy the machine and script objects created above):

   terraform destroy
   terraform show
   

Building from source

1. Install the latest version of go that supports go modules (we currently use go 1.15 for this project)

2. Clone this repository and change to the project directory

git clone https://github.com/Paperspace/terraform-provider-paperspace.git
cd terraform-provider-paperspace

1. Build the Paperspace terraform provider On any platform:

go run main.go

Note: you cannot execute this provider binary directly. The binary will be loaded by the terraform app if the provider binary is in your path and your .tf configuration files refer to the paperspace provider and paperspace resources, or datasources.

Contributing

Want to contribute? Contact us at support@paperspace.com