Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

AIO-interface: add Unhealthy container state #5307

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+75 −101
Open

AIO-interface: add Unhealthy container state #5307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b9f9d2
Add unhealthy state
docjyJ Oct 8, 2024
ea84e2a
Update State
docjyJ Oct 9, 2024
41031cb
rollback
docjyJ Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions php/src/Container/Container.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use AIO\Data\ConfigurationManager;
use AIO\Docker\DockerActionManager;
use AIO\ContainerDefinitionFetcher;
use GuzzleHttp\Exception\GuzzleException;

readonly class Container {
public function __construct(
Expand Down Expand Up @@ -112,22 +113,15 @@ public function GetVolumes() : ContainerVolumes {
return $this->volumes;
}

/** @throws GuzzleException */
public function GetRunningState() : ContainerState {
return $this->dockerActionManager->GetContainerRunningState($this);
}

public function GetRestartingState() : ContainerState {
return $this->dockerActionManager->GetContainerRestartingState($this);
}

public function GetUpdateState() : VersionState {
public function GetUpdateState() : UpdateState {
return $this->dockerActionManager->GetContainerUpdateState($this);
}

public function GetStartingState() : ContainerState {
return $this->dockerActionManager->GetContainerStartingState($this);
}

/**
* @return string[]
*/
Expand Down
4 changes: 2 additions & 2 deletions php/src/Container/ContainerState.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
namespace AIO\Container;

enum ContainerState: string {
case ImageDoesNotExist = 'image_does_not_exist';
case NotRestarting = 'not_restarting';
case DoesNotExist = 'does_not_exist';
case Restarting = 'restarting';
case Running = 'running';
case Starting = 'starting';
case Stopped = 'stopped';
case Unhealthy = 'unhealthy';
}
8 changes: 8 additions & 0 deletions php/src/Container/UpdateState.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

namespace AIO\Container;

enum UpdateState: string {
case Outdated = 'outdated';
case Latest = 'latest';
}
8 changes: 0 additions & 8 deletions php/src/Container/VersionState.php
View file
Open in desktop

This file was deleted.

114 changes: 39 additions & 75 deletions php/src/Docker/DockerActionManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
namespace AIO\Docker;

use AIO\Container\Container;
use AIO\Container\VersionState;
use AIO\Container\UpdateState;
use AIO\Container\ContainerState;
use AIO\Data\ConfigurationManager;
use AssertionError;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
use GuzzleHttp\Exception\RequestException;
use AIO\ContainerDefinitionFetcher;
use http\Env\Response;
Expand Down Expand Up @@ -35,98 +37,62 @@ private function BuildImageName(Container $container) : string {
return $container->GetContainerName() . ':' . $tag;
}

public function GetContainerRunningState(Container $container) : ContainerState
{
/** @throws GuzzleException */
public function GetContainerRunningState(Container $container): ContainerState {
$url = $this->BuildApiUrl(sprintf('containers/%s/json', urlencode($container->GetIdentifier())));
try {
$response = $this->guzzleClient->get($url);
} catch (RequestException $e) {
} catch (GuzzleException $e) {
if ($e->getCode() === 404) {
return ContainerState::ImageDoesNotExist;
return ContainerState::DoesNotExist;
}
throw $e;
}

$responseBody = json_decode((string)$response->getBody(), true);

if ($responseBody['State']['Running'] === true) {
return ContainerState::Running;
$body = json_decode($response->getBody()->getContents(), true);
assert(is_array($body));
assert(is_array($body['State']));

$state = match ($body['State']['Status']) {
'running' => ContainerState::Running,
'created' => ContainerState::Starting,
'restarting' => ContainerState::Restarting,
'paused', 'removing', 'exited', 'dead' => ContainerState::Stopped,
default => throw new AssertionError()
};

if ($state === ContainerState::Running && is_array($body['State']['Health'])) {
return match ($body['State']['Health']['Status']) {
'starting' => ContainerState::Starting,
'unhealthy' => ContainerState::Unhealthy,
default => ContainerState::Running,
};
} else {
return ContainerState::Stopped;
return $state;
}
}

public function GetContainerRestartingState(Container $container) : ContainerState
{
$url = $this->BuildApiUrl(sprintf('containers/%s/json', urlencode($container->GetIdentifier())));
try {
$response = $this->guzzleClient->get($url);
} catch (RequestException $e) {
if ($e->getCode() === 404) {
return ContainerState::ImageDoesNotExist;
}
throw $e;
}

$responseBody = json_decode((string)$response->getBody(), true);

if ($responseBody['State']['Restarting'] === true) {
return ContainerState::Restarting;
} else {
return ContainerState::NotRestarting;
}
}

public function GetContainerUpdateState(Container $container) : VersionState
{
public function GetContainerUpdateState(Container $container): UpdateState {
$tag = $container->GetImageTag();
if ($tag === '%AIO_CHANNEL%') {
$tag = $this->GetCurrentChannel();
}

$runningDigests = $this->GetRepoDigestsOfContainer($container->GetIdentifier());
if ($runningDigests === null) {
return VersionState::Different;
return UpdateState::Outdated;
}
$remoteDigest = $this->dockerHubManager->GetLatestDigestOfTag($container->GetContainerName(), $tag);
if ($remoteDigest === null) {
return VersionState::Equal;
return UpdateState::Latest;
}

foreach($runningDigests as $runningDigest) {
foreach ($runningDigests as $runningDigest) {
if ($runningDigest === $remoteDigest) {
return VersionState::Equal;
return UpdateState::Latest;
}
}
return VersionState::Different;
}

public function GetContainerStartingState(Container $container) : ContainerState
{
$runningState = $this->GetContainerRunningState($container);
if ($runningState === ContainerState::Stopped || $runningState === ContainerState::ImageDoesNotExist) {
return $runningState;
}

$containerName = $container->GetIdentifier();
$internalPort = $container->GetInternalPort();
if($internalPort === '%APACHE_PORT%') {
$internalPort = $this->configurationManager->GetApachePort();
} elseif($internalPort === '%TALK_PORT%') {
$internalPort = $this->configurationManager->GetTalkPort();
}

if ($internalPort !== "" && $internalPort !== 'host') {
$connection = @fsockopen($containerName, (int)$internalPort, $errno, $errstr, 0.2);
if ($connection) {
fclose($connection);
return ContainerState::Running;
} else {
return ContainerState::Starting;
}
} else {
return ContainerState::Running;
}
return UpdateState::Outdated;
}

public function DeleteContainer(Container $container) : void {
Expand Down Expand Up @@ -614,12 +580,11 @@ public function PullImage(Container $container) : void
}
}

private function isContainerUpdateAvailable(string $id) : string
{
private function isContainerUpdateAvailable(string $id): string {
$container = $this->containerDefinitionFetcher->GetContainerById($id);

$updateAvailable = "";
if ($container->GetUpdateState() === VersionState::Different) {
if ($container->GetUpdateState() === UpdateState::Outdated) {
$updateAvailable = '1';
}
foreach ($container->GetDependsOn() as $dependency) {
Expand Down Expand Up @@ -778,9 +743,8 @@ public function IsMastercontainerUpdateAvailable() : bool
return true;
}

public function sendNotification(Container $container, string $subject, string $message, string $file = '/notify.sh') : void
{
if ($this->GetContainerStartingState($container) === ContainerState::Running) {
public function sendNotification(Container $container, string $subject, string $message, string $file = '/notify.sh'): void {
if ($this->GetContainerRunningState($container) === ContainerState::Running) {

$containerName = $container->GetIdentifier();

Expand Down Expand Up @@ -961,16 +925,16 @@ public function GetDatabasecontainerExitCode() : int
}
}

public function isLoginAllowed() : bool {
public function isLoginAllowed(): bool {
$id = 'nextcloud-aio-apache';
$apacheContainer = $this->containerDefinitionFetcher->GetContainerById($id);
if ($this->GetContainerStartingState($apacheContainer) === ContainerState::Running) {
if ($this->GetContainerRunningState($apacheContainer) === ContainerState::Running) {
return false;
}
return true;
}

public function isBackupContainerRunning() : bool {
public function isBackupContainerRunning(): bool {
$id = 'nextcloud-aio-borgbackup';
$backupContainer = $this->containerDefinitionFetcher->GetContainerById($id);
if ($this->GetContainerRunningState($backupContainer) === ContainerState::Running) {
Expand Down
30 changes: 23 additions & 7 deletions php/templates/containers.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,20 @@
{% endif %}

{% for container in containers %}
{% if container.GetDisplayName() != '' and container.GetRunningState().value == 'running' %}
{% set runingState = container.GetRunningState().value %}
{% if container.GetDisplayName() != '' and runingState in ['running', 'unhealthy', 'starting'] %}
{% set isAnyRunning = true %}
{% endif %}
{% if container.GetDisplayName() != '' and container.GetRestartingState().value == 'restarting' %}
{% if container.GetDisplayName() != '' and runingState == 'restarting' %}
{% set isAnyRestarting = true %}
{% endif %}
{% if container.GetIdentifier() == 'nextcloud-aio-watchtower' and container.GetRunningState().value == 'running' %}
{% if container.GetIdentifier() == 'nextcloud-aio-watchtower' and runingState in ['running', 'unhealthy', 'starting'] %}
{% set isWatchtowerRunning = true %}
{% endif %}
{% if container.GetIdentifier() == 'nextcloud-aio-domaincheck' and container.GetRunningState().value == 'running' %}
{% if container.GetIdentifier() == 'nextcloud-aio-domaincheck' and runingState in ['running', 'unhealthy', 'starting'] %}
{% set isDomaincheckRunning = true %}
{% endif %}
{% if container.GetIdentifier() == 'nextcloud-aio-apache' and container.GetStartingState().value == 'starting' %}
{% if container.GetIdentifier() == 'nextcloud-aio-apache' and runingState == 'starting' %}
{% set isApacheStarting = true %}
{% endif %}
{% endfor %}
Expand Down Expand Up @@ -261,14 +262,29 @@
{% for container in containers %}
{% if container.GetDisplayName() != '' %}
<li>
{% if container.GetStartingState().value == 'starting' %}
{% set runningState = container.GetRunningState().value %}
{% if runningState == 'starting' %}
<span class="status running"></span>
<span>{{ container.GetDisplayName() }} (<a href="/api/docker/logs?id={{ container.GetIdentifier() }}" target="_blank" rel="noopener">Starting</a>)
{% if container.GetDocumentation() != '' %}
(<a href="{{ container.GetDocumentation() }}">docs</a>)
{% endif %}
</span>
{% elseif container.GetRunningState().value == 'running' %}
{% elseif runningState == 'unhealthy' %}
<span class="status running"></span>
<span>{{ container.GetDisplayName() }} (<a href="/api/docker/logs?id={{ container.GetIdentifier() }}" target="_blank" rel="noopener">Unhealthy</a>)
{% if container.GetDocumentation() != '' %}
(<a href="{{ container.GetDocumentation() }}">docs</a>)
{% endif %}
</span>
{% elseif runningState == 'restarting' %}
<span class="status running"></span>
<span>{{ container.GetDisplayName() }} (<a href="/api/docker/logs?id={{ container.GetIdentifier() }}" target="_blank" rel="noopener">Restarting</a>)
{% if container.GetDocumentation() != '' %}
(<a href="{{ container.GetDocumentation() }}">docs</a>)
{% endif %}
</span>
{% elseif runningState == 'running' %}
<span class="status success"></span>
<span>{{ container.GetDisplayName() }} (<a href="/api/docker/logs?id={{ container.GetIdentifier() }}" target="_blank" rel="noopener">Running</a>)
{% if container.GetDocumentation() != '' %}
Expand Down