coolify/bootstrap/helpers/remoteProcess.php

151 lines
5.1 KiB
PHP
Raw Normal View History

2023-05-24 14:26:50 +02:00
<?php
2023-05-24 15:25:08 +02:00
use App\Actions\CoolifyTask\PrepareCoolifyTask;
2023-05-24 14:26:50 +02:00
use App\Data\CoolifyTaskArgs;
2023-05-25 14:40:47 +02:00
use App\Enums\ActivityTypes;
2023-06-30 15:57:40 +02:00
use App\Models\Application;
use App\Models\ApplicationDeploymentQueue;
2023-05-24 14:26:50 +02:00
use App\Models\Server;
2023-06-30 15:57:40 +02:00
use Carbon\Carbon;
2023-05-24 14:26:50 +02:00
use Illuminate\Database\Eloquent\Model;
2023-06-30 15:57:40 +02:00
use Illuminate\Support\Collection;
2023-05-24 14:26:50 +02:00
use Illuminate\Support\Facades\Process;
use Illuminate\Support\Facades\Storage;
2023-05-31 12:38:36 +02:00
use Illuminate\Support\Sleep;
2023-05-24 14:26:50 +02:00
use Spatie\Activitylog\Models\Activity;
2023-05-24 15:25:08 +02:00
/**
* Run a Remote Process, which SSH's asynchronously into a machine to run the command(s).
* @TODO Change 'root' to 'coolify' when it's able to run Docker commands without sudo
*
*/
function remote_process(
array $command,
Server $server,
2023-05-25 14:40:47 +02:00
string $type = ActivityTypes::INLINE->value,
2023-05-24 15:25:08 +02:00
?string $type_uuid = null,
?Model $model = null,
2023-06-30 22:24:39 +02:00
bool $ignore_errors = false,
2023-05-24 15:25:08 +02:00
): Activity {
2023-05-24 14:26:50 +02:00
2023-05-24 15:25:08 +02:00
$command_string = implode("\n", $command);
2023-06-30 22:24:39 +02:00
if (auth()->user()) {
$teams = auth()->user()->teams->pluck('id');
if (!$teams->contains($server->team_id) && !$teams->contains(0)) {
throw new \Exception("User is not part of the team that owns this server");
}
}
2023-05-24 14:26:50 +02:00
2023-05-24 15:25:08 +02:00
$private_key_location = save_private_key_for_server($server);
2023-05-24 14:26:50 +02:00
2023-05-24 15:25:08 +02:00
return resolve(PrepareCoolifyTask::class, [
'remoteProcessArgs' => new CoolifyTaskArgs(
server_ip: $server->ip,
private_key_location: $private_key_location,
command: <<<EOT
2023-05-24 14:26:50 +02:00
{$command_string}
EOT,
2023-05-24 15:25:08 +02:00
port: $server->port,
user: $server->user,
type: $type,
type_uuid: $type_uuid,
model: $model,
2023-06-07 15:39:08 +02:00
ignore_errors: $ignore_errors
2023-05-24 15:25:08 +02:00
),
])();
2023-05-24 14:26:50 +02:00
}
2023-06-30 15:57:40 +02:00
function get_private_key_for_server(Server $server)
{
$temp_file = "id.root@{$server->ip}";
return '/var/www/html/storage/app/ssh/keys/' . $temp_file;
}
2023-05-24 15:25:08 +02:00
function save_private_key_for_server(Server $server)
{
2023-06-07 10:33:45 +02:00
if (data_get($server, 'privateKey.private_key') === null) {
2023-06-15 13:51:31 +02:00
$server->settings->is_reachable = false;
2023-06-07 10:33:45 +02:00
$server->settings->save();
throw new \Exception("Server {$server->name} does not have a private key");
}
2023-05-24 15:25:08 +02:00
$temp_file = "id.root@{$server->ip}";
2023-05-25 12:55:34 +02:00
Storage::disk('ssh-keys')->put($temp_file, $server->privateKey->private_key);
Storage::disk('ssh-mux')->makeDirectory('.');
return '/var/www/html/storage/app/ssh/keys/' . $temp_file;
2023-05-24 14:26:50 +02:00
}
2023-05-24 15:25:08 +02:00
function generate_ssh_command(string $private_key_location, string $server_ip, string $user, string $port, string $command, bool $isMux = true)
{
$delimiter = 'EOF-COOLIFY-SSH';
$ssh_command = "ssh ";
2023-05-24 14:26:50 +02:00
2023-05-24 15:25:08 +02:00
if ($isMux && config('coolify.mux_enabled')) {
2023-05-25 12:55:34 +02:00
$ssh_command .= '-o ControlMaster=auto -o ControlPersist=1m -o ControlPath=/var/www/html/storage/app/ssh/mux/%h_%p_%r ';
2023-05-24 14:26:50 +02:00
}
2023-05-24 15:25:08 +02:00
$ssh_command .= "-i {$private_key_location} "
. '-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null '
. '-o PasswordAuthentication=no '
. '-o ConnectTimeout=3600 '
. '-o ServerAliveInterval=20 '
. '-o RequestTTY=no '
. '-o LogLevel=ERROR '
. "-p {$port} "
. "{$user}@{$server_ip} "
. " 'bash -se' << \\$delimiter" . PHP_EOL
. $command . PHP_EOL
. $delimiter;
return $ssh_command;
2023-05-24 14:26:50 +02:00
}
2023-05-31 12:38:36 +02:00
function instant_remote_process(array $command, Server $server, $throwError = true, $repeat = 1)
2023-05-24 15:25:08 +02:00
{
$command_string = implode("\n", $command);
$private_key_location = save_private_key_for_server($server);
$ssh_command = generate_ssh_command($private_key_location, $server->ip, $server->user, $server->port, $command_string);
$process = Process::run($ssh_command);
$output = trim($process->output());
$exitCode = $process->exitCode();
if ($exitCode !== 0) {
2023-05-31 12:38:36 +02:00
if ($repeat > 1) {
Sleep::for(200)->milliseconds();
ray('executing again');
return instant_remote_process($command, $server, $throwError, $repeat - 1);
}
2023-06-07 10:33:45 +02:00
// ray('ERROR OCCURED: ' . $process->errorOutput());
2023-05-24 15:25:08 +02:00
if (!$throwError) {
return null;
2023-05-24 14:26:50 +02:00
}
2023-05-24 15:25:08 +02:00
throw new \RuntimeException($process->errorOutput());
2023-05-24 14:26:50 +02:00
}
2023-05-24 15:25:08 +02:00
return $output;
2023-05-24 14:26:50 +02:00
}
2023-06-30 15:57:40 +02:00
function decode_remote_command_output(?ApplicationDeploymentQueue $application_deployment_queue = null): Collection
{
$application = Application::find(data_get($application_deployment_queue, 'application_id'));
$is_debug_enabled = data_get($application, 'settings.is_debug_enabled');
if (is_null($application_deployment_queue)) {
return collect([]);
}
try {
$decoded = json_decode(
2023-06-30 21:22:14 +02:00
data_get($application_deployment_queue, 'logs'),
2023-06-30 15:57:40 +02:00
associative: true,
flags: JSON_THROW_ON_ERROR
);
} catch (\JsonException $exception) {
return collect([]);
}
$formatted = collect($decoded);
if (!$is_debug_enabled) {
2023-06-30 21:22:14 +02:00
$formatted = $formatted->filter(fn ($i) => $i['hidden'] === false ?? false);
2023-06-30 15:57:40 +02:00
}
2023-06-30 21:22:14 +02:00
$formatted = $formatted
->sortBy(fn ($i) => $i['order'])
2023-06-30 15:57:40 +02:00
->map(function ($i) {
$i['timestamp'] = Carbon::parse($i['timestamp'])->format('Y-M-d H:i:s.u');
return $i;
});
return $formatted;
}