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.

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

Return the list of controllers to better determine service's health #428

Merged
merged 12 commits into from
Jun 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package fr.insee.onyxia.api.services.impl;

import static fr.insee.onyxia.api.services.impl.HelmReleaseHealthResolver.checkHelmReleaseHealth;
import static fr.insee.onyxia.api.services.impl.ServiceUrlResolver.getServiceUrls;

import com.fasterxml.jackson.databind.JsonNode;
Expand Down Expand Up @@ -619,6 +620,18 @@ private Service getServiceFromRelease(
service.setUrls(List.of());
}

try {
List<HealthCheckResult> controllers =
checkHelmReleaseHealth(release.getNamespace(), manifest, client);
service.setControllers(controllers);
} catch (Exception e) {
LOGGER.warn(
"Failed to retrieve controllers for release {} namespace {}",
release.getName(),
release.getNamespace(),
e);
service.setControllers(List.of());
}
service.setInstances(1);

service.setTasks(
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
package fr.insee.onyxia.api.services.impl;

import fr.insee.onyxia.model.service.HealthCheckResult;
import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.api.model.apps.DaemonSet;
import io.fabric8.kubernetes.api.model.apps.Deployment;
import io.fabric8.kubernetes.api.model.apps.StatefulSet;
import io.fabric8.kubernetes.client.KubernetesClient;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public final class HelmReleaseHealthResolver {

private static final Logger LOGGER = LoggerFactory.getLogger(HelmReleaseHealthResolver.class);

static List<HealthCheckResult> checkHelmReleaseHealth(
String namespace, String manifest, KubernetesClient kubernetesClient) {
// Identify the Helm release secret
List<HasMetadata> resources;
try (InputStream inputStream =
new ByteArrayInputStream(manifest.getBytes(StandardCharsets.UTF_8))) {
resources = kubernetesClient.load(inputStream).items();
} catch (IOException e) {
throw new RuntimeException("Exception during loading manifest", e);
}

return checkHealth(namespace, resources, kubernetesClient);
}

private static List<HealthCheckResult> checkHealth(
String namespace, List<HasMetadata> resources, KubernetesClient kubernetesClient) {
List<HealthCheckResult> results = new ArrayList<>();
for (HasMetadata resource : resources) {
String name = resource.getMetadata().getName();
String kind = resource.getKind();
HealthCheckResult result = new HealthCheckResult();
result.setName(name);
result.setKind(kind);
HealthCheckResult.HealthDetails details = new HealthCheckResult.HealthDetails();
try {
switch (kind) {
case "Deployment":
Deployment deployment =
kubernetesClient
.apps()
.deployments()
.inNamespace(namespace)
.withName(name)
.get();
details.setDesired(deployment.getSpec().getReplicas());
details.setReady(deployment.getStatus().getReadyReplicas());
case "StatefulSet":
StatefulSet statefulset =
kubernetesClient
.apps()
.statefulSets()
.inNamespace(namespace)
.withName(name)
.get();
details.setDesired(statefulset.getSpec().getReplicas());
details.setReady(statefulset.getStatus().getReadyReplicas());
case "DaemonSet":
DaemonSet daemonSet =
kubernetesClient
.apps()
.daemonSets()
.inNamespace(namespace)
.withName(name)
.get();
details.setDesired(daemonSet.getStatus().getDesiredNumberScheduled());
details.setReady(daemonSet.getStatus().getNumberReady());
default:
continue;
}
} catch (Exception e) {
LOGGER.warn(
"Could not retrieve health status from resource kind {} name {} ",
resource.getKind(),
resource.getMetadata().getName());
}
result.setDetails(details);
result.setHealthy(details.getReady() >= details.getDesired());
results.add(result);
}
return results;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
package fr.insee.onyxia.model.service;

public class HealthCheckResult {
private boolean healthy;
private String name;
private String kind;
private HealthDetails details;

public HealthCheckResult() {}

public HealthCheckResult(boolean healthy, String name, String kind, HealthDetails details) {
this.healthy = healthy;
this.name = name;
this.kind = kind;
this.details = details;
}

public boolean isHealthy() {
return healthy;
}

public void setHealthy(boolean healthy) {
this.healthy = healthy;
}

public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

public String getKind() {
return kind;
}

public void setKind(String kind) {
this.kind = kind;
}

public HealthDetails getDetails() {
return details;
}

public void setDetails(HealthDetails details) {
this.details = details;
}

public static class HealthDetails {
private int desired;
private int ready;

public int getReady() {
return ready;
}

public int getDesired() {
return desired;
}

public void setReady(int ready) {
this.ready = ready;
}

public void setDesired(int desired) {
this.desired = desired;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ public class Service {
@Schema(description = "")
private Map<String, String> labels;

@Schema(description = "")
private List<HealthCheckResult> controllers;

public String getId() {
return id;
}
Expand Down Expand Up @@ -276,6 +279,14 @@ public void setSuspended(boolean suspended) {
this.suspended = suspended;
}

public List<HealthCheckResult> getControllers() {
return controllers;
}

public void setControllers(List<HealthCheckResult> controllers) {
this.controllers = controllers;
}

public String getCatalogId() {
return catalogId;
}
Expand Down