Merge pull request #3 from spicehq/evgenii/2025-12-10/refactor

Refactor provider according to API Spec

Author: ewgenius

.gitignore

@@ -35,3 +35,6 @@ website/vendor
 *.winfile eol=crlf
 
 .env
+
+# binary
+terraform-provider-spiceai

README.md

@@ -1,6 +1,6 @@
 # Terraform Provider for Spice.ai
 
-This Terraform provider allows you to manage [Spice.ai](https://spice.ai) resources including apps, app configurations, and deployments.
+This Terraform provider allows you to manage [Spice.ai Cloud](https://spice.ai) resources including apps and deployments.
 
 ## Requirements
 
@@ -61,75 +61,62 @@ provider "spiceai" {
 
 ### spiceai_app
 
-Manages a Spice.ai app.
+Manages a Spice.ai app and its configuration. This resource combines app creation with spicepod and runtime configuration.
 
 ```hcl
 resource "spiceai_app" "example" {
   name        = "my-app"
   description = "My Spice.ai application"
-  visibility  = "private" # or "public"
-}
-```
-
-#### Attributes
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `name` | string | Yes | The name of the app (min 4 chars, alphanumeric and hyphens only) |
-| `description` | string | No | A description of the app |
-| `visibility` | string | No | The visibility (`public` or `private`, default: `private`) |
-
-#### Read-Only Attributes
-
-- `id` - The unique identifier of the app
-- `region` - The region where the app is deployed
-- `created_at` - Timestamp when the app was created
-- `api_key` - The API key for the app (sensitive)
-
-### spiceai_app_config
-
-Applies configuration to a Spice.ai app.
-
-```hcl
-resource "spiceai_app_config" "example" {
-  app_id = spiceai_app.example.id
+  visibility  = "private"
 
+  # Spicepod configuration (YAML or JSON)
   spicepod = <<-YAML
     version: v1beta1
     kind: Spicepod
     name: my-app
     datasets:
-      - name: my_dataset
-        from: s3://bucket/path/
+      - name: taxi_trips
+        from: s3://spiceai-demo-datasets/taxi_trips/2024/
+        params:
+          file_format: parquet
   YAML
 
-  image_tag           = "latest"
-  replicas            = 2
-  node_group          = "default"
-  region              = "us-east-1"
+  # Runtime configuration
+  image_tag             = "latest"
+  replicas              = 2
+  node_group            = "default"
+  region                = "us-east-1"
   storage_claim_size_gb = 10.0
-  production_branch   = "main"
+  production_branch     = "main"
 }
 ```
 
-#### Attributes
+#### Arguments
 
 | Name | Type | Required | Description |
 |------|------|----------|-------------|
-| `app_id` | string | Yes | The ID of the app to configure |
-| `spicepod` | string | No | Spicepod configuration (YAML or JSON) |
-| `image_tag` | string | No | Spice.ai runtime image tag |
+| `name` | string | Yes | The name of the app (min 4 chars, alphanumeric and hyphens only). Changing this forces a new resource. |
+| `description` | string | No | A description of the app |
+| `visibility` | string | No | The visibility (`public` or `private`, default: `private`) |
+| `spicepod` | string | No | Spicepod configuration (YAML or JSON string) |
+| `image_tag` | string | No | Spice.ai runtime image tag (e.g., `latest`, `v0.18.0`) |
 | `replicas` | int | No | Number of replicas (1-10) |
 | `node_group` | string | No | Node group for deployment |
 | `region` | string | No | Deployment region |
 | `storage_claim_size_gb` | float | No | Storage claim size in GB |
-| `production_branch` | string | No | Production branch name |
-| `description` | string | No | App description |
-| `visibility` | string | No | App visibility |
+| `production_branch` | string | No | Production branch name for git-based deployments |
+
+#### Read-Only Attributes
+
+| Name | Description |
+|------|-------------|
+| `id` | The unique identifier of the app |
+| `created_at` | Timestamp when the app was created |
+| `api_key` | The API key for the app (sensitive) |
 
 ### spiceai_deployment
 
-Creates a deployment for a Spice.ai app.
+Creates a deployment for a Spice.ai app. Deployments are immutable - any changes will trigger creation of a new deployment.
 
 ```hcl
 resource "spiceai_deployment" "example" {
@@ -142,39 +129,39 @@ resource "spiceai_deployment" "example" {
   commit_sha     = "abc123def456"
   commit_message = "Deploy from Terraform"
   debug          = false
-
-  depends_on = [spiceai_app_config.example]
 }
 ```
 
-#### Attributes
+#### Arguments
 
 | Name | Type | Required | Description |
 |------|------|----------|-------------|
-| `app_id` | string | Yes | The ID of the app to deploy |
-| `image_tag` | string | No | Override image tag for this deployment |
-| `replicas` | int | No | Override replicas (1-10) |
-| `branch` | string | No | Git branch name |
-| `commit_sha` | string | No | Git commit SHA |
-| `commit_message` | string | No | Git commit message |
-| `debug` | bool | No | Enable debug mode (default: false) |
+| `app_id` | string | Yes | The ID of the app to deploy. Changing this forces a new deployment. |
+| `image_tag` | string | No | Override image tag for this deployment. Changing this forces a new deployment. |
+| `replicas` | int | No | Override replicas (1-10). Changing this forces a new deployment. |
+| `branch` | string | No | Git branch name. Changing this forces a new deployment. |
+| `commit_sha` | string | No | Git commit SHA. Changing this forces a new deployment. |
+| `commit_message` | string | No | Git commit message. Changing this forces a new deployment. |
+| `debug` | bool | No | Enable debug mode (default: false). Changing this forces a new deployment. |
 
 #### Read-Only Attributes
 
-- `id` - The unique identifier of the deployment
-- `status` - Current status (`queued`, `deploying`, `running`, `failed`, `stopped`)
-- `created_at` - Timestamp when the deployment was created
-- `started_at` - Timestamp when the deployment started
-- `finished_at` - Timestamp when the deployment finished
-- `error_message` - Error message if deployment failed
+| Name | Description |
+|------|-------------|
+| `id` | The unique identifier of the deployment |
+| `status` | Current status (`queued`, `deploying`, `running`, `failed`, `stopped`) |
+| `created_at` | Timestamp when the deployment was created |
+| `started_at` | Timestamp when the deployment started running |
+| `finished_at` | Timestamp when the deployment finished |
+| `error_message` | Error message if deployment failed |
 
 > **Note:** Deployments are immutable. Any changes to deployment parameters will trigger a replacement (new deployment).
 
 ## Data Sources
 
 ### spiceai_app
 
-Retrieves details about an existing app.
+Retrieves details about an existing app by ID.
 
 ```hcl
 data "spiceai_app" "example" {
@@ -184,6 +171,10 @@ data "spiceai_app" "example" {
 output "app_name" {
   value = data.spiceai_app.example.name
 }
+
+output "app_replicas" {
+  value = data.spiceai_app.example.replicas
+}
 ```
 
 ### spiceai_apps
@@ -196,6 +187,10 @@ data "spiceai_apps" "all" {}
 output "app_names" {
   value = [for app in data.spiceai_apps.all.apps : app.name]
 }
+
+output "private_apps" {
+  value = [for app in data.spiceai_apps.all.apps : app.name if app.visibility == "private"]
+}
 ```
 
 ## Example Usage
@@ -210,18 +205,16 @@ terraform {
   }
 }
 
-provider "spiceai" {}
+provider "spiceai" {
+  # Credentials are read from environment variables:
+  # SPICEAI_CLIENT_ID and SPICEAI_CLIENT_SECRET
+}
 
-# Create an app
+# Create an app with configuration
 resource "spiceai_app" "example" {
   name        = "my-terraform-app"
   description = "Managed by Terraform"
   visibility  = "private"
-}
-
-# Configure the app with a spicepod
-resource "spiceai_app_config" "example" {
-  app_id = spiceai_app.example.id
 
   spicepod = <<-YAML
     version: v1beta1
@@ -232,22 +225,26 @@ resource "spiceai_app_config" "example" {
         from: s3://spiceai-demo-datasets/taxi_trips/2024/
         params:
           file_format: parquet
-    YAML
+  YAML
 
-  replicas = 1
+  image_tag = "latest"
+  replicas  = 1
 }
 
 # Deploy the app
 resource "spiceai_deployment" "example" {
   app_id = spiceai_app.example.id
-  
-  depends_on = [spiceai_app_config.example]
 }
 
 output "app_id" {
   value = spiceai_app.example.id
 }
 
+output "app_api_key" {
+  value     = spiceai_app.example.api_key
+  sensitive = true
+}
+
 output "deployment_status" {
   value = spiceai_deployment.example.status
 }
@@ -261,9 +258,6 @@ Resources can be imported using their IDs:
 # Import an app
 terraform import spiceai_app.example 12345
 
-# Import an app config (uses app ID)
-terraform import spiceai_app_config.example 12345
-
 # Import a deployment (format: app_id/deployment_id)
 terraform import spiceai_deployment.example 12345/67890
 ```
@@ -295,6 +289,12 @@ provider_installation {
 }
 ```
 
+### Generating Documentation
+
+```bash
+go generate ./...
+```
+
 ## License
 
 MPL-2.0. See [LICENSE](LICENSE) file.

docs/data-sources/api_keys.md

@@ -0,0 +1,25 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "spiceai_api_keys Data Source - spiceai"
+subcategory: ""
+description: |-
+  Retrieves the API keys for a Spice.ai app. Each app has two API keys to support key rotation.
+---
+
+# spiceai_api_keys (Data Source)
+
+Retrieves the API keys for a Spice.ai app. Each app has two API keys to support key rotation.
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `app_id` (String) The unique identifier of the app.
+
+### Read-Only
+
+- `api_key` (String, Sensitive) The primary API key for the app.
+- `api_key_2` (String, Sensitive) The secondary API key for the app.

docs/data-sources/app.md

@@ -3,27 +3,57 @@
 page_title: "spiceai_app Data Source - spiceai"
 subcategory: ""
 description: |-
-  Retrieves details about a Spice.ai app by its ID.
+  Retrieves details about an existing Spice.ai app by its ID.
 ---
 
 # spiceai_app (Data Source)
 
-Retrieves details about a Spice.ai app by its ID.
+Retrieves details about an existing Spice.ai app by its ID.
 
 ## Example Usage
 
 ```terraform
+# Get details about an existing app by ID
 data "spiceai_app" "example" {
   id = "12345"
 }
 
+# Use data from an existing app
 output "app_name" {
-  value = data.spiceai_app.example.name
+  description = "The name of the app"
+  value       = data.spiceai_app.example.name
 }
 
+output "app_visibility" {
+  description = "The visibility of the app"
+  value       = data.spiceai_app.example.visibility
+}
+
+output "app_region" {
+  description = "The region where the app is deployed"
+  value       = data.spiceai_app.example.region
+}
+
+output "app_replicas" {
+  description = "The number of replicas configured for the app"
+  value       = data.spiceai_app.example.replicas
+}
+
+output "app_image_tag" {
+  description = "The runtime image tag for the app"
+  value       = data.spiceai_app.example.image_tag
+}
+
+# Reference an app created by another resource
+data "spiceai_app" "from_resource" {
+  id = spiceai_app.example.id
+}
+
+# Use data source to get app API key for other configurations
 output "app_api_key" {
-  value     = data.spiceai_app.example.api_key
-  sensitive = true
+  description = "The API key for the app"
+  value       = data.spiceai_app.from_resource.api_key
+  sensitive   = true
 }
 ```
 
@@ -37,21 +67,15 @@ output "app_api_key" {
 ### Read-Only
 
 - `api_key` (String, Sensitive) The API key for the app.
-- `config` (Attributes) The configuration of the app. (see [below for nested schema](#nestedatt--config))
+- `cluster_id` (String) The Kubernetes cluster identifier where the app is deployed.
 - `created_at` (String) The timestamp when the app was created.
 - `description` (String) A description of the app.
+- `image_tag` (String) The Spice.ai runtime image tag.
 - `name` (String) The name of the app.
+- `node_group` (String) The node group for the app.
 - `production_branch` (String) The production branch for the app.
 - `region` (String) The region where the app is deployed.
-- `visibility` (String) The visibility of the app (public or private).
-
-<a id="nestedatt--config"></a>
-### Nested Schema for `config`
-
-Read-Only:
-
-- `image_tag` (String) The Spice.ai runtime image tag.
-- `node_group` (String) The node group for the app.
 - `replicas` (Number) The number of replicas.
 - `spicepod` (String) The spicepod configuration as a JSON string.
 - `storage_claim_size_gb` (Number) The storage claim size in GB.
+- `visibility` (String) The visibility of the app (`public` or `private`).