Files
formae-plugin-proxmox/proxmox.go
ManInDark 0fa3f22f25
Some checks failed
CI / build (push) Failing after 4m34s
CI / lint (push) Failing after 2m57s
CI / pkl-validate (push) Successful in 1m16s
CI / integration-tests (push) Has been skipped
CI / conformance-tests (latest) (push) Has been skipped
fix: ostemplate update recreate
2026-01-31 21:58:31 +01:00

482 lines
14 KiB
Go

// © 2025 Platform Engineering Labs Inc.
//
// SPDX-License-Identifier: Apache-2.0
package main
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"log"
"net/http"
"strconv"
"github.com/platform-engineering-labs/formae/pkg/plugin"
"github.com/platform-engineering-labs/formae/pkg/plugin/resource"
)
// https://pve.proxmox.com/pve-docs/api-viewer/
// ErrNotImplemented is returned by stub methods that need implementation.
var ErrNotImplemented = errors.New("not implemented")
// Plugin implements the Formae ResourcePlugin interface.
// The SDK automatically provides identity methods (Name, Version, Namespace)
// by reading formae-plugin.pkl at startup.
type Plugin struct{}
// Compile-time check: Plugin must satisfy ResourcePlugin interface.
var _ plugin.ResourcePlugin = &Plugin{}
// =============================================================================
// Configuration Methods
// =============================================================================
// RateLimit returns the rate limiting configuration for this plugin.
// Adjust MaxRequestsPerSecondForNamespace based on your provider's API limits.
func (p *Plugin) RateLimit() plugin.RateLimitConfig {
return plugin.RateLimitConfig{
Scope: plugin.RateLimitScopeNamespace,
MaxRequestsPerSecondForNamespace: 10, // TODO: Adjust based on provider limits
}
}
// DiscoveryFilters returns filters to exclude certain resources from discovery.
// Resources matching ALL conditions in a filter are excluded.
// Return nil if you want to discover all resources.
func (p *Plugin) DiscoveryFilters() []plugin.MatchFilter {
// Example: exclude resources with a specific tag
// return []plugin.MatchFilter{
// {
// ResourceTypes: []string{"PROXMOX::Service::Resource"},
// Conditions: []plugin.FilterCondition{
// {PropertyPath: "$.Tags[?(@.Key=='skip-discovery')].Value", PropertyValue: "true"},
// },
// },
// }
return nil
}
// LabelConfig returns the configuration for extracting human-readable labels
// from discovered resources.
func (p *Plugin) LabelConfig() plugin.LabelConfig {
return plugin.LabelConfig{
// Default JSONPath query to extract label from resources
// Example for tagged resources: $.Tags[?(@.Key=='Name')].Value
DefaultQuery: "$.hostname",
// Override for specific resource types
ResourceOverrides: map[string]string{
// "PROXMOX::Service::SpecialResource": "$.DisplayName",
},
}
}
// =============================================================================
// CRUD Operations
// =============================================================================
// Create provisions a new resource.
func (p *Plugin) Create(ctx context.Context, req *resource.CreateRequest) (*resource.CreateResult, error) {
props, err := parseLXCProperties(req.Properties)
if err != nil {
log.Println(err.Error())
return &resource.CreateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInvalidRequest,
StatusMessage: err.Error(),
},
}, err
}
config, err := parseTargetConfig(req.TargetConfig)
if err != nil {
log.Println(err.Error())
return &resource.CreateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
username, token, err := getCredentials()
if err != nil {
log.Println(err.Error())
return &resource.CreateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
client := &http.Client{}
arguments := "vmid=" + props.VMID + "&ostemplate=" + props.OSTemplate + "&hostname=" + props.Hostname
if props.Description != "" {
arguments += "&description=" + props.Description
}
request, err := http.NewRequest("POST", config.URL+"/api2/json/nodes/"+config.NODE+"/lxc", bytes.NewBuffer([]byte(arguments)))
request.Header.Set("Authorization", "PVEAPIToken="+username+"="+token)
resp, err := client.Do(request)
if err != nil {
return &resource.CreateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return &resource.CreateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
log.Println("Response StatusCode: ", resp.Status)
log.Println("Response Body: ", string(body))
return &resource.CreateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusSuccess,
NativeID: props.VMID,
},
}, nil
}
func (p *Plugin) Read(ctx context.Context, req *resource.ReadRequest) (*resource.ReadResult, error) {
username, token, err := getCredentials()
if err != nil {
return &resource.ReadResult{
ErrorCode: resource.OperationErrorCodeInvalidRequest,
}, err
}
config, err := parseTargetConfig(req.TargetConfig)
if err != nil {
return &resource.ReadResult{}, nil
}
client := &http.Client{}
request, err := http.NewRequest("GET", config.URL+"/api2/json/nodes/"+config.NODE+"/lxc/"+req.NativeID+"/config", nil)
if err != nil {
return &resource.ReadResult{
ErrorCode: resource.OperationErrorCodeNetworkFailure,
}, err
}
request.Header.Set("Authorization", "PVEAPIToken="+username+"="+token)
resp, err := client.Do(request)
data, err := io.ReadAll(resp.Body)
var props StatusLXCConfigResponse
err = json.Unmarshal(data, &props)
if err != nil {
return &resource.ReadResult{
ErrorCode: resource.OperationErrorCodeInvalidRequest,
}, err
}
lxcdata := props.Data
properties := LXCProperties{
VMID: req.NativeID,
Hostname: lxcdata.Hostname,
Description: lxcdata.Description,
}
propsJSON, err := json.Marshal(properties)
if err != nil {
return &resource.ReadResult{
ErrorCode: resource.OperationErrorCodeInternalFailure,
}, err
}
return &resource.ReadResult{
ResourceType: req.ResourceType,
Properties: string(propsJSON),
}, nil
}
// Update modifies an existing resource.
func (p *Plugin) Update(ctx context.Context, req *resource.UpdateRequest) (*resource.UpdateResult, error) {
prior, err := parseLXCProperties(req.PriorProperties)
if err != nil {
return &resource.UpdateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationUpdate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInvalidRequest,
StatusMessage: err.Error(),
},
}, err
}
desir, err := parseLXCProperties(req.DesiredProperties)
if err != nil {
return &resource.UpdateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationUpdate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInvalidRequest,
StatusMessage: err.Error(),
},
}, err
}
if prior == nil {
p.Create(ctx, &resource.CreateRequest{
ResourceType: req.ResourceType,
Properties: req.DesiredProperties,
TargetConfig: req.TargetConfig,
})
}
if prior.VMID != desir.VMID {
return &resource.UpdateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationUpdate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInvalidRequest,
StatusMessage: "can't change vmid",
},
}, fmt.Errorf("can't change vmid")
}
if prior.Hostname != desir.Hostname || prior.Description != desir.Description {
config, err := parseTargetConfig(req.TargetConfig)
if err != nil {
log.Println(err.Error())
return &resource.UpdateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
username, token, err := getCredentials()
if err != nil {
return &resource.UpdateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationUpdate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeAccessDenied,
StatusMessage: err.Error(),
},
}, err
}
client := &http.Client{}
url := config.URL + "/api2/json/nodes/" + config.NODE + "/lxc/" + desir.VMID + "/config"
arguments := "vmid=" + desir.VMID + "&hostname=" + desir.Hostname + "&description=" + desir.Description
argumentBuffer := bytes.NewBuffer([]byte(arguments))
request, err := http.NewRequest("PUT", url, argumentBuffer)
request.Header.Set("Authorization", "PVEAPIToken="+username+"="+token)
resp, err := client.Do(request)
if err != nil {
return &resource.UpdateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
log.Println("Response StatusCode: ", resp.Status)
}
result, err := p.Read(ctx, &resource.ReadRequest{
NativeID: req.NativeID,
ResourceType: req.ResourceType,
TargetConfig: req.TargetConfig,
})
return &resource.UpdateResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationUpdate,
OperationStatus: resource.OperationStatusSuccess,
NativeID: req.NativeID,
ResourceProperties: json.RawMessage(result.Properties),
},
}, nil
}
// Delete removes a resource.
func (p *Plugin) Delete(ctx context.Context, req *resource.DeleteRequest) (*resource.DeleteResult, error) {
config, err := parseTargetConfig(req.TargetConfig)
if err != nil {
log.Println(err.Error())
return &resource.DeleteResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
username, token, err := getCredentials()
if err != nil {
log.Println(err.Error())
return &resource.DeleteResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
client := &http.Client{}
url := config.URL + "/api2/json/nodes/" + config.NODE + "/lxc/" + req.NativeID
request, err := http.NewRequest("DELETE", url, nil)
request.Header.Set("Authorization", "PVEAPIToken="+username+"="+token)
resp, err := client.Do(request)
if err != nil {
return &resource.DeleteResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return &resource.DeleteResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: err.Error(),
},
}, err
}
log.Println("Response StatusCode: ", resp.Status)
log.Println("Response Body: ", string(body))
return &resource.DeleteResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCreate,
OperationStatus: resource.OperationStatusSuccess,
NativeID: req.NativeID,
},
}, nil
}
// Status checks the progress of an async operation.
// Called when Create/Update/Delete return InProgress status.
func (p *Plugin) Status(ctx context.Context, req *resource.StatusRequest) (*resource.StatusResult, error) {
// TODO: Implement status checking for async operations
//
// 1. Use req.RequestID to identify the operation
// 2. Call your provider's API to check operation status
// 3. Return ProgressResult with current status
//
// If your provider's operations are synchronous, return Success immediately.
return &resource.StatusResult{
ProgressResult: &resource.ProgressResult{
Operation: resource.OperationCheckStatus,
OperationStatus: resource.OperationStatusFailure,
ErrorCode: resource.OperationErrorCodeInternalFailure,
StatusMessage: "Status not implemented",
},
}, ErrNotImplemented
}
// List returns all resource identifiers of a given type.
// Called during discovery to find unmanaged resources.
func (p *Plugin) List(ctx context.Context, req *resource.ListRequest) (*resource.ListResult, error) {
username, token, err := getCredentials()
if err != nil {
return &resource.ListResult{
NativeIDs: []string{},
}, err
}
config, err := parseTargetConfig(req.TargetConfig)
if err != nil {
return &resource.ListResult{
NativeIDs: []string{},
}, err
}
client := &http.Client{}
var props StatusGeneralResponse
request, err := http.NewRequest("GET", config.URL+"/api2/json/nodes/"+config.NODE+"/lxc", nil)
if err != nil {
return &resource.ListResult{
NativeIDs: []string{},
}, err
}
request.Header.Set("Authorization", "PVEAPIToken="+username+"="+token)
resp, err := client.Do(request)
data, err := io.ReadAll(resp.Body)
json.Unmarshal(data, &props)
nativeIds := make([]string, 0, len(props.Data))
for _, value := range props.Data {
nativeIds = append(nativeIds, strconv.Itoa(value.VMID))
}
return &resource.ListResult{
NativeIDs: nativeIds,
NextPageToken: nil,
}, nil
}