coolify/app/Jobs/DockerCleanupJob.php

132 lines
5.1 KiB
PHP
Raw Normal View History

2023-07-07 13:50:36 +00:00
<?php
namespace App\Jobs;
use App\Actions\Server\CleanupDocker;
use App\Events\DockerCleanupDone;
use App\Models\DockerCleanupExecution;
2023-07-07 13:50:36 +00:00
use App\Models\Server;
use App\Notifications\Server\DockerCleanupFailed;
use App\Notifications\Server\DockerCleanupSuccess;
use Carbon\Carbon;
2023-07-07 13:50:36 +00:00
use Illuminate\Bus\Queueable;
2023-09-14 08:12:44 +00:00
use Illuminate\Contracts\Queue\ShouldBeEncrypted;
2023-07-07 13:50:36 +00:00
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
2024-11-07 08:16:58 +00:00
use Illuminate\Queue\Middleware\WithoutOverlapping;
2023-07-07 13:50:36 +00:00
use Illuminate\Queue\SerializesModels;
2024-06-10 20:43:34 +00:00
class DockerCleanupJob implements ShouldBeEncrypted, ShouldQueue
2023-07-07 13:50:36 +00:00
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
2024-08-26 10:23:03 +00:00
public $timeout = 600;
2024-06-10 20:43:34 +00:00
2024-08-26 10:23:03 +00:00
public $tries = 1;
2024-08-21 08:50:05 +00:00
public ?string $usageBefore = null;
public ?DockerCleanupExecution $execution_log = null;
2024-11-07 08:16:58 +00:00
public function middleware(): array
{
v4.0.0-beta.417 (#5784) * feat(README): add InterviewPal sponsorship link and corresponding SVG icon * chore(versions): update coolify version to 4.0.0-beta.413 and nightly version to 4.0.0-beta.414 in configuration files * fix(terminal): enhance WebSocket client verification with authorized IPs in terminal server * chore(versions): update realtime version to 1.0.8 in versions.json * chore(versions): update realtime version to 1.0.8 in versions.json * chore(docker): update soketi image version to 1.0.8 in production configuration files * chore(versions): update coolify version to 4.0.0-beta.414 and nightly version to 4.0.0-beta.415 in configuration files * fix(ApplicationDeploymentJob): ensure source is an object before checking GitHub app properties * fix(ui): Disable livewire navigate feature (causing spam of setInterval()) * fix(ui): Remove required attribute from image input in service application view * fix(ui): Change application image validation to be nullable in service application view * fix(Server): Correct proxy path formatting for Traefik proxy type * chore(versions): update coolify version to 4.0.0-beta.416 and nightly version to 4.0.0-beta.417 in configuration files; fix links in deployment view * feat(Service): Add functionality to convert between applications and databases in docker-compose based applications fix(ui): Fix service layout refresh on compose change * fix(service): graceful shutdown of old container (#5731) * refactor(Database): streamline container shutdown process and reduce timeout duration * fix(ServerCheck): enhance proxy container check to ensure it is running before proceeding * chore(seeder): update git branch from 'main' to 'v4.x' for multiple examples in ApplicationSeeder * fix(applications): include pull_request_id in deployment queue check to prevent duplicate deployments * refactor(core): streamline container stopping process and reduce timeout duration; update related methods for consistency * fix(database): update label for image input field to improve clarity * feat(migration): add 'is_migrated' and 'custom_type' columns to service_applications and service_databases tables * feat(backup): implement custom database type selection and enhance scheduled backups management * fix(ServerCheck): set default proxy status to 'exited' to handle missing container state * fix(database): reduce container stop timeout from 300 to 30 seconds for improved responsiveness * refactor(database): update DB facade usage for consistency across service files * Update app/Livewire/Project/Service/Database.php Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * refactor(database): enhance application conversion logic and add existence checks for databases and applications * refactor(actions): standardize method naming for network and configuration deletion across application and service classes * refactor(logdrain): consolidate log drain stopping logic to reduce redundancy * refactor(StandaloneMariadb): add type hint for destination method to improve code clarity * refactor(DeleteResourceJob): streamline resource deletion logic and improve conditional checks for database types * refactor(jobs): update middleware to prevent job release after expiration for CleanupInstanceStuffsJob, RestartProxyJob, and ServerCheckJob * fix(ui): system theming for charts (#5740) * chore(deps-dev): bump vite from 6.2.6 to 6.3.4 (#5743) Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 6.2.6 to 6.3.4. - [Release notes](https://github.com/vitejs/vite/releases) - [Changelog](https://github.com/vitejs/vite/blob/main/packages/vite/CHANGELOG.md) - [Commits](https://github.com/vitejs/vite/commits/v6.3.4/packages/vite) --- updated-dependencies: - dependency-name: vite dependency-version: 6.3.4 dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix(dev): mount points?! * fix(dev): proxy mount point * fix(ui): allow adding scheduled backups for non-migrated databases * fix(DatabaseBackupJob): escape PostgreSQL password in backup command (#5759) * fix(ui): correct closing div tag in service index view * Revert "fix(dev): mount points?!" This reverts commit 365bf3cbf0e5aa21a2ccb12fe6ec333b93e404da. * feat(README): add Gozunga and Macarne to sponsors list * refactor(jobs): unify middleware configuration to prevent job release after expiration for DockerCleanupJob and PushServerUpdateJob * chore(versions): update coolify version to 4.0.0-beta.417 and nightly version to 4.0.0-beta.418 * feat(redis): add scheduled cleanup command for Redis keys and enhance cleanup logic --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Jérémy <jeremy.derdaele@gmail.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Best Codes <106822363+The-Best-Codes@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: busybox <29630035+busybox11@users.noreply.github.com>
2025-05-07 21:11:45 +00:00
return [(new WithoutOverlapping($this->server->uuid))->dontRelease()];
2024-11-07 08:16:58 +00:00
}
public function __construct(public Server $server, public bool $manualCleanup = false) {}
2024-06-10 20:43:34 +00:00
2023-07-07 13:50:36 +00:00
public function handle(): void
{
try {
2024-08-14 19:53:03 +00:00
if (! $this->server->isFunctional()) {
return;
}
2024-08-14 19:53:03 +00:00
$this->execution_log = DockerCleanupExecution::create([
'server_id' => $this->server->id,
]);
$this->usageBefore = $this->server->getDiskUsage();
if ($this->manualCleanup || $this->server->settings->force_docker_cleanup) {
$cleanup_log = CleanupDocker::run(server: $this->server);
$usageAfter = $this->server->getDiskUsage();
$message = ($this->manualCleanup ? 'Manual' : 'Forced').' Docker cleanup job executed successfully. Disk usage before: '.$this->usageBefore.'%, Disk usage after: '.$usageAfter.'%.';
$this->execution_log->update([
'status' => 'success',
'message' => $message,
'cleanup_log' => $cleanup_log,
]);
$this->server->team?->notify(new DockerCleanupSuccess($this->server, $message));
event(new DockerCleanupDone($this->execution_log));
2024-09-27 14:43:07 +00:00
2024-07-18 12:38:56 +00:00
return;
}
if (str($this->usageBefore)->isEmpty() || $this->usageBefore === null || $this->usageBefore === 0) {
$cleanup_log = CleanupDocker::run(server: $this->server);
$message = 'Docker cleanup job executed successfully, but no disk usage could be determined.';
$this->execution_log->update([
'status' => 'success',
'message' => $message,
'cleanup_log' => $cleanup_log,
]);
$this->server->team?->notify(new DockerCleanupSuccess($this->server, $message));
event(new DockerCleanupDone($this->execution_log));
}
2024-08-26 10:23:03 +00:00
if ($this->usageBefore >= $this->server->settings->docker_cleanup_threshold) {
$cleanup_log = CleanupDocker::run(server: $this->server);
$usageAfter = $this->server->getDiskUsage();
$diskSaved = $this->usageBefore - $usageAfter;
if ($diskSaved > 0) {
$message = 'Saved '.$diskSaved.'% disk space. Disk usage before: '.$this->usageBefore.'%, Disk usage after: '.$usageAfter.'%.';
2023-08-29 08:00:29 +00:00
} else {
$message = 'Docker cleanup job executed successfully, but no disk space was saved. Disk usage before: '.$this->usageBefore.'%, Disk usage after: '.$usageAfter.'%.';
2023-07-07 13:50:36 +00:00
}
$this->execution_log->update([
'status' => 'success',
'message' => $message,
'cleanup_log' => $cleanup_log,
]);
$this->server->team?->notify(new DockerCleanupSuccess($this->server, $message));
event(new DockerCleanupDone($this->execution_log));
} else {
$message = 'No cleanup needed for '.$this->server->name;
$this->execution_log->update([
'status' => 'success',
'message' => $message,
]);
$this->server->team?->notify(new DockerCleanupSuccess($this->server, $message));
event(new DockerCleanupDone($this->execution_log));
2023-07-07 13:50:36 +00:00
}
} catch (\Throwable $e) {
if ($this->execution_log) {
$this->execution_log->update([
'status' => 'failed',
'message' => $e->getMessage(),
]);
event(new DockerCleanupDone($this->execution_log));
}
$this->server->team?->notify(new DockerCleanupFailed($this->server, 'Docker cleanup job failed with the following error: '.$e->getMessage()));
2023-08-24 19:09:58 +00:00
throw $e;
} finally {
if ($this->execution_log) {
$this->execution_log->update([
'finished_at' => Carbon::now()->toImmutable(),
]);
}
2023-07-07 13:50:36 +00:00
}
}
2024-08-26 10:23:03 +00:00
}