prehistoric-systems/coolify
1
0
Fork 0
mirror of https://github.com/coollabsio/coolify.git synced 2026-03-11 08:55:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

new ValidateServer file with all validation logic in one place

Browse source
This commit is contained in:
peaklabs-dev 2024-11-27 17:45:42 +01:00
parent 87cde8bf1e
commit e6019e0a1e
No known key found for this signature in database
1 changed files with 177 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

232
app/Actions/Server/ValidateServer.php
View file

@ -3,67 +3,189 @@
namespace App\Actions\Server;
use App\Models\Server;
use Lorisleiva\Actions\Concerns\AsAction;
use Exception;
class ValidateServer
{
use AsAction;
public string $jobQueue = 'high';
public ?string $uptime = null;
public ?string $error = null;
public ?string $supported_os_type = null;
public ?string $docker_installed = null;
public ?string $docker_compose_installed = null;
public ?string $docker_version = null;
public function handle(Server $server)
public function validateConnection(Server $server, bool $justCheckingNewKey = false): array
{
$server->update([
'validation_logs' => null,
]);
['uptime' => $this->uptime, 'error' => $error] = $server->validateConnection();
if (! $this->uptime) {
$this->error = 'Server is not reachable. Please validate your configuration and connection.<br>Check this <a target="_blank" class="text-black underline dark:text-white" href="https://coolify.io/docs/knowledge-base/server/openssh">documentation</a> for further help. <br><br><div class="text-error">Error: '.$error.'</div>';
$server->update([
'validation_logs' => $this->error,
]);
throw new \Exception($this->error);
}
$this->supported_os_type = $server->validateOS();
if (! $this->supported_os_type) {
$this->error = 'Server OS type is not supported. Please install Docker manually before continuing: <a target="_blank" class="text-black underline dark:text-white" href="https://docs.docker.com/engine/install/#server">documentation</a>.';
$server->update([
'validation_logs' => $this->error,
]);
throw new \Exception($this->error);
}
config()->set('constants.ssh.mux_enabled', false);
$this->docker_installed = $server->validateDockerEngine();
$this->docker_compose_installed = $server->validateDockerCompose();
if (! $this->docker_installed || ! $this->docker_compose_installed) {
$this->error = 'Docker Engine is not installed. Please install Docker manually before continuing: <a target="_blank" class="text-black underline dark:text-white" href="https://docs.docker.com/engine/install/#server">documentation</a>.';
$server->update([
'validation_logs' => $this->error,
]);
throw new \Exception($this->error);
}
$this->docker_version = $server->validateDockerEngineVersion();
try {
instant_remote_process(['ls /'], $server);
if ($server->settings->is_reachable === false) {
$server->settings->is_reachable = true;
$server->settings->save();
}
if ($this->docker_version) {
return 'OK';
} else {
$this->error = 'Docker Engine is not installed. Please install Docker manually before continuing: <a target="_blank" class="text-black underline dark:text-white" href="https://docs.docker.com/engine/install/#server">documentation</a>.';
$server->update([
'validation_logs' => $this->error,
]);
throw new \Exception($this->error);
$server->update(['validation_logs' => null]);
return ['uptime' => true, 'error' => null];
} catch (\Throwable $e) {
if ($justCheckingNewKey) {
return ['uptime' => false, 'error' => __('server.key_not_valid')];
}
if ($server->settings->is_reachable === true) {
$server->settings->is_reachable = false;
$server->settings->save();
}
$errorMessage = __('server.not_reachable').'<br><br><div class="text-error">Error: '.$e->getMessage().'</div>';
$server->update(['validation_logs' => $errorMessage]);
return ['uptime' => false, 'error' => $e->getMessage()];
}
}
public function validateOS(Server $server): array
{
try {
$os_release = instant_remote_process(['cat /etc/os-release'], $server);
$releaseLines = collect(explode("\n", $os_release));
$collectedData = $releaseLines->reduce(function ($carry, $line) {
$item = str($line)->trim();
$key = $item->before('=')->value();
$value = $item->after('=')->lower()->replace('"', '')->value();
$carry[$key] = $value;
return $carry;
}, []);
$ID = data_get($collectedData, 'ID');
$supported = collect(SUPPORTED_OS)
->first(fn ($supportedOs) => str($supportedOs)->contains($ID));
if (! $supported) {
$errorMessage = __('server.os_not_supported');
$server->update(['validation_logs' => $errorMessage]);
return ['supported' => false, 'error' => $errorMessage];
}
return ['supported' => true, 'os_type' => str($supported), 'error' => null];
} catch (\Exception $e) {
$errorMessage = __('server.os_check_failed');
$server->update(['validation_logs' => $errorMessage]);
return ['supported' => false, 'error' => $errorMessage];
}
}
public function validateDockerEngine(Server $server, bool $throwError = false): array
{
try {
$dockerBinary = instant_remote_process(['command -v docker'], $server, false, no_sudo: true);
if (is_null($dockerBinary)) {
$server->settings->is_usable = false;
$server->settings->save();
$errorMessage = __('server.docker_not_installed');
$server->update(['validation_logs' => $errorMessage]);
return ['installed' => false, 'error' => $errorMessage];
}
instant_remote_process(['docker version'], $server);
$server->settings->is_usable = true;
$server->settings->save();
$this->validateCoolifyNetwork($server);
return ['installed' => true, 'error' => null];
} catch (\Throwable $e) {
$server->settings->is_usable = false;
$server->settings->save();
$errorMessage = __('server.docker_not_running');
$server->update(['validation_logs' => $errorMessage]);
return ['installed' => false, 'error' => $errorMessage];
}
}
public function validateDockerCompose(Server $server): array
{
try {
$dockerCompose = instant_remote_process(['docker compose version'], $server, false);
if (is_null($dockerCompose)) {
$server->settings->is_usable = false;
$server->settings->save();
$errorMessage = __('server.docker_compose_not_installed');
$server->update(['validation_logs' => $errorMessage]);
return ['installed' => false, 'error' => $errorMessage];
}
$server->settings->is_usable = true;
$server->settings->save();
return ['installed' => true, 'error' => null];
} catch (\Throwable $e) {
$errorMessage = __('server.docker_compose_check_failed');
$server->update(['validation_logs' => $errorMessage]);
return ['installed' => false, 'error' => $errorMessage];
}
}
public function validateDockerEngineVersion(Server $server): array
{
try {
$dockerVersionRaw = instant_remote_process(['docker version --format json'], $server, false);
$dockerVersionJson = json_decode($dockerVersionRaw, true);
$dockerVersion = data_get($dockerVersionJson, 'Server.Version', '0.0.0');
$dockerVersion = checkMinimumDockerEngineVersion($dockerVersion);
if (is_null($dockerVersion)) {
$server->settings->is_usable = false;
$server->settings->save();
$errorMessage = __('server.docker_engine_not_installed');
$server->update(['validation_logs' => $errorMessage]);
return ['valid' => false, 'error' => $errorMessage];
}
$server->settings->is_reachable = true;
$server->settings->is_usable = true;
$server->settings->save();
return ['valid' => true, 'error' => null];
} catch (\Throwable $e) {
$errorMessage = __('server.docker_version_check_failed');
$server->update(['validation_logs' => $errorMessage]);
return ['valid' => false, 'error' => $errorMessage];
}
}
public function validateCoolifyNetwork(Server $server, bool $isSwarm = false, bool $isBuildServer = false): ?bool
{
if ($isBuildServer) {
return null;
}
if ($isSwarm) {
return instant_remote_process(['docker network create --attachable --driver overlay coolify-overlay >/dev/null 2>&1 || true'], $server, false);
} else {
return instant_remote_process(['docker network create coolify --attachable >/dev/null 2>&1 || true'], $server, false);
}
}
public function validateDockerSwarm(Server $server): bool
{
$swarmStatus = instant_remote_process(['docker info|grep -i swarm'], $server, false);
$swarmStatus = str($swarmStatus)->trim()->after(':')->trim();
if ($swarmStatus === 'inactive') {
throw new Exception(__('server.swarm_not_initiated'));
}
$server->settings->is_usable = true;
$server->settings->save();
$this->validateCoolifyNetwork($server, isSwarm: true);
return true;
}
}