Merge pull request #5 from KusionStack/feat/import

feat: support import

Author: elliotxx

docs/data-sources/cluster.md

@@ -3,14 +3,47 @@
 page_title: "karpor_cluster Data Source - karpor"
 subcategory: ""
 description: |-
-  
+  Get cluster information
 ---
 
 # karpor_cluster (Data Source)
 
-
-
-
+Get cluster information
+
+## Example Usage
+
+```terraform
+terraform {
+  required_providers {
+    karpor = {
+      source  = "registry.terraform.io/KusionStack/karpor"
+      version = "0.1.0"
+    }
+  }
+}
+
+provider "karpor" {
+  api_endpoint    = "https://127.0.0.1:7443"
+  api_key         = "your-api-key-here"
+  skip_tls_verify = true
+}
+
+data "karpor_cluster" "example" {
+  cluster_name = "local-cluster"
+}
+
+output "cluster_name" {
+  value = data.karpor_cluster.example.cluster_name
+}
+
+output "display_name" {
+  value = data.karpor_cluster.example.display_name
+}
+
+output "description" {
+  value = data.karpor_cluster.example.description
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/index.md

@@ -3,12 +3,12 @@
 page_title: "karpor Provider"
 subcategory: ""
 description: |-
-  
+  Interact with Karpor
 ---
 
 # karpor Provider
 
-
+Interact with Karpor
 
 ## Example Usage
 

docs/resources/cluster_registration.md

@@ -3,25 +3,73 @@
 page_title: "karpor_cluster_registration Resource - karpor"
 subcategory: ""
 description: |-
-  
+  Manage cluster registration
 ---
 
 # karpor_cluster_registration (Resource)
 
+Manage cluster registration
 
+## Example Usage
 
+```terraform
+terraform {
+  required_providers {
+    karpor = {
+      source  = "registry.terraform.io/KusionStack/karpor"
+      version = "0.1.0"
+    }
+  }
+}
 
+provider "karpor" {
+  api_endpoint    = "https://127.0.0.1:7443"
+  api_key         = "your-api-key-here"
+  skip_tls_verify = true
+}
+
+resource "karpor_cluster_registration" "example" {
+  cluster_name = "local-cluster"
+  display_name = "local-cluster-display-name"
+  credentials  = file("~/config")
+  description  = "local-cluster-description"
+}
+
+
+# make sure you have a existing demo cluster in karpor
+# id is the cluster name
+import {
+  to = karpor_cluster_registration.imported
+  id = "demo"
+}
+
+resource "karpor_cluster_registration" "imported" {
+  cluster_name = "demo"
+  # Setting credentials in imported resource will destroy and then create replacement
+  # credentials  = file("~/config")
+  description  = "demo-description"
+  display_name = "demo-display-name"
+}
+
+output "cluster_name" {
+  value = karpor_cluster_registration.example.cluster_name
+}
+
+output "display_name" {
+  value = karpor_cluster_registration.example.display_name
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
 - `cluster_name` (String) Unique name for the cluster
-- `credentials` (String, Sensitive) Path to kubeconfig file
 
 ### Optional
 
+- `credentials` (String, Sensitive) Path to kubeconfig file
 - `description` (String) Human-readable description
 - `display_name` (String) Human-readable display name
 

examples/data-source/data-source.tf renamed to examples/data-sources/karpor_cluster/data-source.tf

@@ -17,14 +17,29 @@ resource "karpor_cluster_registration" "example" {
   cluster_name = "local-cluster"
   display_name = "local-cluster-display-name"
   credentials  = file("~/config")
-  description  = "Local Kubernetes cluster"
+  description  = "local-cluster-description"
 }
 
 
+# make sure you have a existing demo cluster in karpor
+# id is the cluster name
+import {
+  to = karpor_cluster_registration.imported
+  id = "demo"
+}
+
+resource "karpor_cluster_registration" "imported" {
+  cluster_name = "demo"
+  # Setting credentials in imported resource will destroy and then create replacement
+  # credentials  = file("~/config")
+  description  = "demo-description"
+  display_name = "demo-display-name"
+}
+
 output "cluster_name" {
   value = karpor_cluster_registration.example.cluster_name
 }
 
 output "display_name" {
   value = karpor_cluster_registration.example.display_name
-}
+}

examples/resources/resource.tf renamed to examples/resources/karpor_cluster_registration/resource.tf

@@ -41,6 +41,7 @@ func (d *ClusterDataSource) Metadata(ctx context.Context, req datasource.Metadat
 // Schema returns the schema for the datasource.
 func (d *ClusterDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
 	resp.Schema = schema.Schema{
+		Description: "Get cluster information",
 		Attributes: map[string]schema.Attribute{
 			"cluster_name": schema.StringAttribute{
 				Required: true,

internal/provider/cluster_data_source.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
@@ -15,8 +16,9 @@ import (
 
 // Ensure the implementation satisfies the expected interfaces.
 var (
-	_ resource.Resource              = &ClusterRegistrationResource{}
-	_ resource.ResourceWithConfigure = &ClusterRegistrationResource{}
+	_ resource.Resource                = &ClusterRegistrationResource{}
+	_ resource.ResourceWithConfigure   = &ClusterRegistrationResource{}
+	_ resource.ResourceWithImportState = &ClusterRegistrationResource{}
 )
 
 // NewClusterRegistrationResource returns a new resource.Resource.
@@ -47,6 +49,7 @@ func (r *ClusterRegistrationResource) Metadata(_ context.Context, req resource.M
 // Schema returns the resource schema.
 func (r *ClusterRegistrationResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
+		Description: "Manage cluster registration",
 		Attributes: map[string]schema.Attribute{
 			"cluster_name": schema.StringAttribute{
 				Required:    true,
@@ -60,7 +63,7 @@ func (r *ClusterRegistrationResource) Schema(_ context.Context, _ resource.Schem
 				Description: "Human-readable display name",
 			},
 			"credentials": schema.StringAttribute{
-				Required:    true,
+				Optional:    true,
 				Sensitive:   true,
 				Description: "Path to kubeconfig file",
 				PlanModifiers: []planmodifier.String{
@@ -143,6 +146,7 @@ func (c *ClusterRegistrationResource) Read(ctx context.Context, req resource.Rea
 
 	// Overwrite items with refreshed state
 	state.ClusterName = remoteState.ClusterName
+	state.DisplayName = remoteState.DisplayName
 	state.Description = remoteState.Description
 	state.Id = remoteState.Id
 
@@ -214,6 +218,12 @@ func (c *ClusterRegistrationResource) Delete(ctx context.Context, req resource.D
 	}
 }
 
+// ImportState imports the resource.
+func (c *ClusterRegistrationResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
+	// Terraform will automatically call the resource's Read method to import the rest of the Terraform state
+	resource.ImportStatePassthroughID(ctx, path.Root("cluster_name"), req, resp)
+}
+
 // Configure configures the resource.
 func (c *ClusterRegistrationResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
 	if req.ProviderData == nil {

internal/provider/cluster_registration_resource.go

@@ -43,6 +43,7 @@ func (p *KarporProvider) Metadata(_ context.Context, _ provider.MetadataRequest,
 // Schema returns the provider schema.
 func (p *KarporProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) {
 	resp.Schema = schema.Schema{
+		Description: "Interact with Karpor",
 		Attributes: map[string]schema.Attribute{
 			"api_endpoint": schema.StringAttribute{
 				Optional:    true,