Skip to content

Modern Docker Management, Designed for Everyone

fix: swarm stack unable to be edited

Kyle Mendellb2c4e27b62d1
diff --git a/backend/internal/huma/handlers/swarm.go b/backend/internal/huma/handlers/swarm.go
index 38e997b67..ab26389b0 100644
--- a/backend/internal/huma/handlers/swarm.go
+++ b/backend/internal/huma/handlers/swarm.go
@@ -267,6 +267,16 @@ type GetSwarmStackSourceOutput struct {
Body base.ApiResponse[swarmtypes.StackSource]
}
+type UpdateSwarmStackSourceInput struct {
+ EnvironmentID string `path:"id" doc:"Environment ID"`
+ Name string `path:"name" doc:"Stack name"`
+ Body swarmtypes.StackSourceUpdateRequest
+}
+
+type UpdateSwarmStackSourceOutput struct {
+ Body base.ApiResponse[swarmtypes.StackSource]
+}
+
type DeleteSwarmStackInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
Name string `path:"name" doc:"Stack name"`
@@ -533,6 +543,7 @@ func RegisterSwarm(api huma.API, swarmSvc *services.SwarmService, environmentSvc
huma.Register(api, huma.Operation{OperationID: "deploy-swarm-stack", Method: http.MethodPost, Path: "/environments/{id}/swarm/stacks", Summary: "Deploy swarm stack", Tags: []string{"Swarm"}, Security: []map[string][]string{{"BearerAuth": {}}, {"ApiKeyAuth": {}}}}, h.DeployStack)
huma.Register(api, huma.Operation{OperationID: "get-swarm-stack", Method: http.MethodGet, Path: "/environments/{id}/swarm/stacks/{name}", Summary: "Get swarm stack", Tags: []string{"Swarm"}, Security: []map[string][]string{{"BearerAuth": {}}, {"ApiKeyAuth": {}}}}, h.GetStack)
huma.Register(api, huma.Operation{OperationID: "get-swarm-stack-source", Method: http.MethodGet, Path: "/environments/{id}/swarm/stacks/{name}/source", Summary: "Get swarm stack source", Tags: []string{"Swarm"}, Security: []map[string][]string{{"BearerAuth": {}}, {"ApiKeyAuth": {}}}}, h.GetStackSource)
+ huma.Register(api, huma.Operation{OperationID: "update-swarm-stack-source", Method: http.MethodPut, Path: "/environments/{id}/swarm/stacks/{name}/source", Summary: "Update swarm stack source", Tags: []string{"Swarm"}, Security: []map[string][]string{{"BearerAuth": {}}, {"ApiKeyAuth": {}}}}, h.UpdateStackSource)
huma.Register(api, huma.Operation{OperationID: "delete-swarm-stack", Method: http.MethodDelete, Path: "/environments/{id}/swarm/stacks/{name}", Summary: "Delete swarm stack", Tags: []string{"Swarm"}, Security: []map[string][]string{{"BearerAuth": {}}, {"ApiKeyAuth": {}}}}, h.DeleteStack)
huma.Register(api, huma.Operation{OperationID: "list-swarm-stack-services", Method: http.MethodGet, Path: "/environments/{id}/swarm/stacks/{name}/services", Summary: "List swarm stack services", Tags: []string{"Swarm"}, Security: []map[string][]string{{"BearerAuth": {}}, {"ApiKeyAuth": {}}}}, h.ListStackServices)
huma.Register(api, huma.Operation{OperationID: "list-swarm-stack-tasks", Method: http.MethodGet, Path: "/environments/{id}/swarm/stacks/{name}/tasks", Summary: "List swarm stack tasks", Tags: []string{"Swarm"}, Security: []map[string][]string{{"BearerAuth": {}}, {"ApiKeyAuth": {}}}}, h.ListStackTasks)
@@ -1230,6 +1241,29 @@ func (h *SwarmHandler) GetStackSource(ctx context.Context, input *GetSwarmStackS
return &GetSwarmStackSourceOutput{Body: base.ApiResponse[swarmtypes.StackSource]{Success: true, Data: *source}}, nil
}
+// UpdateStackSource persists the saved compose and env source for a swarm stack.
+//
+// It requires admin privileges because stack source content can include
+// sensitive configuration. The stack name comes from the route, and the body
+// contains the replacement source files to save.
+func (h *SwarmHandler) UpdateStackSource(ctx context.Context, input *UpdateSwarmStackSourceInput) (*UpdateSwarmStackSourceOutput, error) {
+ if h.swarmService == nil {
+ return nil, huma.Error500InternalServerError("service not available")
+ }
+ if err := checkAdmin(ctx); err != nil {
+ return nil, err
+ }
+
+ source, err := h.swarmService.UpdateStackSource(ctx, input.EnvironmentID, input.Name, input.Body)
+ if err != nil {
+ return nil, mapSwarmServiceError(err, "Failed to update swarm stack source")
+ }
+
+ h.auditSwarmMutation(ctx, input.EnvironmentID, "stack.source.update", "swarm_stack", input.Name, input.Name, map[string]any{"stack": input.Name})
+
+ return &UpdateSwarmStackSourceOutput{Body: base.ApiResponse[swarmtypes.StackSource]{Success: true, Data: *source}}, nil
+}
+
// DeleteStack removes a swarm stack and its managed resources.
//
// It requires admin privileges, delegates the removal to the swarm service,
diff --git a/backend/internal/services/swarm_service.go b/backend/internal/services/swarm_service.go
index 74c6aedb3..c251ba39e 100644
--- a/backend/internal/services/swarm_service.go
+++ b/backend/internal/services/swarm_service.go
@@ -1290,10 +1290,6 @@ func (s *SwarmService) GetStack(ctx context.Context, environmentID, stackName st
}
func (s *SwarmService) GetStackSource(ctx context.Context, environmentID, stackName string) (*swarmtypes.StackSource, error) {
- if err := s.ensureSwarmManagerInternal(ctx); err != nil {
- return nil, err
- }
-
stackName = strings.TrimSpace(stackName)
if stackName == "" {
return nil, errors.New("stack name is required")
@@ -1327,6 +1323,26 @@ func (s *SwarmService) GetStackSource(ctx context.Context, environmentID, stackN
}, nil
}
+func (s *SwarmService) UpdateStackSource(ctx context.Context, environmentID, stackName string, req swarmtypes.StackSourceUpdateRequest) (*swarmtypes.StackSource, error) {
+ stackName = strings.TrimSpace(stackName)
+ if stackName == "" {
+ return nil, errors.New("stack name is required")
+ }
+ if strings.TrimSpace(req.ComposeContent) == "" {
+ return nil, errors.New("stack compose source is required")
+ }
+
+ if err := s.upsertStackSourceInternal(ctx, environmentID, stackName, req.ComposeContent, req.EnvContent); err != nil {
+ return nil, err
+ }
+
+ return &swarmtypes.StackSource{
+ Name: stackName,
+ ComposeContent: req.ComposeContent,
+ EnvContent: req.EnvContent,
+ }, nil
+}
+
func (s *SwarmService) listPersistedStackSourcesInternal(ctx context.Context, environmentID string) (map[string]swarmtypes.StackSummary, error) {
_, environmentDir, err := s.resolveSwarmStackSourceEnvironmentDirInternal(ctx, environmentID)
if err != nil {
diff --git a/backend/internal/services/swarm_service_test.go b/backend/internal/services/swarm_service_test.go
index 74fd5f5c5..1f52a208d 100644
--- a/backend/internal/services/swarm_service_test.go
+++ b/backend/internal/services/swarm_service_test.go
@@ -5,9 +5,11 @@ import (
"encoding/json"
"net/http"
"net/http/httptest"
+ "path/filepath"
"testing"
"github.com/getarcaneapp/arcane/backend/internal/models"
+ swarmtypes "github.com/getarcaneapp/arcane/types/swarm"
"github.com/stretchr/testify/require"
)
@@ -69,3 +71,32 @@ func TestSwarmService_FetchSwarmNodeIdentityViaEdgeInternal_UsesEnvironmentAcces
require.Equal(t, "29.3.1", identity.EngineVersion)
require.True(t, identity.SwarmActive)
}
+
+func TestSwarmService_UpdateAndGetStackSource_UsesStoredFilesWithoutSwarmManager(t *testing.T) {
+ ctx := context.Background()
+ db := setupSettingsTestDB(t)
+ settingsSvc, err := NewSettingsService(ctx, db)
+ require.NoError(t, err)
+
+ rootDir := t.TempDir()
+ t.Setenv("SWARM_STACK_SOURCES_DIRECTORY", rootDir)
+
+ svc := NewSwarmService(nil, settingsSvc, nil, nil, nil)
+
+ updated, err := svc.UpdateStackSource(ctx, "0", "demo-stack", swarmtypes.StackSourceUpdateRequest{
+ ComposeContent: "services:\n web:\n image: nginx:alpine\n",
+ EnvContent: "FOO=bar\n",
+ })
+ require.NoError(t, err)
+ require.Equal(t, "demo-stack", updated.Name)
+
+ composePath := filepath.Join(rootDir, "0", "demo-stack", "compose.yaml")
+ envPath := filepath.Join(rootDir, "0", "demo-stack", ".env")
+ require.FileExists(t, composePath)
+ require.FileExists(t, envPath)
+
+ source, err := svc.GetStackSource(ctx, "0", "demo-stack")
+ require.NoError(t, err)
+ require.Equal(t, updated.ComposeContent, source.ComposeContent)
+ require.Equal(t, updated.EnvContent, source.EnvContent)
+}
diff --git a/frontend/src/lib/services/swarm-service.ts b/frontend/src/lib/services/swarm-service.ts
index cc2734336..c5c49ad8c 100644
--- a/frontend/src/lib/services/swarm-service.ts
+++ b/frontend/src/lib/services/swarm-service.ts
@@ -23,6 +23,7 @@ import type {
SwarmStackRenderConfigRequest,
SwarmStackRenderConfigResponse,
SwarmStackSource,
+ SwarmStackSourceUpdateRequest,
SwarmInitRequest,
SwarmInitResponse,
SwarmJoinRequest,
@@ -163,6 +164,11 @@ export class SwarmService extends BaseAPIService {
return this.handleResponse(this.api.get(`/environments/${envId}/swarm/stacks/${name}/source`));
}
+ async updateStackSource(name: string, request: SwarmStackSourceUpdateRequest): Promise<SwarmStackSource> {
+ const envId = await environmentStore.getCurrentEnvironmentId();
+ return this.handleResponse(this.api.put(`/environments/${envId}/swarm/stacks/${name}/source`, request));
+ }
+
async removeStack(name: string): Promise<void> {
const envId = await environmentStore.getCurrentEnvironmentId();
await this.handleResponse(this.api.delete(`/environments/${envId}/swarm/stacks/${name}`));
diff --git a/frontend/src/lib/types/swarm.type.ts b/frontend/src/lib/types/swarm.type.ts
index b9a6197a8..ad79da403 100644
--- a/frontend/src/lib/types/swarm.type.ts
+++ b/frontend/src/lib/types/swarm.type.ts
@@ -320,6 +320,11 @@ export interface SwarmStackSource {
envContent?: string;
}
+export interface SwarmStackSourceUpdateRequest {
+ composeContent: string;
+ envContent?: string;
+}
+
export interface SwarmInfo {
id: string;
createdAt: string;
diff --git a/frontend/src/routes/(app)/swarm/stacks/[name]/+page.svelte b/frontend/src/routes/(app)/swarm/stacks/[name]/+page.svelte
index 4dfebdffa..c33faedc7 100644
--- a/frontend/src/routes/(app)/swarm/stacks/[name]/+page.svelte
+++ b/frontend/src/routes/(app)/swarm/stacks/[name]/+page.svelte
@@ -230,7 +230,7 @@
<Card.Root class="flex min-h-0 min-w-0 flex-col overflow-hidden">
<Card.Header icon={CodeIcon} class="flex-shrink-0">
<Card.Title>
- <h2>{m.common_docker_compose()}</h2>
+ <h2>compose.yaml</h2>
</Card.Title>
</Card.Header>
<Card.Content class="relative z-0 flex min-h-0 flex-1 flex-col overflow-visible p-0">
@@ -249,7 +249,7 @@
<Card.Root class="flex min-h-0 min-w-0 flex-col overflow-hidden">
<Card.Header icon={FileTextIcon} class="flex-shrink-0">
<Card.Title>
- <h2>{m.environment_file()}</h2>
+ <h2>.env</h2>
</Card.Title>
</Card.Header>
<Card.Content class="relative z-0 flex min-h-0 flex-1 flex-col overflow-visible p-0">
diff --git a/frontend/src/routes/(app)/swarm/stacks/new/+page.svelte b/frontend/src/routes/(app)/swarm/stacks/new/+page.svelte
index 6c2db07e3..b00456f06 100644
--- a/frontend/src/routes/(app)/swarm/stacks/new/+page.svelte
+++ b/frontend/src/routes/(app)/swarm/stacks/new/+page.svelte
@@ -32,6 +32,7 @@
let showTemplateDialog = $state(false);
let showConverterDialog = $state(false);
let isLoadingTemplateContent = $state(false);
+ const isEditMode = $derived(data.isEditMode === true);
const formSchema = z.object({
name: z
@@ -49,6 +50,9 @@
? data.selectedTemplate.name.toLowerCase().replace(/[^a-z0-9-_]/g, '-')
: ''
);
+ const backHref = $derived(isEditMode ? `/swarm/stacks/${encodeURIComponent(initialName)}` : '/swarm/stacks');
+ const submitLabel = $derived(isEditMode ? m.common_save() : m.common_create_button({ resource: m.swarm_stack() }));
+ const submitLoadingLabel = $derived(isEditMode ? m.common_saving() : m.common_action_creating());
let formData = $derived({
name: initialName,
@@ -68,6 +72,10 @@
);
async function handleSubmit() {
+ if (isEditMode) {
+ await handleSaveStackSource();
+ return;
+ }
await handleDeployStack();
}
@@ -88,6 +96,23 @@
});
}
+ async function handleSaveStackSource() {
+ const validated = form.validate();
+ if (!validated) return;
+
+ const { name, composeContent, envContent } = validated;
+
+ handleApiResultWithCallbacks({
+ result: await tryCatch(swarmService.updateStackSource(name, { composeContent, envContent })),
+ message: m.common_update_failed({ resource: `${m.swarm_stack()} "${name}"` }),
+ setLoadingState: (value) => (saving = value),
+ onSuccess: async () => {
+ toast.success(m.common_update_success({ resource: `${m.swarm_stack()} "${name}"` }));
+ goto(`/swarm/stacks/${encodeURIComponent(name)}`, { invalidateAll: true });
+ }
+ });
+ }
+
async function handleConvertDockerRun() {
if (!dockerRunCommand.trim()) {
toast.error(m.compose_enter_docker_run_command());
@@ -179,7 +204,7 @@
action="base"
tone="ghost"
size="sm"
- href="/swarm/stacks"
+ href={backHref}
class="gap-2 bg-transparent"
icon={ArrowLeftIcon}
customLabel={m.common_back()}
@@ -191,9 +216,9 @@
bind:ref={nameInputRef}
variant="inline"
error={$inputs.name.error ?? undefined}
- originalValue=""
+ originalValue={initialName}
placeholder={m.compose_project_name_placeholder?.() || 'Enter name...'}
- canEdit={!saving && !isLoadingTemplateContent}
+ canEdit={!isEditMode && !saving && !isLoadingTemplateContent}
class="hidden sm:block"
/>
</div>
@@ -213,8 +238,8 @@
onclick={() => handleSubmit()}
class={`${templateBtnClass} gap-2 rounded-r-none`}
loading={saving}
- customLabel={m.common_create_button({ resource: m.swarm_stack() })}
- loadingLabel={m.common_action_creating()}
+ customLabel={submitLabel}
+ loadingLabel={submitLoadingLabel}
/>
</span>
</ArcaneTooltip.Trigger>
@@ -285,9 +310,9 @@
bind:ref={nameInputRef}
variant="block"
error={$inputs.name.error ?? undefined}
- originalValue=""
+ originalValue={initialName}
placeholder={m.compose_project_name_placeholder()}
- canEdit={!saving && !isLoadingTemplateContent}
+ canEdit={!isEditMode && !saving && !isLoadingTemplateContent}
/>
</div>
@@ -298,11 +323,11 @@
<div class="flex min-h-0 flex-1 flex-col lg:col-span-3">
<CodePanel
bind:open={composeOpen}
- title={m.compose_compose_file_title()}
+ title="compose.yaml"
language="yaml"
bind:value={$inputs.composeContent.value}
error={$inputs.composeContent.error ?? undefined}
- fileId="swarm:stacks:new:compose"
+ fileId={isEditMode ? `swarm:stacks:${initialName}:compose` : 'swarm:stacks:new:compose'}
editorContext={{
envContent: $inputs.envContent.value,
composeContents: [$inputs.composeContent.value],
@@ -314,11 +339,11 @@
<div class="flex min-h-0 flex-1 flex-col lg:col-span-2">
<CodePanel
bind:open={envOpen}
- title={m.compose_env_title()}
+ title=".env"
language="env"
bind:value={$inputs.envContent.value}
error={$inputs.envContent.error ?? undefined}
- fileId="swarm:stacks:new:env"
+ fileId={isEditMode ? `swarm:stacks:${initialName}:env` : 'swarm:stacks:new:env'}
editorContext={{
envContent: $inputs.envContent.value,
composeContents: [$inputs.composeContent.value],
diff --git a/frontend/src/routes/(app)/swarm/stacks/new/+page.ts b/frontend/src/routes/(app)/swarm/stacks/new/+page.ts
index 7f72a00c8..9b786a74d 100644
--- a/frontend/src/routes/(app)/swarm/stacks/new/+page.ts
+++ b/frontend/src/routes/(app)/swarm/stacks/new/+page.ts
@@ -1,3 +1,4 @@
+import { error } from '@sveltejs/kit';
import { templateService } from '$lib/services/template-service';
import { swarmService } from '$lib/services/swarm-service';
import type { PageLoad } from './$types';
@@ -6,6 +7,17 @@ export const load: PageLoad = async ({ url }) => {
const templateId = url.searchParams.get('templateId');
const fromStack = url.searchParams.get('fromStack');
const sourceStackName = fromStack ? decodeURIComponent(fromStack) : null;
+ const isEditMode = sourceStackName !== null;
+
+ const sourceStackPromise = sourceStackName
+ ? swarmService.getStackSource(sourceStackName).catch((err: any) => {
+ console.warn('Failed to load source stack content:', err);
+ if (err?.status === 404) {
+ throw error(404, 'Saved source not found');
+ }
+ throw error(err?.status || 500, err?.message || 'Failed to load saved stack source');
+ })
+ : Promise.resolve(null);
const [allTemplates, defaultTemplates, selectedTemplate, sourceStack, globalVariables] = await Promise.all([
templateService.getAllTemplates().catch((err) => {
@@ -22,12 +34,7 @@ export const load: PageLoad = async ({ url }) => {
return null;
})
: Promise.resolve(null),
- sourceStackName
- ? swarmService.getStackSource(sourceStackName).catch((err) => {
- console.warn('Failed to load source stack content:', err);
- return null;
- })
- : Promise.resolve(null),
+ sourceStackPromise,
templateService.getGlobalVariables().catch((err) => {
console.warn('Failed to load global variables:', err);
return [];
@@ -36,8 +43,13 @@ export const load: PageLoad = async ({ url }) => {
return {
composeTemplates: allTemplates,
- envTemplate: selectedTemplate?.envContent ?? sourceStack?.envContent ?? defaultTemplates.swarmStackEnvTemplate,
- defaultTemplate: selectedTemplate?.content ?? sourceStack?.composeContent ?? defaultTemplates.swarmStackTemplate,
+ envTemplate: isEditMode
+ ? (sourceStack?.envContent ?? '')
+ : (selectedTemplate?.envContent ?? defaultTemplates.swarmStackEnvTemplate),
+ defaultTemplate: isEditMode
+ ? (sourceStack?.composeContent ?? '')
+ : (selectedTemplate?.content ?? defaultTemplates.swarmStackTemplate),
+ isEditMode,
selectedTemplate: selectedTemplate?.template || null,
sourceStackName: sourceStack?.name || sourceStackName || null,
globalVariables
diff --git a/types/swarm/stack.go b/types/swarm/stack.go
index 895bddffa..d92d8abb8 100644
--- a/types/swarm/stack.go
+++ b/types/swarm/stack.go
@@ -136,3 +136,15 @@ type StackSource struct {
// Required: false
EnvContent string `json:"envContent,omitempty"`
}
+
+type StackSourceUpdateRequest struct {
+ // ComposeContent is the Docker Compose YAML content to persist for the stack.
+ //
+ // Required: true
+ ComposeContent string `json:"composeContent"`
+
+ // EnvContent is the optional environment file content to persist for the stack.
+ //
+ // Required: false
+ EnvContent string `json:"envContent,omitempty"`
+}