Update terraform provider to support required cname (#9)

* Add required cname (region identifier) to app resource and docs

* Make image_tag configurable in local-spice-api example

Preserve user spicepod value during Create/Update to avoid inconsistent
result errors

Author: ewgenius

docs/data-sources/app.md

@@ -68,6 +68,7 @@ output "app_api_key" {
 
 - `api_key` (String, Sensitive) The API key for the app.
 - `cluster_id` (String) The Kubernetes cluster identifier where the app is deployed.
+- `cname` (String) The region identifier (cname) for the app.
 - `created_at` (String) The timestamp when the app was created.
 - `description` (String) A description of the app.
 - `image` (String) Image name for the spiced container.

docs/data-sources/apps.md

@@ -86,6 +86,7 @@ Read-Only:
 
 - `api_key` (String, Sensitive) The API key for the app.
 - `cluster_id` (String) The Kubernetes cluster identifier where the app is deployed.
+- `cname` (String) The region identifier (cname) for the app.
 - `created_at` (String) The timestamp when the app was created.
 - `description` (String) A description of the app.
 - `id` (String) The unique identifier of the app.

docs/resources/app.md

@@ -11,6 +11,7 @@ description: |-
     name        = "my-terraform-app"
     description = "An app created and managed by Terraform"
     visibility  = "private"
+    cname       = "us-east-2.spice.cloud"  # Required: region identifier from spiceai_regions data source
   
     # Spicepod configuration (YAML or JSON)
     spicepod = <<-YAML
@@ -28,7 +29,7 @@ description: |-
     image_tag             = "latest"
     replicas              = 2
     node_group            = "default"
-    region                = "us-east-1"
+    region                = "us-east-2"
     storage_claim_size_gb = 10.0
     production_branch     = "main"
   }
@@ -47,6 +48,7 @@ resource "spiceai_app" "example" {
   name        = "my-terraform-app"
   description = "An app created and managed by Terraform"
   visibility  = "private"
+  cname       = "us-east-2.spice.cloud"  # Required: region identifier from spiceai_regions data source
 
   # Spicepod configuration (YAML or JSON)
   spicepod = <<-YAML
@@ -64,7 +66,7 @@ resource "spiceai_app" "example" {
   image_tag             = "latest"
   replicas              = 2
   node_group            = "default"
-  region                = "us-east-1"
+  region                = "us-east-2"
   storage_claim_size_gb = 10.0
   production_branch     = "main"
 }
@@ -78,13 +80,15 @@ resource "spiceai_app" "basic" {
   name        = "my-basic-app"
   description = "A basic Spice.ai app"
   visibility  = "private"
+  cname       = "us-east-2.spice.cloud" # Required: region identifier from spiceai_regions data source
 }
 
 # Full app with spicepod and runtime configuration
 resource "spiceai_app" "full" {
   name        = "my-full-app"
   description = "A fully configured Spice.ai app"
   visibility  = "private"
+  cname       = "us-east-2.spice.cloud"
 
   # Spicepod configuration (YAML or JSON)
   spicepod = <<-YAML
@@ -105,7 +109,7 @@ resource "spiceai_app" "full" {
   image_tag             = "latest"
   replicas              = 2
   node_group            = "default"
-  region                = "us-east-1"
+  region                = "us-east-2"
   storage_claim_size_gb = 10.0
   production_branch     = "main"
 }
@@ -115,6 +119,7 @@ resource "spiceai_app" "json_config" {
   name        = "my-json-app"
   description = "An app with JSON spicepod configuration"
   visibility  = "public"
+  cname       = "us-west-2.spice.cloud"
 
   spicepod = jsonencode({
     version = "v1beta1"
@@ -130,13 +135,24 @@ resource "spiceai_app" "json_config" {
 
   replicas = 1
 }
+
+# App using regions data source to get cname
+data "spiceai_regions" "available" {}
+
+resource "spiceai_app" "with_region_lookup" {
+  name        = "my-dynamic-region-app"
+  description = "An app using dynamic region lookup"
+  visibility  = "private"
+  cname       = data.spiceai_regions.available.regions[0].cname
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
+- `cname` (String) The region identifier (cname) for the app. This is required when creating an app and determines where the app is deployed. Get available values from the `spiceai_regions` data source. Changing this forces a new resource to be created.
 - `name` (String) The name of the app. Must be at least 4 characters and contain only letters, numbers, and hyphens. Changing this forces a new resource to be created.
 
 ### Optional

examples/local-spice-api/.terraform.lock.hcl

@@ -11,7 +11,8 @@ terraform {
 # Provider configuration
 provider "spiceai" {
   # Optional: Custom API endpoint (defaults to https://api.spice.ai)
-  api_endpoint = "http://localhost:8080"
+  api_endpoint = "https://dev-api.spice.ai"
+  # api_endpoint = "http://localhost:8080"
 
   # Optional: Custom OAuth endpoint (defaults to https://spice.ai/api/oauth/token)
   # oauth_endpoint = "https://spice.ai/api/oauth/token"
@@ -24,20 +25,24 @@ locals {
   app_name = "terraform-test-app-local-2"
 }
 
+# Get available regions
+data "spiceai_regions" "available" {}
+
 # Create a test app with full configuration
 resource "spiceai_app" "test" {
   name        = local.app_name
   description = "Test app for Terraform provider validation, updated description"
   visibility  = "private"
+  cname       = "dev-data" # Required: region identifier
 
   # Spicepod configuration from template file with app name
   spicepod = templatefile("${path.module}/spicepod.yaml.tftpl", {
     app_name = local.app_name
   })
 
   # # Runtime configuration
-  image_tag = "1.10.0-enterprise-models"
-  replicas  = 3
+  image_tag = var.image_tag
+  replicas  = 1
   # production_branch = "main"
 }
 

examples/local-spice-api/main.tf

@@ -0,0 +1,5 @@
+variable "image_tag" {
+  description = "The Spice.ai runtime image tag to use for deployments"
+  type        = string
+  default     = "1.10.4-enterprise-models"
+}

examples/local-spice-api/variables.tf

@@ -18,11 +18,15 @@ provider "spiceai" {
   # api_endpoint  = "https://api.spice.ai" # Optional, defaults to production API
 }
 
+# Get available regions
+data "spiceai_regions" "available" {}
+
 # Create a new Spice.ai app with configuration
 resource "spiceai_app" "example" {
   name        = "my-terraform-app"
   description = "An app created and managed by Terraform"
   visibility  = "private"
+  cname       = data.spiceai_regions.available.regions[0].cname # Required: region identifier
 
   # Spicepod configuration (YAML or JSON string)
   spicepod = <<-YAML
@@ -39,7 +43,7 @@ resource "spiceai_app" "example" {
   # Runtime configuration
   image_tag         = "latest"
   replicas          = 1
-  region            = "us-east-1"
+  region            = "us-east-2"
   production_branch = "main"
 }
 

examples/main.tf

@@ -3,13 +3,15 @@ resource "spiceai_app" "basic" {
   name        = "my-basic-app"
   description = "A basic Spice.ai app"
   visibility  = "private"
+  cname       = "us-east-2.spice.cloud" # Required: region identifier from spiceai_regions data source
 }
 
 # Full app with spicepod and runtime configuration
 resource "spiceai_app" "full" {
   name        = "my-full-app"
   description = "A fully configured Spice.ai app"
   visibility  = "private"
+  cname       = "us-east-2.spice.cloud"
 
   # Spicepod configuration (YAML or JSON)
   spicepod = <<-YAML
@@ -30,7 +32,7 @@ resource "spiceai_app" "full" {
   image_tag             = "latest"
   replicas              = 2
   node_group            = "default"
-  region                = "us-east-1"
+  region                = "us-east-2"
   storage_claim_size_gb = 10.0
   production_branch     = "main"
 }
@@ -40,6 +42,7 @@ resource "spiceai_app" "json_config" {
   name        = "my-json-app"
   description = "An app with JSON spicepod configuration"
   visibility  = "public"
+  cname       = "us-west-2.spice.cloud"
 
   spicepod = jsonencode({
     version = "v1beta1"
@@ -54,4 +57,14 @@ resource "spiceai_app" "json_config" {
   })
 
   replicas = 1
+}
+
+# App using regions data source to get cname
+data "spiceai_regions" "available" {}
+
+resource "spiceai_app" "with_region_lookup" {
+  name        = "my-dynamic-region-app"
+  description = "An app using dynamic region lookup"
+  visibility  = "private"
+  cname       = data.spiceai_regions.available.regions[0].cname
 }

examples/resources/spiceai_app/resource.tf

@@ -158,7 +158,7 @@ type App struct {
 	Description      string            `json:"description,omitempty"`
 	Visibility       string            `json:"visibility,omitempty"`
 	CreatedAt        string            `json:"created_at,omitempty"`
-	Region           string            `json:"region,omitempty"`
+	Cname            string            `json:"cname,omitempty"`
 	ClusterID        string            `json:"cluster_id,omitempty"`
 	ProductionBranch string            `json:"production_branch,omitempty"`
 	APIKey           string            `json:"api_key,omitempty"`
@@ -182,6 +182,7 @@ type AppConfig struct {
 // CreateAppRequest represents the request to create an app.
 type CreateAppRequest struct {
 	Name        string            `json:"name"`
+	Cname       string            `json:"cname"`
 	Description string            `json:"description,omitempty"`
 	Visibility  string            `json:"visibility,omitempty"`
 	Tags        map[string]string `json:"tags,omitempty"`

internal/client/client.go

@@ -41,6 +41,7 @@ type AppDataSourceModel struct {
 	Visibility       types.String `tfsdk:"visibility"`
 	ProductionBranch types.String `tfsdk:"production_branch"`
 	Tags             types.Map    `tfsdk:"tags"`
+	Cname            types.String `tfsdk:"cname"`
 
 	// Spicepod configuration
 	Spicepod types.String `tfsdk:"spicepod"`
@@ -98,6 +99,10 @@ func (d *AppDataSource) Schema(ctx context.Context, req datasource.SchemaRequest
 				Computed:            true,
 				ElementType:         types.StringType,
 			},
+			"cname": schema.StringAttribute{
+				MarkdownDescription: "The region identifier (cname) for the app.",
+				Computed:            true,
+			},
 
 			// Spicepod configuration
 			"spicepod": schema.StringAttribute{
@@ -233,10 +238,15 @@ func (d *AppDataSource) mapAppToModel(data *AppDataSourceModel, app *client.App)
 	data.ClusterID = types.StringValue(app.ClusterID)
 	data.APIKey = types.StringValue(app.APIKey)
 
-	// Region can be at top level or inside config
-	if app.Region != "" {
-		data.Region = types.StringValue(app.Region)
-	} else if app.Config != nil && app.Config.Region != "" {
+	// Map cname
+	if app.Cname != "" {
+		data.Cname = types.StringValue(app.Cname)
+	} else {
+		data.Cname = types.StringNull()
+	}
+
+	// Region is inside config
+	if app.Config != nil && app.Config.Region != "" {
 		data.Region = types.StringValue(app.Config.Region)
 	} else {
 		data.Region = types.StringNull()