iterative
diff --git a/‎.github/workflows/smoke.yml
Lines changed: 112 additions & 0 deletions b/‎.github/workflows/smoke.yml
Lines changed: 112 additions & 0 deletions
diff --git a/‎.goreleaser.yml
Lines changed: 7 additions & 4 deletions b/‎.goreleaser.yml
Lines changed: 7 additions & 4 deletions
diff --git a/‎Makefile
Lines changed: 9 additions & 3 deletions b/‎Makefile
Lines changed: 9 additions & 3 deletions
diff --git a/‎README.md
Lines changed: 3 additions & 1 deletion b/‎README.md
Lines changed: 3 additions & 1 deletion
diff --git a/‎docs/guides/getting-started.md
Lines changed: 102 additions & 0 deletions b/‎docs/guides/getting-started.md
Lines changed: 102 additions & 0 deletions
diff --git a/‎docs/index.md
Lines changed: 68 additions & 0 deletions b/‎docs/index.md
Lines changed: 68 additions & 0 deletions
@@ -0,0 +1,112 @@
+name: Smoke Test
+on:
+  pull_request_target:
+    paths: 'task/**'
+  schedule:
+  - cron: '0 9 * * 1'
+jobs:
+  authorize:
+    environment: ${{ github.event_name == 'schedule' && 'automatic' || 'manual' }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo ✓
+  start:
+    needs: authorize
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    outputs:
+      kubeconfig: ${{ steps.cluster.outputs.kubeconfig }}
+    steps:
+    - id: cluster
+      run: |
+        az login \
+          --service-principal \
+          --user="$AZURE_CLIENT_ID" \
+          --password="$AZURE_CLIENT_SECRET" \
+          --tenant="$AZURE_TENANT_ID"
+        az account set \
+          --subscription="$AZURE_SUBSCRIPTION_ID"
+        az extension add \
+          --name=aks-preview
+        az provider register \
+          --namespace=Microsoft.ContainerService
+        az feature register \
+          --namespace=Microsoft.ContainerService \
+          --name=GPUDedicatedVHDPreview
+        az group create \
+          --name="tpiSmokeTestCluster$GITHUB_RUN_ID" \
+          --location=eastus
+        az aks create \
+          --resource-group="tpiSmokeTestCluster$GITHUB_RUN_ID" \
+          --name="tpiSmokeTestCluster$GITHUB_RUN_ID" \
+          --node-vm-size=Standard_NC6 \
+          --node-count=1 \
+          --aks-custom-headers=UseGPUDedicatedVHD=true \
+          --generate-ssh-keys
+        az aks get-credentials \
+          --resource-group="tpiSmokeTestCluster$GITHUB_RUN_ID" \
+          --name="tpiSmokeTestCluster$GITHUB_RUN_ID" \
+          --file - |
+        perl -p -e 's/%/%25/g;' -e 's/\n/%0A/g;' -e 's/\r/%0D/g;' |
+        xargs -0 printf "::set-output name=kubeconfig::%s\n"
+      env:
+        AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+        AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+        AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+        AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+  test:
+    needs: start
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        provider: [AWS, AZ, GCP, K8S]
+    env:
+      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+      AWS_SESSION_TOKEN: ${{ secrets.AWS_SESSION_TOKEN }}
+      AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+      AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+      AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+      GOOGLE_APPLICATION_CREDENTIALS_DATA: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS_DATA }}
+      KUBECONFIG_DATA: ${{ needs.start.outputs.kubeconfig }}
+      SMOKE_TEST_IDENTIFIER: smoke test ${{ github.run_id }}
+      SMOKE_TEST_ENABLE_${{ matrix.provider }}: true
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-go@v2
+      with:
+        go-version: ^1.17
+    - run: go test ./task -v -timeout=30m -count=1
+    - if: always()
+      uses: actions/checkout@v2
+      with:
+        ref: master
+    - if: always()
+      run: go test ./task -v -timeout=30m -count=1
+      env:
+        SMOKE_TEST_SWEEP: true
+  stop:
+    if: always()
+    needs: test
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+    - run: |
+        az login \
+          --service-principal \
+          --user="$AZURE_CLIENT_ID" \
+          --password="$AZURE_CLIENT_SECRET" \
+          --tenant="$AZURE_TENANT_ID"
+        az account set \
+          --subscription="$AZURE_SUBSCRIPTION_ID"
+        az group delete \
+          --name="tpiSmokeTestCluster$GITHUB_RUN_ID" \
+          --yes
+      env:
+        AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+        AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+        AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+        AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
@@ -1,6 +1,3 @@
-before:
-  hooks:
-    - go mod vendor
 builds:
 - env:
   - CGO_ENABLED=0
@@ -24,11 +21,17 @@ builds:
       goarch: '386'
   binary: '{{ .ProjectName }}_v{{ .Version }}'
 archives:
-- format: zip
+- id: default
+  format: zip
   name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}'
+- id: agent
+  format: binary
+  name_template: '{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}'
 checksum:
   name_template: '{{ .ProjectName }}_{{ .Version }}_SHA256SUMS'
   algorithm: sha256
+  ids:
+  - default
 signs:
   - artifacts: checksum
     args:
 
@@ -1,12 +1,12 @@
 HOSTNAME=github.com
 NAMESPACE=iterative
 NAME=iterative
-VERSION=0.0.0+development
+VERSION=0.0.${shell date +%s}+development
 OS_ARCH=${shell go env GOOS}_${shell go env GOARCH}
 BINARY=terraform-provider-${NAME}
 INSTALL_PATH=~/.terraform.d/plugins/${HOSTNAME}/${NAMESPACE}/${NAME}/${VERSION}/${OS_ARCH}
 
-default: install
+default: build
 
 build:
 	go build
@@ -15,7 +15,13 @@ install:
 	GOBIN=${INSTALL_PATH} go install
 
 test:
-	go test ./... ${TESTARGS} -timeout=30s -parallel=4
+	go test ./... ${TESTARGS} -timeout=30s -parallel=4 -short
+
+smoke:
+	go test ./task -v ${TESTARGS} -timeout=30m -count=1
+
+sweep:
+	SMOKE_TEST_SWEEP=true go test ./task -v ${TESTARGS} -timeout=30m -count=1
 
 testacc:
 	TF_ACC=1 go test ./... -v ${TESTARGS} -timeout 120m
@@ -1,6 +1,6 @@
 ![Terraform Provider Iterative](https://static.iterative.ai/img/cml/banner-terraform.png)
 
-# Terraform Iterative provider
+# Iterative Provider [![](https://img.shields.io/badge/-documentation-5c4ee5?logo=terraform)](https://registry.terraform.io/providers/iterative/iterative/latest/docs)
 
 The Iterative Provider is a Terraform plugin that enables full lifecycle
 management of cloud computing resources, including GPUs, from your favorite
@@ -20,6 +20,8 @@ The Provider is designed for benefits like:
 
 ## Usage
 
+See [this guide](https://registry.terraform.io/providers/iterative/iterative/latest/docs/guides/getting-started) for more information.
+
 ### Runner
 
 A self hosted runner based on a thin wrapper over the GitLab and GitHub
 
@@ -0,0 +1,102 @@
+---
+page_title: Getting Started
+---
+
+# Getting Started
+
+Begin by [installing Terraform 1.0 or greater](https://learn.hashicorp.com/tutorials/terraform/install-cli#install-terraform) if needed.
+
+## Defining a Task
+
+In the project root directory:
+
+1. Create a directory named `shared` to store input data and output artifacts.
+2. Create a file named `main.tf` with the following contents:
+
+```hcl
+terraform {
+  required_providers {
+    iterative = {
+      source  = "iterative/iterative"
+    }
+  }
+}
+
+provider "iterative" {}
+
+resource "iterative_task" "example" {
+  name  = "example"
+  cloud = "aws" # or any of: gcp, az, k8s
+
+  directory = "${path.root}/shared"
+
+  script = <<-END
+    #!/bin/bash
+    echo "Hello World!" > greeting.txt
+  END
+}
+```
+
+-> **Note**: The `script` argument can take anny string, including a [heredoc](https://www.terraform.io/docs/language/expressions/strings.html#heredoc-strings) or the contents of a file returned by the [`file`](https://www.terraform.io/docs/language/functions/file.html) function.
+
+The project layout should look similar to this:
+
+project/
+├─ shared/
+│ └─ ···
+└─ main.tf
+
+## Initializing Terraform
+
+```console
+$ terraform init
+```
+
+This command will:
+
+1. Download and install the Iterative Provider.
+2. Initialize Terraform in the current directory.
+
+~> **Note:** None of the subsequent commands will work without first setting some [authentication environment variables](https://registry.terraform.io/providers/iterative/iterative/latest/docs#authentication).
+
+## Launching Tasks
+
+```console
+$ terraform apply
+···
+```
+
+This command will:
+
+1. Create all the required cloud resources.
+2. Upload the specified shared `directory` to the cloud.
+3. Launch the task `script`.
+
+## Viewing Task Statuses
+
+```console
+$ terraform refresh && terraform show
+resource "iterative_task" "example" {
+  ···
+}
+```
+
+This command will:
+
+1. Query the task status from the cloud.
+2. Display the task status.
+
+## Deleting Tasks
+
+```console
+terraform destroy
+```
+
+This command will:
+
+1. Download the specified shared `directory` from the cloud.
+2. Delete all the created cloud resources.
+
+## Viewing Task Results
+
+After running `terraform destroy`, the `shared/` directory should contain a file named `greeting.txt` with the text `Hello, World!`
@@ -0,0 +1,68 @@
+# Iterative Provider
+
+Use the Iterative Provider to launch resource-intensive tasks in popular cloud
+providers with a single Terraform file.
+
+## Example Usage
+
+```hcl
+terraform {
+  required_providers {
+    iterative = {
+      source  = "iterative/iterative"
+    }
+  }
+}
+
+provider "iterative" {}
+
+resource "iterative_task" "task" {
+  name  = "example"
+  cloud = "aws"
+
+  script = <<-END
+    #!/bin/bash
+    echo "hello!"
+  END
+}
+```
+
+-> **Note:** See the [Getting Started](https://registry.terraform.io/providers/iterative/iterative/latest/docs/guides/getting-started) for more information.
+
+## Authentication
+
+[Environment variables](https://registry.terraform.io/providers/iterative/iterative/latest/docs#authentication) are the only supported authentication method. They should
+be present when running any of the `terraform` commands.
+
+### Example
+
+```bash
+$ export GOOGLE_APPLICATION_CREDENTIALS_DATA="$(cat service_account.json)"
+$ terraform apply
+```
+
+### Amazon Web Services
+
+- `AWS_ACCESS_KEY_ID` - Access key identifier.
+- `AWS_SECRET_ACCESS_KEY` - Secret access key.
+- `AWS_SESSION_TOKEN` - (Optional) Session token.
+
+### Google Cloud Platform
+
+- `GOOGLE_APPLICATION_CREDENTIALS` - Path to a service account JSON key file.
+
+-> **Note** you can also use `GOOGLE_APPLICATION_CREDENTIALS_DATA` with the
+**contents** of the service account JSON key file.
+
+### Microsoft Azure
+
+- `AZURE_CLIENT_ID` - Client identifier.
+- `AZURE_CLIENT_SECRET` - Client secret.
+- `AZURE_SUBSCRIPTION_ID` - Subscription identifier.
+- `AZURE_TENANT_ID` - Tenant identifier.
+
+### Kubernetes
+
+- `KUBECONFIG` - Path to a [`kubeconfig` file](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable).
+
+-> **Note**: You can use `KUBECONFIG_DATA` instead, with the **contents** of the `kubeconfig` file.