Skip to content

Modern Docker Management, Designed for Everyone

feat(volumes): add unused volume rename (#3704)

Neureka1e413ada2f24
diff --git a/backend/internal/common/errors.go b/backend/internal/common/errors.go
index d5a5e18b4..7d2dc0e72 100644
--- a/backend/internal/common/errors.go
+++ b/backend/internal/common/errors.go
@@ -99,6 +99,8 @@ var (
ErrVolumeWorkspaceForbidden = Classify(ErrForbidden, errors.Sentinel("Forbidden volume workspace path"))
ErrVolumeWorkspaceBadRequest = Classify(ErrBadRequest, errors.Sentinel("Invalid volume workspace request"))
ErrVolumeWorkspaceNotFound = Classify(ErrNotFound, errors.Sentinel("Volume workspace file not found"))
+ ErrVolumeRenameInvalid = Classify(ErrBadRequest, errors.Sentinel("source and target volume names must be non-empty and different"))
+ ErrVolumeRenameProtected = Classify(ErrBadRequest, errors.Sentinel("Arcane's internal volumes cannot be renamed"))
ErrProjectComposeFileNotFound = Classify(ErrNotFound, errors.Sentinel("Project compose file not found"))
ErrComposeFileNotFound = Classify(ErrNotFound, errors.Sentinel("no compose file found"))
ErrEnvironmentInvalidProxyTarget = Classify(ErrBadRequest, errors.Sentinel("Invalid proxy target URL"))
diff --git a/backend/internal/event/model.go b/backend/internal/event/model.go
index 875a7750b..fb7c2c23f 100644
--- a/backend/internal/event/model.go
+++ b/backend/internal/event/model.go
@@ -56,6 +56,7 @@ const (
EventTypeGitSyncError EventType = "git.sync.error"
EventTypeVolumeCreate EventType = "volume.create"
+ EventTypeVolumeRename EventType = "volume.rename"
EventTypeVolumeDelete EventType = "volume.delete"
EventTypeVolumeError EventType = "volume.error"
diff --git a/backend/internal/event/service.go b/backend/internal/event/service.go
index 903b5cc25..439297b49 100644
--- a/backend/internal/event/service.go
+++ b/backend/internal/event/service.go
@@ -663,6 +663,7 @@ var eventDefinitions = map[EventType]eventDefinition{
EventTypeProjectError: {"Project error: %s", "An error occurred with project '%s'", EventSeverityError},
EventTypeVolumeCreate: {"Volume created: %s", "Volume '%s' has been created", EventSeveritySuccess},
+ EventTypeVolumeRename: {"Volume renamed: %s", "Volume '%s' has been renamed", EventSeveritySuccess},
EventTypeVolumeDelete: {"Volume deleted: %s", "Volume '%s' has been deleted", EventSeverityWarning},
EventTypeVolumeError: {"Volume error: %s", "An error occurred with volume '%s'", EventSeverityError},
EventTypeVolumeFileCreate: {"Volume file created: %s", "A file or directory was created in volume '%s'", EventSeveritySuccess},
diff --git a/backend/internal/volume/handler.go b/backend/internal/volume/handler.go
index 0dbb539f3..00ca31a14 100644
--- a/backend/internal/volume/handler.go
+++ b/backend/internal/volume/handler.go
@@ -22,6 +22,7 @@ import (
"github.com/getarcaneapp/arcane/backend/v2/internal/upload"
"github.com/getarcaneapp/arcane/backend/v2/pkg/authz"
activitylib "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/activity"
+ volumeops "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumes"
"github.com/getarcaneapp/arcane/backend/v2/pkg/pagination"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils/handlerutil"
@@ -86,6 +87,16 @@ type CreateVolumeOutput struct {
Body base.ApiResponse[*volumetypes.Volume]
}
+type RenameVolumeInput struct {
+ EnvironmentID string `path:"id" doc:"Environment ID"`
+ VolumeName string `path:"volumeName" doc:"Current volume name"`
+ Body volumetypes.Rename `doc:"Volume rename data"`
+}
+
+type RenameVolumeOutput struct {
+ Body base.ApiResponse[*volumetypes.Volume]
+}
+
type RemoveVolumeInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
VolumeName string `path:"volumeName" doc:"Volume name"`
@@ -344,6 +355,16 @@ func RegisterVolumes(api huma.API, dockerService *docker.DockerClientService, vo
Security: handlerutil.DefaultOperationSecurity(),
}, authz.PermVolumesDelete, h.RemoveVolume)
+ middleware.RegisterWithPermission(api, huma.Operation{
+ OperationID: "rename-volume",
+ Method: http.MethodPost,
+ Path: "/environments/{id}/volumes/{volumeName}/rename",
+ Summary: "Rename a volume",
+ Description: "Copy an unused Docker volume to a new name and remove the source",
+ Tags: []string{"Volumes"},
+ Security: handlerutil.DefaultOperationSecurity(),
+ }, authz.PermVolumesRename, h.RenameVolume)
+
middleware.RegisterWithPermission(api, huma.Operation{
OperationID: "prune-volumes",
Method: http.MethodPost,
@@ -700,6 +721,69 @@ func (h *VolumeHandler) CreateVolume(ctx context.Context, input *CreateVolumeInp
}, nil
}
+// RenameVolume renames an unused Docker volume.
+func (h *VolumeHandler) RenameVolume(ctx context.Context, input *RenameVolumeInput) (*RenameVolumeOutput, error) {
+ if input.EnvironmentID != "0" {
+ if h.environmentService == nil {
+ return nil, huma.Error500InternalServerError("environment service not available")
+ }
+ remotePath := fmt.Sprintf("/api/environments/0/volumes/%s/rename", url.PathEscape(input.VolumeName))
+ response, err := handlerutil.ProxyRemoteJSON[base.ApiResponse[*volumetypes.Volume]](ctx, h.environmentService.ProxyJSONRequest, input.EnvironmentID, http.MethodPost, remotePath, input.Body)
+ if err != nil {
+ return nil, err
+ }
+ return &RenameVolumeOutput{Body: *response}, nil
+ }
+
+ user, err := handlerutil.RequireUser(ctx)
+ if err != nil {
+ return nil, err
+ }
+
+ var response *volumetypes.Volume
+ runtimeCtx := utils.ActivityRuntimeContext(ctx, h.appCtx)
+ activityID, err := activitylib.RunHandlerActivity(runtimeCtx, h.activityService, activitylib.HandlerOptions{
+ EnvironmentID: input.EnvironmentID,
+ Type: activitytypes.TypeResourceAction,
+ ResourceType: "volume",
+ ResourceID: input.VolumeName,
+ ResourceName: input.VolumeName,
+ User: user,
+ Step: "Renaming volume",
+ Message: "Renaming volume",
+ SuccessMessage: "Volume renamed successfully",
+ Metadata: database.JSON{
+ "action": "rename_volume",
+ "oldName": input.VolumeName,
+ "newName": input.Body.Name,
+ },
+ }, func(runtimeCtx context.Context) error {
+ var renameErr error
+ response, renameErr = h.volumeService.RenameVolume(runtimeCtx, input.VolumeName, input.Body.Name, *user)
+ return renameErr
+ })
+ if err != nil {
+ var conflictErr *volumeops.ProjectVolumeRenameConflictError
+ var inUseErr *volumeops.ProjectVolumeRenameInUseError
+ var spaceErr *volumeops.ProjectVolumeRenameInsufficientSpaceError
+ switch {
+ case errors.Is(err, common.ErrBadRequest):
+ return nil, huma.Error400BadRequest(err.Error())
+ case errors.As(err, &conflictErr), errors.As(err, &inUseErr):
+ return nil, huma.Error409Conflict(err.Error())
+ case errors.As(err, &spaceErr):
+ return nil, huma.NewError(http.StatusInsufficientStorage, err.Error())
+ case errors.Is(err, common.ErrNotFound):
+ return nil, huma.Error404NotFound(err.Error())
+ default:
+ return nil, huma.Error500InternalServerError(errors.WithMessage(err, "Failed to rename volume").Error())
+ }
+ }
+ response.ActivityID = mo.EmptyableToOption(strings.TrimSpace(activityID)).ToPointer()
+
+ return &RenameVolumeOutput{Body: base.ApiResponse[*volumetypes.Volume]{Success: true, Data: response}}, nil
+}
+
// RemoveVolume removes a Docker volume.
func (h *VolumeHandler) RemoveVolume(ctx context.Context, input *RemoveVolumeInput) (*RemoveVolumeOutput, error) {
user, err := handlerutil.RequireUser(ctx)
diff --git a/backend/internal/volume/rename.go b/backend/internal/volume/rename.go
new file mode 100644
index 000000000..cceeadf28
--- /dev/null
+++ b/backend/internal/volume/rename.go
@@ -0,0 +1,137 @@
+package volume
+
+import (
+ "context"
+ stderrors "errors"
+ "log/slog"
+ "strings"
+
+ "emperror.dev/errors"
+ cerrdefs "github.com/containerd/errdefs"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/common"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/database"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/event"
+ dockerutil "github.com/getarcaneapp/arcane/backend/v2/pkg/dockerutil"
+ volumeops "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumes"
+ volumetypes "github.com/getarcaneapp/arcane/types/v2/volume"
+ "github.com/moby/moby/client"
+ "gorm.io/gorm"
+)
+
+// RenameVolume copies an unused volume to a new name and removes the source.
+func (s *VolumeService) RenameVolume(ctx context.Context, oldName, newName string, user common.User) (*volumetypes.Volume, error) {
+ oldName = strings.TrimSpace(oldName)
+ newName = strings.TrimSpace(newName)
+ if oldName == "" || newName == "" || oldName == newName {
+ return nil, common.ErrVolumeRenameInvalid
+ }
+ if strings.EqualFold(oldName, s.backupVolumeName) || strings.EqualFold(newName, s.backupVolumeName) {
+ return nil, common.ErrVolumeRenameProtected
+ }
+
+ defer s.workspaceLocks.Lock(oldName)()
+
+ dockerClient, err := s.dockerService.GetClient(ctx)
+ if err != nil {
+ s.logVolumeRenameErrorInternal(ctx, oldName, newName, user, "connect", err)
+ return nil, errors.WrapIf(err, "failed to connect to Docker")
+ }
+
+ source, err := dockerClient.VolumeInspect(ctx, oldName, client.VolumeInspectOptions{})
+ if err != nil {
+ if cerrdefs.IsNotFound(err) {
+ err = common.Classify(common.ErrNotFound, err)
+ }
+ s.logVolumeRenameErrorInternal(ctx, oldName, newName, user, "inspect", err)
+ return nil, errors.WrapIf(err, "inspect source volume")
+ }
+ if s.isInternalVolumeInternal(volumetypes.NewSummary(source.Volume)) {
+ return nil, common.ErrVolumeRenameProtected
+ }
+
+ // Stop any read-only browse helper first; a helper mounting the volume would
+ // otherwise fail the detached-source check with "in use".
+ if stopErr := s.StopHelper(ctx, oldName); stopErr != nil {
+ slog.WarnContext(ctx, "could not stop volume browse helper before rename", "volume", oldName, "error", stopErr.Error())
+ }
+
+ migration, err := volumeops.PlanRename(ctx, dockerClient, oldName, newName)
+ if err != nil {
+ s.logVolumeRenameErrorInternal(ctx, oldName, newName, user, "plan", err)
+ return nil, err
+ }
+ if err := migration.Apply(ctx); err != nil {
+ if cerrdefs.IsInvalidArgument(err) {
+ err = common.Classify(common.ErrBadRequest, err)
+ }
+ s.logVolumeRenameErrorInternal(ctx, oldName, newName, user, "apply", err)
+ return nil, err
+ }
+
+ if err := s.renameVolumeMetadataInternal(ctx, oldName, newName); err != nil {
+ rollbackErr := migration.Rollback(ctx)
+ combinedErr := stderrors.Join(errors.WrapIf(err, "rename volume metadata"), rollbackErr)
+ s.logVolumeRenameErrorInternal(ctx, oldName, newName, user, "metadata", combinedErr)
+ return nil, combinedErr
+ }
+
+ if committer, ok := migration.(volumeops.Committer); ok {
+ if err := committer.Commit(ctx); err != nil {
+ var cleanupErr *volumeops.SourceCleanupError
+ if errors.As(err, &cleanupErr) {
+ // The copy and metadata are committed; only removing the source
+ // failed, so the rename itself succeeded.
+ slog.WarnContext(ctx, "volume renamed but source volume could not be removed", "oldVolume", oldName, "newVolume", newName, "error", err.Error())
+ } else {
+ metadataErr := s.renameVolumeMetadataInternal(ctx, newName, oldName)
+ rollbackErr := migration.Rollback(ctx)
+ combinedErr := stderrors.Join(err, metadataErr, rollbackErr)
+ s.logVolumeRenameErrorInternal(ctx, oldName, newName, user, "commit", combinedErr)
+ return nil, combinedErr
+ }
+ }
+ }
+
+ s.removeHelperEntry(oldName)
+ dockerutil.InvalidateVolumeUsageCache(dockerClient)
+
+ renamed, err := s.GetVolumeByName(ctx, newName)
+ if err != nil {
+ s.logVolumeRenameErrorInternal(ctx, oldName, newName, user, "inspect-renamed", err)
+ return nil, errors.WrapIf(err, "inspect renamed volume")
+ }
+
+ metadata := database.JSON{"action": "rename", "oldName": oldName, "newName": newName}
+ if logErr := s.eventService.LogVolumeEvent(ctx, event.EventTypeVolumeRename, newName, newName, user.ID, user.Username, "0", metadata); logErr != nil {
+ slog.WarnContext(ctx, "could not log volume rename action", "oldVolume", oldName, "newVolume", newName, "error", logErr)
+ }
+
+ return renamed, nil
+}
+
+// Backup jobs are keyed by policy ID and re-read the policy row on every run,
+// so renaming volume_name requires no job rescheduling.
+func (s *VolumeService) renameVolumeMetadataInternal(ctx context.Context, oldName, newName string) error {
+ if s.db == nil {
+ return nil
+ }
+
+ return s.db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {
+ if err := tx.Model(&VolumeBackup{}).Where("volume_name = ?", oldName).Update("volume_name", newName).Error; err != nil {
+ return errors.WrapIf(err, "rename volume backup history")
+ }
+ if err := tx.Model(&VolumeBackupPolicy{}).Where("volume_name = ?", oldName).Update("volume_name", newName).Error; err != nil {
+ return errors.WrapIf(err, "rename volume backup policies")
+ }
+ return nil
+ })
+}
+
+func (s *VolumeService) logVolumeRenameErrorInternal(ctx context.Context, oldName, newName string, user common.User, step string, err error) {
+ s.eventService.LogErrorEvent(ctx, event.EventTypeVolumeError, "volume", oldName, oldName, user.ID, user.Username, "0", err, database.JSON{
+ "action": "rename",
+ "step": step,
+ "oldName": oldName,
+ "newName": newName,
+ })
+}
diff --git a/backend/internal/volume/service_test.go b/backend/internal/volume/service_test.go
index dc45d211d..5ef1a29a4 100644
--- a/backend/internal/volume/service_test.go
+++ b/backend/internal/volume/service_test.go
@@ -314,6 +314,40 @@ func TestIsInternalVolumeInternal(t *testing.T) {
require.False(t, svc.isInternalVolumeInternal(volumetypes.Volume{Name: "user-volume"}))
}
+func TestRenameVolumeRejectsInvalidAndProtectedNames(t *testing.T) {
+ service := &VolumeService{backupVolumeName: "arcane-backups"}
+
+ _, err := service.RenameVolume(t.Context(), "data", "data", common.User{})
+ require.ErrorIs(t, err, common.ErrVolumeRenameInvalid)
+
+ _, err = service.RenameVolume(t.Context(), "arcane-backups", "renamed-backups", common.User{})
+ require.ErrorIs(t, err, common.ErrVolumeRenameProtected)
+
+ _, err = service.RenameVolume(t.Context(), "data", "arcane-backups", common.User{})
+ require.ErrorIs(t, err, common.ErrVolumeRenameProtected)
+}
+
+func TestRenameVolumeMetadataInternalPreservesPoliciesAndHistory(t *testing.T) {
+ gormDB, err := gorm.Open(sqlite.Open("file:volume-rename-metadata?mode=memory&cache=shared"), &gorm.Config{})
+ require.NoError(t, err)
+ require.NoError(t, gormDB.AutoMigrate(&VolumeBackupPolicy{}, &VolumeBackup{}))
+
+ policy := VolumeBackupPolicy{VolumeName: "source-data", Schedule: defaultVolumeBackupSchedule, LocalEnabled: true}
+ require.NoError(t, gormDB.Create(&policy).Error)
+ require.NoError(t, gormDB.Create(&VolumeBackup{VolumeName: "source-data", PolicyID: policy.ID}).Error)
+
+ service := &VolumeService{db: &database.DB{DB: gormDB}}
+ require.NoError(t, service.renameVolumeMetadataInternal(t.Context(), "source-data", "renamed-data"))
+
+ var renamedPolicy VolumeBackupPolicy
+ require.NoError(t, gormDB.Where("id = ?", policy.ID).First(&renamedPolicy).Error)
+ require.Equal(t, "renamed-data", renamedPolicy.VolumeName)
+
+ var backupEntry VolumeBackup
+ require.NoError(t, gormDB.Where("policy_id = ?", policy.ID).First(&backupEntry).Error)
+ require.Equal(t, "renamed-data", backupEntry.VolumeName)
+}
+
func TestBuildVolumePruneOptionsInternal_PreservesTrivyCache(t *testing.T) {
options := buildVolumePruneOptionsInternal(true, true)
diff --git a/backend/pkg/authz/catalog.go b/backend/pkg/authz/catalog.go
index 0a880e3a2..fa135e627 100644
--- a/backend/pkg/authz/catalog.go
+++ b/backend/pkg/authz/catalog.go
@@ -162,6 +162,7 @@ var permissionCatalog = []PermissionCatalogResource{
{"list", PermVolumesList, "List", ""},
{"read", PermVolumesRead, "Read", ""},
{"create", PermVolumesCreate, "Create", ""},
+ {"rename", PermVolumesRename, "Rename", ""},
{"delete", PermVolumesDelete, "Delete", ""},
{"prune", PermVolumesPrune, "Prune", ""},
{"upload", PermVolumesUpload, "Upload", ""},
diff --git a/backend/pkg/authz/permission_set_test.go b/backend/pkg/authz/permission_set_test.go
index a0b879a93..cbed0ed00 100644
--- a/backend/pkg/authz/permission_set_test.go
+++ b/backend/pkg/authz/permission_set_test.go
@@ -420,6 +420,13 @@ func TestPermissionCatalogDerivesKnownPermissionsAndScopes(t *testing.T) {
}
}
+func TestVolumeRenamePermissionIsEditorOnlyByDefault(t *testing.T) {
+ require.Contains(t, AllPermissions(), PermVolumesRename)
+ require.Contains(t, BuiltInEditorPermissions(), PermVolumesRename)
+ require.NotContains(t, BuiltInViewerPermissions(), PermVolumesRename)
+ require.NotContains(t, BuiltInDeployerPermissions(), PermVolumesRename)
+}
+
func TestNotificationsManageRequiresGlobalScope(t *testing.T) {
require.True(t, IsOrgLevel(PermNotificationsManage),
diff --git a/backend/pkg/authz/permissions.go b/backend/pkg/authz/permissions.go
index fc14310e8..03bc8234b 100644
--- a/backend/pkg/authz/permissions.go
+++ b/backend/pkg/authz/permissions.go
@@ -159,6 +159,7 @@ const (
PermVolumesList = "volumes:list"
PermVolumesRead = "volumes:read"
PermVolumesCreate = "volumes:create"
+ PermVolumesRename = "volumes:rename"
PermVolumesDelete = "volumes:delete"
PermVolumesPrune = "volumes:prune"
PermVolumesUpload = "volumes:upload"
@@ -326,7 +327,7 @@ func BuiltInEditorPermissions() []string {
PermContainersList, PermContainersRead, PermContainersLogs, PermContainersCreate, PermContainersStart, PermContainersStop, PermContainersRestart, PermContainersRedeploy, PermContainersEdit, PermContainersKill, PermContainersPause, PermContainersDelete, PermContainersExec, PermContainersAutoUpdate,
PermProjectsList, PermProjectsRead, PermProjectsLogs, PermProjectsCreate, PermProjectsUpdate, PermProjectsDeploy, PermProjectsDown, PermProjectsRestart, PermProjectsDelete, PermProjectsArchive,
PermImagesList, PermImagesRead, PermImagesPull, PermImagesPush, PermImagesBuild, PermImagesTag, PermImagesCommit, PermImagesPrune, PermImagesDelete, PermImagesUpload,
- PermVolumesList, PermVolumesRead, PermVolumesCreate, PermVolumesDelete, PermVolumesPrune, PermVolumesUpload, PermVolumesBackup,
+ PermVolumesList, PermVolumesRead, PermVolumesCreate, PermVolumesRename, PermVolumesDelete, PermVolumesPrune, PermVolumesUpload, PermVolumesBackup,
PermNetworksList, PermNetworksRead, PermNetworksCreate, PermNetworksDelete, PermNetworksPrune, PermNetworksConnect, PermNetworksDisconnect,
PermSwarmRead, PermSwarmSpec, PermSwarmNodes, PermSwarmServices, PermSwarmServicesLogs, PermSwarmStacks, PermSwarmConfigs, PermSwarmSecrets,
PermGitOpsList, PermGitOpsRead, PermGitOpsCreate, PermGitOpsUpdate, PermGitOpsDelete, PermGitOpsSync,
diff --git a/backend/pkg/libarcane/volumes/volume_rename.go b/backend/pkg/libarcane/volumes/volume_rename.go
index ecd744eba..987fd2b5a 100644
--- a/backend/pkg/libarcane/volumes/volume_rename.go
+++ b/backend/pkg/libarcane/volumes/volume_rename.go
@@ -38,11 +38,12 @@ type JournalSource interface {
}
type projectVolumeRenameEntryInternal struct {
- Key string
- OldName string
- NewName string
- OldVolume volume.Volume
- NewConfig composetypes.VolumeConfig
+ Key string
+ OldName string
+ NewName string
+ OldVolume volume.Volume
+ NewConfig composetypes.VolumeConfig
+ CreateOptions client.VolumeCreateOptions
}
type dockerProjectVolumeRenameMigrationInternal struct {
@@ -104,6 +105,50 @@ func PlanMigration(ctx context.Context, dockerClient *client.Client, composeProj
}, nil
}
+// PlanRename validates and prepares an unused Docker volume for a copy-based rename.
+func PlanRename(ctx context.Context, dockerClient *client.Client, oldName, newName string) (Migration, error) {
+ if dockerClient == nil {
+ return nil, errors.New("docker service unavailable")
+ }
+
+ oldName = strings.TrimSpace(oldName)
+ newName = strings.TrimSpace(newName)
+ if oldName == "" || newName == "" {
+ return nil, errors.New("source and target volume names are required")
+ }
+ if oldName == newName {
+ return nil, errors.New("source and target volume names must differ")
+ }
+
+ oldVolume, err := dockerClient.VolumeInspect(ctx, oldName, client.VolumeInspectOptions{})
+ if err != nil {
+ return nil, errors.WrapIff(err, "inspect source volume %s", oldName)
+ }
+ if err := ensureProjectRenameSourceVolumeDetachedInternal(ctx, dockerClient, oldName); err != nil {
+ return nil, err
+ }
+ if err := ensureProjectRenameTargetVolumeAbsentInternal(ctx, dockerClient, newName); err != nil {
+ return nil, err
+ }
+
+ entry := projectVolumeRenameEntryInternal{
+ OldName: oldName,
+ NewName: newName,
+ OldVolume: oldVolume.Volume,
+ CreateOptions: client.VolumeCreateOptions{
+ Name: newName,
+ Driver: oldVolume.Volume.Driver,
+ DriverOpts: cloneStringMapInternal(oldVolume.Volume.Options),
+ Labels: cloneStringMapInternal(oldVolume.Volume.Labels),
+ },
+ }
+
+ return &dockerProjectVolumeRenameMigrationInternal{
+ dockerClient: dockerClient,
+ entries: []projectVolumeRenameEntryInternal{entry},
+ }, nil
+}
+
func collectProjectRenameVolumeEntriesInternal(ctx context.Context, dockerClient *client.Client, volumes map[string]composetypes.VolumeConfig, explicitVolumeNames map[string]struct{}, oldComposeName, newComposeName string) ([]projectVolumeRenameEntryInternal, error) {
entries := make([]projectVolumeRenameEntryInternal, 0, len(volumes))
for key, volumeConfig := range volumes {
@@ -356,6 +401,13 @@ func ensureProjectRenameSourceVolumeDetachedInternal(ctx context.Context, docker
}
func createProjectRenamedVolumeInternal(ctx context.Context, dockerClient *client.Client, entry projectVolumeRenameEntryInternal) error {
+ if strings.TrimSpace(entry.CreateOptions.Name) != "" {
+ if _, err := dockerClient.VolumeCreate(ctx, entry.CreateOptions); err != nil {
+ return errors.WrapIff(err, "create target volume %s", entry.NewName)
+ }
+ return nil
+ }
+
labels := map[string]string{}
maps.Copy(labels, entry.OldVolume.Labels)
maps.Copy(labels, entry.NewConfig.Labels)
diff --git a/backend/pkg/libarcane/volumes/volume_rename_test.go b/backend/pkg/libarcane/volumes/volume_rename_test.go
index d4bbebc99..6c7fdfd93 100644
--- a/backend/pkg/libarcane/volumes/volume_rename_test.go
+++ b/backend/pkg/libarcane/volumes/volume_rename_test.go
@@ -59,6 +59,43 @@ func TestBuildProjectRenamedVolumeConfigInternal(t *testing.T) {
require.Equal(t, api.ComposeVersion, got.CustomLabels[api.VersionLabel])
}
+func TestPlanRenamePreservesStandaloneVolumeConfiguration(t *testing.T) {
+ server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ switch {
+ case r.Method == http.MethodGet && strings.HasSuffix(r.URL.Path, "/volumes/source-data"):
+ w.Header().Set("Content-Type", "application/json")
+ require.NoError(t, json.NewEncoder(w).Encode(volume.Volume{
+ Name: "source-data",
+ Driver: "local",
+ Options: map[string]string{"type": "none", "device": "/srv/data"},
+ Labels: map[string]string{"owner": "arcane"},
+ }))
+ case r.Method == http.MethodGet && strings.HasSuffix(r.URL.Path, "/containers/json"):
+ w.Header().Set("Content-Type", "application/json")
+ require.NoError(t, json.NewEncoder(w).Encode([]container.Summary{}))
+ case r.Method == http.MethodGet && strings.HasSuffix(r.URL.Path, "/volumes/renamed-data"):
+ http.NotFound(w, r)
+ default:
+ http.Error(w, "unexpected Docker request: "+r.Method+" "+r.URL.Path, http.StatusInternalServerError)
+ }
+ }))
+ t.Cleanup(server.Close)
+
+ migration, err := PlanRename(t.Context(), newTestDockerClient(t, server), "source-data", "renamed-data")
+ require.NoError(t, err)
+
+ planned, ok := migration.(*dockerProjectVolumeRenameMigrationInternal)
+ require.True(t, ok)
+ require.Len(t, planned.entries, 1)
+ entry := planned.entries[0]
+ require.Equal(t, "source-data", entry.OldName)
+ require.Equal(t, "renamed-data", entry.NewName)
+ require.Equal(t, "renamed-data", entry.CreateOptions.Name)
+ require.Equal(t, "local", entry.CreateOptions.Driver)
+ require.Equal(t, map[string]string{"type": "none", "device": "/srv/data"}, entry.CreateOptions.DriverOpts)
+ require.Equal(t, map[string]string{"owner": "arcane"}, entry.CreateOptions.Labels)
+}
+
func TestContainerSummaryMountsVolumeInternal(t *testing.T) {
summary := container.Summary{
Labels: map[string]string{
diff --git a/frontend/messages/en.json b/frontend/messages/en.json
index c10b55c47..a1844ee65 100644
--- a/frontend/messages/en.json
+++ b/frontend/messages/en.json
@@ -933,6 +933,14 @@
"volumes_driver_options_description": "Volume driver-specific options",
"volumes_no_labels_or_options": "This volume has no additional labels or driver options.",
"volume_name_required": "Volume name is required",
+ "volumes_rename_title": "Rename Volume",
+ "volumes_rename_description": "Arcane will copy the volume data to the new name, then remove the original volume.",
+ "volumes_rename_new_name": "New volume name",
+ "volumes_rename_same_name": "Enter a different volume name",
+ "volumes_rename_managed_warning_title": "Deployment-managed volume",
+ "volumes_rename_managed_warning_description": "A project that still references this volume may recreate the original volume unless its configuration is updated.",
+ "volumes_rename_success": "Volume {oldName} renamed to {newName}",
+ "volumes_rename_failed": "Failed to rename volume {name}",
"volumes_remove_confirm_message": "Are you sure you want to remove volume {name}?",
"volumes_remove_selected_title": "Remove {count} Volume(s)",
"volumes_remove_selected_message": "Are you sure you want to remove the selected volume(s)? This action cannot be undone.",
diff --git a/frontend/src/lib/components/ui/alert/alert.svelte b/frontend/src/lib/components/ui/alert/alert.svelte
index 512689479..fd471a302 100644
--- a/frontend/src/lib/components/ui/alert/alert.svelte
+++ b/frontend/src/lib/components/ui/alert/alert.svelte
@@ -6,7 +6,8 @@
variants: {
variant: {
default: 'text-foreground',
- warning: 'border-amber-600/50 text-amber-300 dark:border-amber-600 [&>svg]:text-amber-300',
+ warning:
+ 'border-amber-600/50 text-amber-600 dark:border-amber-600 dark:text-amber-400 [&>svg]:text-amber-600 dark:[&>svg]:text-amber-400',
destructive: 'border-destructive/50 text-destructive dark:border-destructive [&>svg]:text-destructive'
}
},
diff --git a/frontend/src/lib/services/volume-service.ts b/frontend/src/lib/services/volume-service.ts
index f0dd72674..258a6ae33 100644
--- a/frontend/src/lib/services/volume-service.ts
+++ b/frontend/src/lib/services/volume-service.ts
@@ -6,6 +6,7 @@ import type {
VolumeUsageDto,
VolumeUsageCounts,
VolumeCreateRequest,
+ VolumeRenameRequest,
VolumeSizeInfo
} from '#lib/types/docker';
import type { SearchPaginationSortRequest, Paginated } from '#lib/types/shared';
@@ -62,6 +63,13 @@ class VolumeService extends BaseAPIService {
return this.handleResponse(this.api.post(`/environments/${envId}/volumes`, options));
}
+ async renameVolume(sourceName: string, options: VolumeRenameRequest, environmentId?: string): Promise<VolumeDetailDto> {
+ const envId = await this.resolveEnvironmentId(environmentId);
+ return this.handleResponse(
+ this.api.post(`/environments/${envId}/volumes/${encodeURIComponent(sourceName)}/rename`, options)
+ ) as Promise<VolumeDetailDto>;
+ }
+
async deleteVolume(volumeName: string): Promise<any> {
// Resolve the env id synchronously when possible so bulk deletes start
// their request inside the runWithActivityBatchId scope (see api-service).
diff --git a/frontend/src/lib/types/docker.ts b/frontend/src/lib/types/docker.ts
index 1f8b7e980..f52d077a0 100644
--- a/frontend/src/lib/types/docker.ts
+++ b/frontend/src/lib/types/docker.ts
@@ -780,6 +780,10 @@ export interface VolumeCreateRequest {
labels?: Record<string, string>;
}
+export interface VolumeRenameRequest {
+ name: string;
+}
+
export interface VolumeSummaryDto {
id: string;
name: string;
diff --git a/frontend/src/lib/utils/docker.ts b/frontend/src/lib/utils/docker.ts
index 98f2b25b1..de944f49b 100644
--- a/frontend/src/lib/utils/docker.ts
+++ b/frontend/src/lib/utils/docker.ts
@@ -6,6 +6,15 @@ import type { ProjectUpdateInfo } from '#lib/types/swarm';
import type { SwarmServiceModeName, SwarmServiceModeSpec } from '#lib/types/swarm';
import type { VulnerabilityScanSummary } from '#lib/types/environment';
+// --- Compose / Swarm management labels ---
+
+export const COMPOSE_PROJECT_LABEL = 'com.docker.compose.project';
+export const SWARM_STACK_LABEL = 'com.docker.stack.namespace';
+
+export function getManagedByLabel(labels?: Record<string, string> | null): string | undefined {
+ return labels?.[COMPOSE_PROJECT_LABEL] || labels?.[SWARM_STACK_LABEL] || undefined;
+}
+
// --- Container stats math ---
export function calculateCPUPercent(stats: ContainerStats | null): number {
diff --git a/frontend/src/routes/(app)/containers/container-table.helpers.ts b/frontend/src/routes/(app)/containers/container-table.helpers.ts
index 96d7a244b..9433dcb2d 100644
--- a/frontend/src/routes/(app)/containers/container-table.helpers.ts
+++ b/frontend/src/routes/(app)/containers/container-table.helpers.ts
@@ -1,5 +1,6 @@
import { m } from '#lib/paraglide/messages';
import type { ContainerSummaryDto } from '#lib/types/docker';
+import { COMPOSE_PROJECT_LABEL } from '#lib/utils/docker';
export type ActionStatus =
| 'starting'
@@ -46,7 +47,7 @@ export function getStateBadgeVariant(state: string): StateBadgeVariant {
}
export function getProjectName(container: ContainerSummaryDto): string {
- const projectLabel = container.labels?.['com.docker.compose.project'];
+ const projectLabel = container.labels?.[COMPOSE_PROJECT_LABEL];
return projectLabel || 'No Project';
}
diff --git a/frontend/src/routes/(app)/containers/container-table.svelte b/frontend/src/routes/(app)/containers/container-table.svelte
index 2bd695e70..14143b593 100644
--- a/frontend/src/routes/(app)/containers/container-table.svelte
+++ b/frontend/src/routes/(app)/containers/container-table.svelte
@@ -30,7 +30,7 @@
import { environmentStore } from '#lib/stores/environment.store.svelte';
import { hasPermission } from '#lib/utils/auth';
import IconImage from '#lib/components/icon-image.svelte';
- import { getContainerIpAddresses, getThemedIconUrl, parseImageRef } from '#lib/utils/docker';
+ import { COMPOSE_PROJECT_LABEL, getContainerIpAddresses, getThemedIconUrl, parseImageRef } from '#lib/utils/docker';
import { hasAnyLoadingState } from '#lib/utils/bulk-actions';
import { createContainerActions } from './container-table.actions';
import {
@@ -400,7 +400,7 @@
{#snippet NameCell({ item }: { item: ContainerSummaryDto })}
{@const displayName = getContainerDisplayName(item)}
{@const iconUrl = getThemedIconUrl(item, mode.current)}
- {@const projectLabel = item.labels?.['com.docker.compose.project']}
+ {@const projectLabel = item.labels?.[COMPOSE_PROJECT_LABEL]}
<div class="flex items-center gap-2">
<IconImage src={iconUrl} alt={displayName} fallback={BoxIcon} class="size-6" containerClass="size-8" />
<a class="font-medium hover:underline" href="/containers/{item.id}">{displayName}</a>
@@ -636,7 +636,7 @@
{m.common_inspect()}
</DropdownMenu.Item>
- {#if canEditContainers && !item.redeployDisabled && !item.labels?.['com.docker.compose.project']}
+ {#if canEditContainers && !item.redeployDisabled && !item.labels?.[COMPOSE_PROJECT_LABEL]}
<DropdownMenu.Item onclick={() => goto(`/containers/${item.id}/edit`)} disabled={isAnyLoading}>
<EditIcon class="size-4" />
{m.common_edit()}
diff --git a/frontend/src/routes/(app)/swarm/services/components/ServiceOverview.svelte b/frontend/src/routes/(app)/swarm/services/components/ServiceOverview.svelte
index aa0056b53..9bd689f1d 100644
--- a/frontend/src/routes/(app)/swarm/services/components/ServiceOverview.svelte
+++ b/frontend/src/routes/(app)/swarm/services/components/ServiceOverview.svelte
@@ -6,7 +6,12 @@
import { formatDistanceToNow } from 'date-fns';
import { InfoIcon, ConnectionIcon } from '#lib/icons';
import { formatDateTimeShort, truncateImageDigest } from '#lib/utils/formatting';
- import { getSwarmServiceModeLabel, getSwarmServiceModeVariant, isSwarmServiceModeScalable } from '#lib/utils/docker';
+ import {
+ SWARM_STACK_LABEL,
+ getSwarmServiceModeLabel,
+ getSwarmServiceModeVariant,
+ isSwarmServiceModeScalable
+ } from '#lib/utils/docker';
import { KeyValueCard } from '#lib/components/resource-detail';
interface Props {
@@ -34,7 +39,7 @@
}
}
- const stackName = $derived(labels?.['com.docker.stack.namespace'] || '');
+ const stackName = $derived(labels?.[SWARM_STACK_LABEL] || '');
const nodes = $derived((service?.nodes as string[]) || []);
const versionIndex = $derived(service?.version?.index ?? service?.version?.Index ?? 0);
const updateStatus = $derived(service?.updateStatus as Record<string, any> | null | undefined);
diff --git a/frontend/src/routes/(app)/volumes/components/rename-volume-dialog.svelte b/frontend/src/routes/(app)/volumes/components/rename-volume-dialog.svelte
new file mode 100644
index 000000000..183502798
--- /dev/null
+++ b/frontend/src/routes/(app)/volumes/components/rename-volume-dialog.svelte
@@ -0,0 +1,100 @@
+<script lang="ts">
+ import * as Alert from '#lib/components/ui/alert/index.js';
+ import TextInputWithLabel from '#lib/components/form/text-input-with-label.svelte';
+ import SheetFooterActions from '#lib/components/sheets/sheet-footer-actions.svelte';
+ import * as ResponsiveDialog from '#lib/components/ui/responsive-dialog/index.js';
+ import { AlertTriangleIcon } from '#lib/icons';
+ import { m } from '#lib/paraglide/messages';
+ import type { VolumeSummaryDto } from '#lib/types/docker';
+ import { getManagedByLabel } from '#lib/utils/docker';
+
+ let {
+ open = $bindable(false),
+ volume,
+ isLoading,
+ onSubmit
+ }: {
+ open: boolean;
+ volume: VolumeSummaryDto | null;
+ isLoading: boolean;
+ onSubmit: (newName: string) => void;
+ } = $props();
+
+ let newName = $state('');
+ let error = $state<string | null>(null);
+
+ const isManaged = $derived(Boolean(getManagedByLabel(volume?.labels)));
+ const normalizedName = $derived(newName.trim());
+ const canRename = $derived(Boolean(volume && normalizedName && normalizedName !== volume.name));
+
+ $effect(() => {
+ if (!open) return;
+ newName = volume?.name ?? '';
+ error = null;
+ });
+
+ function handleOpenChange(isOpen: boolean) {
+ if (!isOpen) error = null;
+ }
+
+ function submit() {
+ if (!normalizedName) {
+ error = m.volume_name_required();
+ return;
+ }
+ if (normalizedName === volume?.name) {
+ error = m.volumes_rename_same_name();
+ return;
+ }
+ error = null;
+ onSubmit(normalizedName);
+ }
+</script>
+
+<ResponsiveDialog.Root
+ bind:open
+ onOpenChange={handleOpenChange}
+ title={m.volumes_rename_title()}
+ description={m.volumes_rename_description()}
+ contentClass="sm:max-w-[500px]"
+>
+ {#snippet children()}
+ <form
+ id="rename-volume-form"
+ onsubmit={(event) => {
+ event.preventDefault();
+ submit();
+ }}
+ class="space-y-4 py-4"
+ >
+ <TextInputWithLabel
+ id="rename-volume-name"
+ bind:value={newName}
+ label={m.volumes_rename_new_name()}
+ {error}
+ disabled={isLoading}
+ autocomplete="off"
+ />
+
+ {#if isManaged}
+ <Alert.Root variant="warning">
+ <AlertTriangleIcon class="size-4" />
+ <Alert.Title>{m.volumes_rename_managed_warning_title()}</Alert.Title>
+ <Alert.Description class="text-foreground">{m.volumes_rename_managed_warning_description()}</Alert.Description>
+ </Alert.Root>
+ {/if}
+ </form>
+ {/snippet}
+
+ {#snippet footer()}
+ <SheetFooterActions
+ onCancel={() => (open = false)}
+ cancelDisabled={isLoading}
+ submitAction="edit"
+ submitLabel={m.rename()}
+ submitForm="rename-volume-form"
+ submitLoading={isLoading}
+ submitDisabled={!canRename || isLoading}
+ />
+ {/snippet}
+</ResponsiveDialog.Root>
diff --git a/frontend/src/routes/(app)/volumes/volume-table.svelte b/frontend/src/routes/(app)/volumes/volume-table.svelte
index 28b33a5e2..ede4b3f2e 100644
--- a/frontend/src/routes/(app)/volumes/volume-table.svelte
+++ b/frontend/src/routes/(app)/volumes/volume-table.svelte
@@ -17,7 +17,7 @@
import { volumeService } from '#lib/services/volume-service';
import { bytes } from '#lib/utils/formatting';
import { inUseBadge } from '#lib/utils/mobile-card-badges';
- import { TrashIcon, InspectIcon, VolumesIcon, CalendarIcon } from '#lib/icons';
+ import { TrashIcon, InspectIcon, VolumesIcon, CalendarIcon, EditIcon } from '#lib/icons';
import { Spinner } from '#lib/components/ui/spinner';
import settingsStore from '#lib/stores/config-store';
import { untrack } from 'svelte';
@@ -28,6 +28,7 @@
import userStore from '#lib/stores/user-store';
import { activityToastOptions, extractActivityId } from '#lib/utils/activity-toast';
import { bulkConfirmAndRun } from '#lib/utils/bulk-actions';
+ import RenameVolumeDialog from './components/rename-volume-dialog.svelte';
let {
volumes = $bindable(),
@@ -42,8 +43,12 @@
} = $props();
let isLoading = $state({
- removing: false
+ removing: false,
+ renaming: false
});
+ let volumeToRename = $state<VolumeSummaryDto | null>(null);
+ let renameDialogOpen = $state(false);
+ let renameEnvironmentId = $state('0');
const currentEnvId = $derived(environmentStore.selected?.id || '0');
// Track the user store: hasPermission reads it non-reactively, so without
@@ -52,6 +57,10 @@
$userStore;
return hasPermission('volumes:delete', currentEnvId);
});
+ const canRenameVolume = $derived.by(() => {
+ $userStore;
+ return hasPermission('volumes:rename', currentEnvId);
+ });
let customSettings = $state<Record<string, unknown>>({});
let showInternal = $derived.by(() => {
return (customSettings['showInternalVolumes'] as boolean) ?? false;
@@ -160,6 +169,29 @@
});
}
+ function handleRenameVolume(item: VolumeSummaryDto) {
+ volumeToRename = item;
+ renameEnvironmentId = currentEnvId;
+ renameDialogOpen = true;
+ }
+
+ async function handleRenameSubmit(newName: string) {
+ if (!volumeToRename) return;
+ const oldName = volumeToRename.name;
+ isLoading.renaming = true;
+ handleApiResultWithCallbacks({
+ result: await tryCatch(volumeService.renameVolume(oldName, { name: newName }, renameEnvironmentId)),
+ message: m.volumes_rename_failed({ name: oldName }),
+ setLoadingState: (value) => (isLoading.renaming = value),
+ onSuccess: async (data) => {
+ toast.success(m.volumes_rename_success({ oldName, newName }), activityToastOptions(extractActivityId(data)));
+ renameDialogOpen = false;
+ volumeToRename = null;
+ if (renameEnvironmentId === currentEnvId) await refreshVolumes();
+ }
+ });
+ }
+
function handleDeleteSelected(ids: string[]) {
// A volume's id IS its name (backend sets ID: v.Name), so ids can be
// passed to the delete endpoint directly — no per-page name lookup, which
@@ -325,9 +357,21 @@
{m.common_inspect()}
</DropdownMenu.Item>
- {#if canDeleteVolume}
+ {#if canRenameVolume || canDeleteVolume}
<DropdownMenu.Separator />
+ {/if}
+ {#if canRenameVolume}
+ <DropdownMenu.Item
+ onclick={() => handleRenameVolume(item)}
+ disabled={item.inUse || isBackupVolume(item) || isLoading.renaming}
+ >
+ <EditIcon class="size-4" />
+ {m.rename()}
+ </DropdownMenu.Item>
+ {/if}
+
+ {#if canDeleteVolume}
<DropdownMenu.Item
variant="destructive"
onclick={() => handleRemoveVolumeConfirm(item.name)}
@@ -363,6 +407,13 @@
customViewOptions={CustomViewOptions}
/>
+<RenameVolumeDialog
+ bind:open={renameDialogOpen}
+ volume={volumeToRename}
+ isLoading={isLoading.renaming}
+ onSubmit={handleRenameSubmit}
+/>
+
{#snippet CustomViewOptions()}
<DropdownMenu.CheckboxItem checked={showInternal} onCheckedChange={(v) => setShowInternal(!!v)}>
{`${m.common_show()} ${m.internal()} ${m.resource_volumes_cap()}`}
diff --git a/tests/spec/volumes.spec.ts b/tests/spec/volumes.spec.ts
index edc045249..067d4cf40 100644
--- a/tests/spec/volumes.spec.ts
+++ b/tests/spec/volumes.spec.ts
@@ -1,6 +1,7 @@
import { test, expect, type Page } from '@playwright/test';
import { fetchVolumeCountsWithRetry } from '../utils/fetch.util';
import { VolumeUsageCounts } from 'types/volumes.type';
+import { openRowActionsMenu } from '../utils/table-actions.util';
let volumeCount: VolumeUsageCounts = { inuse: 0, unused: 0, total: 0 };
@@ -253,6 +254,54 @@ test.describe('Volumes Page', () => {
}
});
+ test('Rename unused volume', async ({ page }) => {
+ const sourceName = `test-rename-source-${Date.now()}`;
+ const targetName = sourceName.replace('source', 'target');
+
+ try {
+ await createVolumeViaApi(page, sourceName);
+ await page.goto('/volumes');
+
+ const row = page
+ .getByRole('row')
+ .filter({ has: page.getByRole('link', { name: sourceName, exact: true }) });
+ const menu = await openRowActionsMenu(page, row);
+ await menu.getByRole('menuitem', { name: 'Rename', exact: true }).click();
+
+ const dialog = page.getByRole('dialog');
+ await expect(dialog).toBeVisible();
+ await dialog.getByLabel('New volume name').fill(targetName);
+
+ const renameRequest = page.waitForResponse((response) => {
+ const request = response.request();
+ return (
+ request.method() === 'POST' &&
+ new URL(response.url()).pathname.endsWith(
+ `/volumes/${encodeURIComponent(sourceName)}/rename`
+ )
+ );
+ });
+ await dialog.getByRole('button', { name: 'Rename', exact: true }).click();
+ const response = await renameRequest;
+ expect(response.ok(), await response.text()).toBe(true);
+
+ await expect(page.getByRole('link', { name: targetName, exact: true })).toBeVisible();
+ expect(
+ (
+ await page.request.get(`/api/environments/0/volumes/${encodeURIComponent(sourceName)}`)
+ ).status()
+ ).toBe(404);
+ expect(
+ (
+ await page.request.get(`/api/environments/0/volumes/${encodeURIComponent(targetName)}`)
+ ).ok()
+ ).toBe(true);
+ } finally {
+ await removeVolumeViaApi(page, sourceName);
+ await removeVolumeViaApi(page, targetName);
+ }
+ });
+
test('Display correct volume usage badge', async ({ page }) => {
const volumeName = `e2e-badge-volume-${Date.now()}`;
try {
diff --git a/types/volume/volume.go b/types/volume/volume.go
index 5c038364b..cb5eaa9bb 100644
--- a/types/volume/volume.go
+++ b/types/volume/volume.go
@@ -129,6 +129,14 @@ type Create struct {
Labels map[string]string `json:"labels,omitempty" doc:"User-defined labels"`
}
+// Rename is used to rename an existing volume.
+type Rename struct {
+ // Name is the new volume name.
+ //
+ // Required: true
+ Name string `json:"name" minLength:"1" doc:"New volume name"`
+}
+
// NewSummary creates a Volume from a docker volume.Volume, calculating InUse
// based on whether the volume has a reference count of 1 or more.
//