coolify/bootstrap/helpers/docker.php

564 lines
22 KiB
PHP
Raw Normal View History

2023-05-24 14:26:50 +02:00
<?php
2024-03-11 15:08:05 +01:00
use App\Enums\ProxyTypes;
2023-08-21 18:00:12 +02:00
use App\Models\Application;
2023-09-19 15:51:13 +02:00
use App\Models\ApplicationPreview;
2023-05-24 14:26:50 +02:00
use App\Models\Server;
2023-11-24 15:48:23 +01:00
use App\Models\ServiceApplication;
2023-05-24 14:26:50 +02:00
use Illuminate\Support\Collection;
2023-08-17 13:14:46 +02:00
use Illuminate\Support\Str;
2023-09-19 15:51:13 +02:00
use Spatie\Url\Url;
2023-05-24 14:26:50 +02:00
2024-02-27 09:01:19 +01:00
function getCurrentApplicationContainerStatus(Server $server, int $id, ?int $pullRequestId = null, ?bool $includePullrequests = false): Collection
2023-09-19 15:51:13 +02:00
{
$containers = collect([]);
2023-12-20 14:11:50 +01:00
if (!$server->isSwarm()) {
$containers = instant_remote_process(["docker ps -a --filter='label=coolify.applicationId={$id}' --format '{{json .}}' "], $server);
$containers = format_docker_command_output_to_json($containers);
2024-02-27 09:01:19 +01:00
$containers = $containers->map(function ($container) use ($pullRequestId, $includePullrequests) {
2023-12-20 14:11:50 +01:00
$labels = data_get($container, 'Labels');
if (!str($labels)->contains("coolify.pullRequestId=")) {
data_set($container, 'Labels', $labels . ",coolify.pullRequestId={$pullRequestId}");
return $container;
}
2024-02-27 09:01:19 +01:00
if ($includePullrequests) {
return $container;
}
2023-12-20 14:11:50 +01:00
if (str($labels)->contains("coolify.pullRequestId=$pullRequestId")) {
return $container;
}
return null;
});
$containers = $containers->filter();
return $containers;
}
return $containers;
2023-08-21 18:00:12 +02:00
}
2023-05-24 14:26:50 +02:00
function format_docker_command_output_to_json($rawOutput): Collection
{
$outputLines = explode(PHP_EOL, $rawOutput);
2023-08-21 18:00:12 +02:00
if (count($outputLines) === 1) {
$outputLines = collect($outputLines[0]);
} else {
$outputLines = collect($outputLines);
}
return $outputLines
2023-08-17 13:14:46 +02:00
->reject(fn ($line) => empty($line))
->map(fn ($outputLine) => json_decode($outputLine, true, flags: JSON_THROW_ON_ERROR));
2023-05-24 14:26:50 +02:00
}
2023-09-19 15:51:13 +02:00
function format_docker_labels_to_json(string|array $rawOutput): Collection
2023-05-24 14:26:50 +02:00
{
2023-09-12 15:47:30 +02:00
if (is_array($rawOutput)) {
return collect($rawOutput);
}
2023-05-24 14:26:50 +02:00
$outputLines = explode(PHP_EOL, $rawOutput);
return collect($outputLines)
2023-08-17 13:14:46 +02:00
->reject(fn ($line) => empty($line))
2023-05-24 14:26:50 +02:00
->map(function ($outputLine) {
$outputArray = explode(',', $outputLine);
return collect($outputArray)
->map(function ($outputLine) {
return explode('=', $outputLine);
})
->mapWithKeys(function ($outputLine) {
return [$outputLine[0] => $outputLine[1]];
});
})[0];
}
2023-08-11 16:13:53 +02:00
function format_docker_envs_to_json($rawOutput)
{
try {
$outputLines = json_decode($rawOutput, true, flags: JSON_THROW_ON_ERROR);
return collect(data_get($outputLines[0], 'Config.Env', []))->mapWithKeys(function ($env) {
$env = explode('=', $env);
return [$env[0] => $env[1]];
});
2023-09-11 17:36:30 +02:00
} catch (\Throwable $e) {
2023-08-11 16:13:53 +02:00
return collect([]);
}
}
2023-09-19 15:51:13 +02:00
function checkMinimumDockerEngineVersion($dockerVersion)
{
$majorDockerVersion = Str::of($dockerVersion)->before('.')->value();
if ($majorDockerVersion <= 22) {
$dockerVersion = null;
}
return $dockerVersion;
}
function executeInDocker(string $containerId, string $command)
{
return "docker exec {$containerId} bash -c '{$command}'";
// return "docker exec {$this->deployment_uuid} bash -c '{$command} |& tee -a /proc/1/fd/1; [ \$PIPESTATUS -eq 0 ] || exit \$PIPESTATUS'";
}
2023-08-11 16:13:53 +02:00
2023-08-21 18:00:12 +02:00
function getContainerStatus(Server $server, string $container_id, bool $all_data = false, bool $throwError = false)
2023-05-24 14:26:50 +02:00
{
2023-11-29 14:59:06 +01:00
if ($server->isSwarm()) {
$container = instant_remote_process(["docker service ls --filter 'name={$container_id}' --format '{{json .}}' "], $server, $throwError);
} else {
$container = instant_remote_process(["docker inspect --format '{{json .}}' {$container_id}"], $server, $throwError);
}
2023-05-24 14:26:50 +02:00
if (!$container) {
return 'exited';
}
$container = format_docker_command_output_to_json($container);
2023-06-02 15:15:12 +02:00
if ($all_data) {
2023-08-24 21:42:47 +02:00
return $container[0];
2023-06-02 15:15:12 +02:00
}
2023-11-29 14:59:06 +01:00
if ($server->isSwarm()) {
$replicas = data_get($container[0], 'Replicas');
$replicas = explode('/', $replicas);
$active = (int)$replicas[0];
$total = (int)$replicas[1];
if ($active === $total) {
return 'running';
} else {
return 'starting';
}
} else {
return data_get($container[0], 'State.Status', 'exited');
}
2023-05-24 14:26:50 +02:00
}
2023-05-30 15:52:17 +02:00
function generateApplicationContainerName(Application $application, $pull_request_id = 0)
2023-05-30 15:52:17 +02:00
{
$consistent_container_name = $application->settings->is_consistent_container_name_enabled;
2023-09-01 16:07:46 +02:00
$now = now()->format('Hisu');
if ($pull_request_id !== 0 && $pull_request_id !== null) {
return $application->uuid . '-pr-' . $pull_request_id;
2023-05-30 15:52:17 +02:00
} else {
if ($consistent_container_name) {
return $application->uuid;
}
2023-09-19 15:51:13 +02:00
return $application->uuid . '-' . $now;
2023-05-30 15:52:17 +02:00
}
}
function get_port_from_dockerfile($dockerfile): int|null
2023-08-11 22:41:47 +02:00
{
2023-08-17 13:14:46 +02:00
$dockerfile_array = explode("\n", $dockerfile);
$found_exposed_port = null;
foreach ($dockerfile_array as $line) {
$line_str = Str::of($line)->trim();
if ($line_str->startsWith('EXPOSE')) {
$found_exposed_port = $line_str->replace('EXPOSE', '')->trim();
break;
}
}
if ($found_exposed_port) {
return (int)$found_exposed_port->value();
2023-08-11 22:41:47 +02:00
}
return null;
2023-08-11 22:41:47 +02:00
}
2023-09-19 15:51:13 +02:00
2023-09-25 15:48:43 +02:00
function defaultLabels($id, $name, $pull_request_id = 0, string $type = 'application', $subType = null, $subId = null)
2023-09-20 15:42:41 +02:00
{
$labels = collect([]);
$labels->push('coolify.managed=true');
$labels->push('coolify.version=' . config('version'));
2023-09-21 17:48:31 +02:00
$labels->push("coolify." . $type . "Id=" . $id);
$labels->push("coolify.type=$type");
2023-09-20 15:42:41 +02:00
$labels->push('coolify.name=' . $name);
$labels->push('coolify.pullRequestId=' . $pull_request_id);
2023-09-25 15:48:43 +02:00
if ($type === 'service') {
2023-11-24 15:48:23 +01:00
$subId && $labels->push('coolify.service.subId=' . $subId);
$subType && $labels->push('coolify.service.subType=' . $subType);
2023-09-25 15:48:43 +02:00
}
2023-09-20 15:42:41 +02:00
return $labels;
}
2023-11-24 15:48:23 +01:00
function generateServiceSpecificFqdns(ServiceApplication|Application $resource, $forTraefik = false)
{
2023-11-24 15:48:23 +01:00
if ($resource->getMorphClass() === 'App\Models\ServiceApplication') {
$uuid = $resource->uuid;
$server = $resource->service->server;
$environment_variables = $resource->service->environment_variables;
$type = $resource->serviceType();
} else if ($resource->getMorphClass() === 'App\Models\Application') {
$uuid = $resource->uuid;
$server = $resource->destination->server;
$environment_variables = $resource->environment_variables;
$type = $resource->serviceType();
}
$variables = collect($environment_variables);
$payload = collect([]);
switch ($type) {
2023-11-24 15:48:23 +01:00
case $type?->contains('minio'):
$MINIO_BROWSER_REDIRECT_URL = $variables->where('key', 'MINIO_BROWSER_REDIRECT_URL')->first();
$MINIO_SERVER_URL = $variables->where('key', 'MINIO_SERVER_URL')->first();
if (is_null($MINIO_BROWSER_REDIRECT_URL) || is_null($MINIO_SERVER_URL)) {
return $payload;
}
if (is_null($MINIO_BROWSER_REDIRECT_URL?->value)) {
$MINIO_BROWSER_REDIRECT_URL?->update([
2023-11-24 15:48:23 +01:00
"value" => generateFqdn($server, 'console-' . $uuid)
]);
}
if (is_null($MINIO_SERVER_URL?->value)) {
$MINIO_SERVER_URL?->update([
2023-11-24 15:48:23 +01:00
"value" => generateFqdn($server, 'minio-' . $uuid)
]);
}
if ($forTraefik) {
$payload = collect([
$MINIO_BROWSER_REDIRECT_URL->value . ':9001',
$MINIO_SERVER_URL->value . ':9000',
]);
} else {
$payload = collect([
$MINIO_BROWSER_REDIRECT_URL->value,
$MINIO_SERVER_URL->value,
]);
}
break;
}
return $payload;
}
2024-03-11 15:08:05 +01:00
function fqdnLabelsForCaddy(string $network, string $uuid, Collection $domains, bool $is_force_https_enabled = false, $onlyPort = null, ?Collection $serviceLabels = null, ?bool $is_gzip_enabled = true, ?bool $is_stripprefix_enabled = true, ?string $service_name = null)
{
$labels = collect([]);
foreach ($domains as $loop => $domain) {
$loop = $loop;
$url = Url::fromString($domain);
$host = $url->getHost();
$path = $url->getPath();
// $stripped_path = str($path)->replaceEnd('/', '');
$schema = $url->getScheme();
$port = $url->getPort();
if (is_null($port) && !is_null($onlyPort)) {
$port = $onlyPort;
}
$labels->push("caddy_{$loop}={$schema}://{$host}");
$labels->push("caddy_{$loop}.header=-Server");
if ($serviceLabels) {
$labels->push("caddy_ingress_network={$uuid}");
if ($port) {
$labels->push("caddy_{$loop}.reverse_proxy={{upstreams $port}}");
} else {
$labels->push("caddy_{$loop}.reverse_proxy={{upstreams}}");
}
2024-03-11 15:08:05 +01:00
} else {
$labels->push("caddy_ingress_network={$network}");
if ($port) {
$labels->push("caddy_{$loop}.handle_path.{$loop}_reverse_proxy={{upstreams $port}}");
} else {
$labels->push("caddy_{$loop}.handle_path.{$loop}_reverse_proxy={{upstreams}}");
}
$labels->push("caddy_{$loop}.handle_path={$path}*");
}
if ($is_gzip_enabled) {
$labels->push("caddy_{$loop}.encode=zstd gzip");
}
if (isDev()) {
// $labels->push("caddy_{$loop}.tls=internal");
}
}
return $labels->sort();
}
function fqdnLabelsForTraefik(string $uuid, Collection $domains, bool $is_force_https_enabled = false, $onlyPort = null, ?Collection $serviceLabels = null, ?bool $is_gzip_enabled = true, ?bool $is_stripprefix_enabled = true, ?string $service_name = null)
2023-09-20 15:42:41 +02:00
{
$labels = collect([]);
$labels->push('traefik.enable=true');
2024-01-15 13:23:28 +01:00
$labels->push("traefik.http.middlewares.gzip.compress=true");
$labels->push("traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https");
$basic_auth = false;
$basic_auth_middleware = null;
$redirect = false;
$redirect_middleware = null;
if ($serviceLabels) {
$basic_auth = $serviceLabels->contains(function ($value) {
return str_contains($value, 'basicauth');
});
if ($basic_auth) {
$basic_auth_middleware = $serviceLabels
->map(function ($item) {
if (preg_match('/traefik\.http\.middlewares\.(.*?)\.basicauth\.users/', $item, $matches)) {
return $matches[1];
}
})
->filter()
->first();
}
$redirect = $serviceLabels->contains(function ($value) {
return str_contains($value, 'redirectregex');
});
if ($redirect) {
$redirect_middleware = $serviceLabels
->map(function ($item) {
if (preg_match('/traefik\.http\.middlewares\.(.*?)\.redirectregex\.regex/', $item, $matches)) {
return $matches[1];
}
})
->filter()
->first();
}
}
2023-10-18 14:14:40 +02:00
foreach ($domains as $loop => $domain) {
2023-12-28 17:53:47 +01:00
try {
// $uuid = new Cuid2(7);
2023-12-28 17:53:47 +01:00
$url = Url::fromString($domain);
$host = $url->getHost();
$path = $url->getPath();
$schema = $url->getScheme();
$port = $url->getPort();
if (is_null($port) && !is_null($onlyPort)) {
$port = $onlyPort;
}
$http_label = "http-{$loop}-{$uuid}";
$https_label = "https-{$loop}-{$uuid}";
if ($service_name) {
$http_label = "http-{$loop}-{$uuid}-{$service_name}";
$https_label = "https-{$loop}-{$uuid}-{$service_name}";
}
2023-09-20 15:42:41 +02:00
2023-12-28 17:53:47 +01:00
if ($schema === 'https') {
// Set labels for https
$labels->push("traefik.http.routers.{$https_label}.rule=Host(`{$host}`) && PathPrefix(`{$path}`)");
$labels->push("traefik.http.routers.{$https_label}.entryPoints=https");
if ($port) {
$labels->push("traefik.http.routers.{$https_label}.service={$https_label}");
$labels->push("traefik.http.services.{$https_label}.loadbalancer.server.port=$port");
}
if ($path !== '/') {
if ($is_stripprefix_enabled) {
$labels->push("traefik.http.middlewares.{$https_label}-stripprefix.stripprefix.prefixes={$path}");
$middlewares = collect(["{$https_label}-stripprefix"]);
}
if ($is_gzip_enabled) {
$middlewares->push('gzip');
}
if ($basic_auth && $basic_auth_middleware) {
$middlewares->push($basic_auth_middleware);
}
if ($redirect && $redirect_middleware) {
$middlewares->push($redirect_middleware);
}
if ($middlewares->isNotEmpty()) {
$middlewares = $middlewares->join(',');
$labels->push("traefik.http.routers.{$https_label}.middlewares={$middlewares}");
}
2024-01-15 12:12:34 +01:00
} else {
$middlewares = collect([]);
if ($is_gzip_enabled) {
$middlewares->push('gzip');
}
if ($basic_auth && $basic_auth_middleware) {
$middlewares->push($basic_auth_middleware);
}
if ($redirect && $redirect_middleware) {
$middlewares->push($redirect_middleware);
}
if ($middlewares->isNotEmpty()) {
$middlewares = $middlewares->join(',');
$labels->push("traefik.http.routers.{$https_label}.middlewares={$middlewares}");
}
2023-12-28 17:53:47 +01:00
}
$labels->push("traefik.http.routers.{$https_label}.tls=true");
$labels->push("traefik.http.routers.{$https_label}.tls.certresolver=letsencrypt");
// Set labels for http (redirect to https)
$labels->push("traefik.http.routers.{$http_label}.rule=Host(`{$host}`) && PathPrefix(`{$path}`)");
$labels->push("traefik.http.routers.{$http_label}.entryPoints=http");
2024-01-09 12:29:45 +01:00
if ($port) {
$labels->push("traefik.http.services.{$http_label}.loadbalancer.server.port=$port");
$labels->push("traefik.http.routers.{$http_label}.service={$http_label}");
2024-01-09 12:29:45 +01:00
}
2023-12-28 17:53:47 +01:00
if ($is_force_https_enabled) {
$labels->push("traefik.http.routers.{$http_label}.middlewares=redirect-to-https");
}
} else {
// Set labels for http
$labels->push("traefik.http.routers.{$http_label}.rule=Host(`{$host}`) && PathPrefix(`{$path}`)");
$labels->push("traefik.http.routers.{$http_label}.entryPoints=http");
if ($port) {
$labels->push("traefik.http.services.{$http_label}.loadbalancer.server.port=$port");
$labels->push("traefik.http.routers.{$http_label}.service={$http_label}");
2023-12-28 17:53:47 +01:00
}
if ($path !== '/') {
if ($is_stripprefix_enabled) {
$labels->push("traefik.http.middlewares.{$http_label}-stripprefix.stripprefix.prefixes={$path}");
$middlewares = collect(["{$http_label}-stripprefix"]);
}
if ($is_gzip_enabled) {
$middlewares->push('gzip');
}
if ($basic_auth && $basic_auth_middleware) {
$middlewares->push($basic_auth_middleware);
}
if ($redirect && $redirect_middleware) {
$middlewares->push($redirect_middleware);
}
if ($middlewares->isNotEmpty()) {
$middlewares = $middlewares->join(',');
$labels->push("traefik.http.routers.{$http_label}.middlewares={$middlewares}");
}
2024-01-15 12:12:34 +01:00
} else {
$middlewares = collect([]);
if ($is_gzip_enabled) {
$middlewares->push('gzip');
}
if ($basic_auth && $basic_auth_middleware) {
$middlewares->push($basic_auth_middleware);
}
if ($redirect && $redirect_middleware) {
$middlewares->push($redirect_middleware);
}
if ($middlewares->isNotEmpty()) {
$middlewares = $middlewares->join(',');
$labels->push("traefik.http.routers.{$http_label}.middlewares={$middlewares}");
}
2023-12-28 17:53:47 +01:00
}
}
2024-01-09 12:29:45 +01:00
} catch (\Throwable $e) {
2023-12-28 17:53:47 +01:00
continue;
2023-09-20 15:42:41 +02:00
}
}
return $labels->sort();
2023-09-20 15:42:41 +02:00
}
function generateLabelsApplication(Application $application, ?ApplicationPreview $preview = null): array
2023-09-19 15:51:13 +02:00
{
$ports = $application->settings->is_static ? [80] : $application->ports_exposes_array;
$onlyPort = null;
2024-01-09 12:29:45 +01:00
if (count($ports) > 0) {
$onlyPort = $ports[0];
}
2023-09-19 15:51:13 +02:00
$pull_request_id = data_get($preview, 'pull_request_id', 0);
$appUuid = $application->uuid;
if ($pull_request_id !== 0) {
$appUuid = $appUuid . '-pr-' . $pull_request_id;
2023-09-19 15:51:13 +02:00
}
2023-09-20 15:42:41 +02:00
$labels = collect([]);
2023-09-19 15:51:13 +02:00
if ($application->fqdn) {
if ($pull_request_id !== 0) {
$domains = Str::of(data_get($preview, 'fqdn'))->explode(',');
} else {
$domains = Str::of(data_get($application, 'fqdn'))->explode(',');
}
2024-03-11 15:08:05 +01:00
// Add Traefik labels
$labels = $labels->merge(fqdnLabelsForTraefik(
uuid: $appUuid,
domains: $domains,
onlyPort: $onlyPort,
is_force_https_enabled: $application->isForceHttpsEnabled(),
is_gzip_enabled: $application->isGzipEnabled(),
is_stripprefix_enabled: $application->isStripprefixEnabled()
));
2024-03-11 15:08:05 +01:00
// Add Caddy labels
$labels = $labels->merge(fqdnLabelsForCaddy(
network: $application->destination->network,
uuid: $appUuid,
domains: $domains,
onlyPort: $onlyPort,
is_force_https_enabled: $application->isForceHttpsEnabled(),
is_gzip_enabled: $application->isGzipEnabled(),
is_stripprefix_enabled: $application->isStripprefixEnabled()
));
2023-09-19 15:51:13 +02:00
}
2023-09-20 15:42:41 +02:00
return $labels->all();
2023-09-19 15:51:13 +02:00
}
2023-11-28 14:27:38 +01:00
function isDatabaseImage(?string $image = null)
{
2023-11-28 14:27:38 +01:00
if (is_null($image)) {
return false;
}
$image = str($image);
if ($image->contains(':')) {
$image = str($image);
} else {
$image = str($image)->append(':latest');
}
$imageName = $image->before(':');
if (collect(DATABASE_DOCKER_IMAGES)->contains($imageName)) {
return true;
}
return false;
}
function convert_docker_run_to_compose(?string $custom_docker_run_options = null)
{
$options = [];
$compose_options = collect([]);
preg_match_all('/(--\w+(?:-\w+)*)(?:\s|=)?([^\s-]+)?/', $custom_docker_run_options, $matches, PREG_SET_ORDER);
$list_options = collect([
'--cap-add',
'--cap-drop',
'--security-opt',
'--sysctl',
'--ulimit',
2024-02-25 23:13:27 +01:00
'--device',
]);
$mapping = collect([
'--cap-add' => 'cap_add',
'--cap-drop' => 'cap_drop',
'--security-opt' => 'security_opt',
'--sysctl' => 'sysctls',
'--ulimit' => 'ulimits',
2024-02-14 08:42:47 +01:00
'--device' => 'devices',
'--init' => 'init',
'--ulimit' => 'ulimits',
'--privileged' => 'privileged',
2024-02-25 23:13:27 +01:00
'--ip' => 'ip',
]);
foreach ($matches as $match) {
$option = $match[1];
2024-02-14 08:42:47 +01:00
if (isset($match[2]) && $match[2] !== '') {
$value = $match[2];
$options[$option][] = $value;
$options[$option] = array_unique($options[$option]);
} else {
$value = true;
$options[$option] = $value;
}
}
$options = collect($options);
// Easily get mappings from https://github.com/composerize/composerize/blob/master/packages/composerize/src/mappings.js
foreach ($options as $option => $value) {
if (!data_get($mapping, $option)) {
continue;
}
if ($option === '--ulimit') {
$ulimits = collect([]);
2024-02-09 13:38:17 +01:00
collect($value)->map(function ($ulimit) use ($ulimits) {
$ulimit = explode('=', $ulimit);
$type = $ulimit[0];
$limits = explode(':', $ulimit[1]);
if (count($limits) == 2) {
$soft_limit = $limits[0];
$hard_limit = $limits[1];
$ulimits->put($type, [
'soft' => $soft_limit,
'hard' => $hard_limit
]);
} else {
$soft_limit = $ulimit[1];
$ulimits->put($type, [
'soft' => $soft_limit,
]);
}
});
$compose_options->put($mapping[$option], $ulimits);
} else {
if ($list_options->contains($option)) {
if ($compose_options->has($mapping[$option])) {
$compose_options->put($mapping[$option], $options->get($mapping[$option]) . ',' . $value);
} else {
$compose_options->put($mapping[$option], $value);
}
continue;
} else {
$compose_options->put($mapping[$option], $value);
continue;
}
$compose_options->forget($option);
}
}
return $compose_options->toArray();
}