feat(opentofu-agent): add OpenTofu Agent support

.github/workflows/build-agent.yaml

@@ -34,6 +34,7 @@ jobs:
         agent:
           - docker-agent
           - kubernetes-agent
+          - opentofu-agent
         platform:
           - arch: linux/amd64
             runner: ubuntu-latest
@@ -108,6 +109,7 @@ jobs:
         agent:
           - docker-agent
           - kubernetes-agent
+          - opentofu-agent
     env:
       REGISTRY_IMAGE: ghcr.io/distr-sh/distr/${{ matrix.agent }}
     steps:

.github/workflows/test-agent.yaml

@@ -26,6 +26,7 @@ jobs:
         agent:
           - docker
           - kubernetes
+          - opentofu
     permissions:
       contents: read
     steps:

.gitignore

@@ -6,6 +6,7 @@
 /out-tsc
 /bazel-out
 hub
+opentofu
 
 # Node
 /node_modules

Dockerfile.opentofu-agent

@@ -0,0 +1,32 @@
+FROM golang:1.26 AS builder
+ARG TARGETOS
+ARG TARGETARCH
+ARG VERSION
+ARG COMMIT
+
+WORKDIR /workspace
+COPY go.mod go.mod
+COPY go.sum go.sum
+RUN go mod download
+
+COPY api/ api/
+COPY cmd/agent/opentofu/ cmd/agent/opentofu/
+# doesn't exist (yet?)
+# COPY pkg/ pkg/
+COPY internal/ internal/
+RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} \
+  go build -a -o agent \
+  -ldflags="-s -w -X github.com/distr-sh/distr/internal/buildconfig.version=${VERSION:-snapshot} -X github.com/distr-sh/distr/internal/buildconfig.commit=${COMMIT}" \
+  ./cmd/agent/opentofu/
+
+FROM alpine:3.21
+COPY --from=ghcr.io/opentofu/opentofu:1.9 /usr/local/bin/tofu /usr/local/bin/tofu
+WORKDIR /
+COPY --from=builder /workspace/agent .
+RUN addgroup -S agent && adduser -S agent -G agent && \
+    mkdir -p /scratch && chown agent:agent /scratch
+USER agent
+ENV TF_IN_AUTOMATION=1
+ENV TF_INPUT=0
+ENV TF_PLUGIN_CACHE_DIR=/scratch/plugin-cache
+ENTRYPOINT ["/agent"]

api/agent.go

@@ -47,6 +47,13 @@ type AgentDeployment struct {
 	Values             map[string]any `json:"values"`
 	IgnoreRevisionSkew bool           `json:"ignoreRevisionSkew"`
 	HelmOptions        *HelmOptions   `json:"helmOptions,omitempty"`
+
+	// OpenTofu specific data
+
+	TofuConfigURL     string            `json:"tofuConfigUrl,omitempty"`
+	TofuConfigVersion string            `json:"tofuConfigVersion,omitempty"`
+	TofuVars          map[string]any    `json:"tofuVars,omitempty"`
+	TofuBackendConfig map[string]string `json:"tofuBackendConfig,omitempty"`
 }
 
 type AgentDeploymentStatus struct {

api/deployment_target.go

@@ -24,6 +24,8 @@ type DeploymentRequest struct {
 	ForceRestart             bool              `json:"forceRestart"`
 	IgnoreRevisionSkew       bool              `json:"ignoreRevisionSkew"`
 	HelmOptions              *HelmOptions      `json:"helmOptions,omitempty"`
+	TofuVars                 map[string]any    `json:"tofuVars,omitempty"`
+	TofuBackendConfig        map[string]string `json:"tofuBackendConfig,omitempty"`
 }
 
 func (d *DeploymentRequest) GetValuesYAML() []byte {

api/organization.go

@@ -15,6 +15,7 @@ type CreateUpdateOrganizationRequest struct {
 	ConnectScriptIsSudo    bool    `json:"connectScriptIsSudo"`
 	ArtifactVersionMutable bool    `json:"artifactVersionMutable"`
 	PrePostScriptsEnabled  bool    `json:"prePostScriptsEnabled"`
+	OpenTofuEnabled        bool    `json:"openTofuEnabled"`
 }
 
 type OrganizationResponse struct {

cmd/agent/opentofu/agent_deployment.go

@@ -0,0 +1,117 @@
+package main
+
+import (
+	"encoding/json"
+	"errors"
+	"os"
+	"path/filepath"
+	"sync"
+
+	"github.com/distr-sh/distr/api"
+	"github.com/google/uuid"
+)
+
+type State string
+
+const (
+	StateUnspecified State = ""
+	StateInstalling  State = "installing"
+	StateInstalled   State = "installed"
+	StateFailed      State = "failed"
+)
+
+type AgentDeployment struct {
+	ID                uuid.UUID         `json:"id"`
+	RevisionID        uuid.UUID         `json:"revisionId"`
+	TofuConfigURL     string            `json:"tofuConfigUrl"`
+	TofuConfigVersion string            `json:"tofuConfigVersion"`
+	TofuBackendConfig map[string]string `json:"tofuBackendConfig,omitempty"`
+	State             State             `json:"phase"`
+}
+
+func (d AgentDeployment) GetDeploymentID() uuid.UUID {
+	return d.ID
+}
+
+func (d AgentDeployment) GetDeploymentRevisionID() uuid.UUID {
+	return d.RevisionID
+}
+
+func (d *AgentDeployment) FileName() string {
+	return filepath.Join(DeploymentsDir(), d.ID.String())
+}
+
+func NewAgentDeployment(deployment api.AgentDeployment) *AgentDeployment {
+	return &AgentDeployment{
+		ID:                deployment.ID,
+		RevisionID:        deployment.RevisionID,
+		TofuConfigURL:     deployment.TofuConfigURL,
+		TofuConfigVersion: deployment.TofuConfigVersion,
+		TofuBackendConfig: deployment.TofuBackendConfig,
+	}
+}
+
+var agentDeploymentMutex = sync.RWMutex{}
+
+func GetExistingDeployments() (map[uuid.UUID]AgentDeployment, error) {
+	agentDeploymentMutex.RLock()
+	defer agentDeploymentMutex.RUnlock()
+
+	if entries, err := os.ReadDir(DeploymentsDir()); err != nil {
+		if errors.Is(err, os.ErrNotExist) {
+			return nil, nil
+		}
+		return nil, err
+	} else {
+		fn := func(name string) (*AgentDeployment, error) {
+			if file, err := os.Open(filepath.Join(DeploymentsDir(), name)); err != nil {
+				return nil, err
+			} else {
+				defer file.Close()
+				var d AgentDeployment
+				if err := json.NewDecoder(file).Decode(&d); err != nil {
+					return nil, err
+				}
+				return &d, nil
+			}
+		}
+		result := make(map[uuid.UUID]AgentDeployment, len(entries))
+		for _, entry := range entries {
+			if !entry.IsDir() {
+				if d, err := fn(entry.Name()); err != nil {
+					return nil, err
+				} else {
+					result[d.ID] = *d
+				}
+			}
+		}
+		return result, nil
+	}
+}
+
+func SaveDeployment(deployment AgentDeployment) error {
+	agentDeploymentMutex.Lock()
+	defer agentDeploymentMutex.Unlock()
+
+	if err := os.MkdirAll(filepath.Dir(deployment.FileName()), 0o700); err != nil {
+		return err
+	}
+
+	file, err := os.OpenFile(deployment.FileName(), os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o600)
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+
+	if err := json.NewEncoder(file).Encode(deployment); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func DeleteDeployment(deployment AgentDeployment) error {
+	agentDeploymentMutex.Lock()
+	defer agentDeploymentMutex.Unlock()
+	return os.Remove(deployment.FileName())
+}

cmd/agent/opentofu/config.go

@@ -0,0 +1,23 @@
+package main
+
+import (
+	"os"
+	"path/filepath"
+
+	"github.com/google/uuid"
+)
+
+func ScratchDir() string {
+	if dir := os.Getenv("DISTR_AGENT_SCRATCH_DIR"); dir != "" {
+		return dir
+	}
+	return "./scratch"
+}
+
+func WorkspaceDir(deploymentID uuid.UUID) string {
+	return filepath.Join(ScratchDir(), "ws", deploymentID.String())
+}
+
+func DeploymentsDir() string {
+	return filepath.Join(ScratchDir(), "deployments")
+}