stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 2 Releases Wiki Activity

Doctor plugin checks: implement health check classes and documentation

Browse Source 
Implement remediation-aware health checks across all Doctor plugin modules
(Agent, Attestor, Auth, BinaryAnalysis, Compliance, Crypto, Environment,
EvidenceLocker, Notify, Observability, Operations, Policy, Postgres, Release,
Scanner, Storage, Vex) and their backing library counterparts (AI, Attestation,
Authority, Core, Cryptography, Database, Docker, Integration, Notify,
Observability, Security, ServiceGraph, Sources, Verification).

Each check now emits structured remediation metadata (severity, category,
runbook links, and fix suggestions) consumed by the Doctor dashboard
remediation panel.

Also adds:
- docs/doctor/articles/ knowledge base for check explanations
- Advisory AI search seed and allowlist updates for doctor content
- Sprint plan for doctor checks documentation

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
master
2026-03-27 12:28:00 +02:00
parent fbd24e71de
commit c58a236d70
326 changed files with 18500 additions and 463 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/__Libraries/StellaOps.Doctor.Plugins.Docker/Checks/DockerApiVersionCheck.cs
View File

@@ -88,7 +88,8 @@ public sealed class DockerApiVersionCheck : IDoctorCheck
.WithCauses(issues.ToArray())
.WithRemediation(r => r
.AddManualStep(1, "Update Docker", "Install the latest Docker version for your OS")
.AddManualStep(2, "Verify version", "Run: docker version"))
.AddManualStep(2, "Verify version", "Run: docker version")
.WithRunbookUrl("docs/doctor/articles/docker/docker-apiversion.md"))
.WithVerification("stella doctor --check check.docker.apiversion")
.Build();
}

6
src/__Libraries/StellaOps.Doctor.Plugins.Docker/Checks/DockerDaemonCheck.cs
View File

@@ -80,7 +80,8 @@ public sealed class DockerDaemonCheck : IDoctorCheck
.WithCauses("Docker daemon returned an error response")
.WithRemediation(r => r
.AddManualStep(1, "Check daemon status", "Run: docker info")
.AddManualStep(2, "Restart daemon", "Run: sudo systemctl restart docker"))
.AddManualStep(2, "Restart daemon", "Run: sudo systemctl restart docker")
.WithRunbookUrl("docs/doctor/articles/docker/docker-daemon.md"))
.WithVerification("stella doctor --check check.docker.daemon")
.Build();
}
@@ -98,7 +99,8 @@ public sealed class DockerDaemonCheck : IDoctorCheck
.WithRemediation(r => r
.AddManualStep(1, "Install Docker", "Follow Docker installation guide for your OS")
.AddManualStep(2, "Start daemon", "Run: sudo systemctl start docker")
.AddManualStep(3, "Verify installation", "Run: docker version"))
.AddManualStep(3, "Verify installation", "Run: docker version")
.WithRunbookUrl("docs/doctor/articles/docker/docker-daemon.md"))
.WithVerification("stella doctor --check check.docker.daemon")
.Build();
}

3
src/__Libraries/StellaOps.Doctor.Plugins.Docker/Checks/DockerNetworkCheck.cs
View File

@@ -97,7 +97,8 @@ public sealed class DockerNetworkCheck : IDoctorCheck
.WithCauses(issues.ToArray())
.WithRemediation(r => r
.AddManualStep(1, "List networks", "Run: docker network ls")
.AddManualStep(2, "Create network", "Run: docker network create <network-name>"))
.AddManualStep(2, "Create network", "Run: docker network create <network-name>")
.WithRunbookUrl("docs/doctor/articles/docker/docker-network.md"))
.WithVerification("stella doctor --check check.docker.network")
.Build();
}

28
src/__Libraries/StellaOps.Doctor.Plugins.Docker/Checks/DockerSocketCheck.cs
View File

@@ -86,8 +86,28 @@ public sealed class DockerSocketCheck : IDoctorCheck
}
}
// Detect if we're running inside a container (no socket is expected)
var insideContainer = File.Exists("/.dockerenv") || File.Exists("/proc/1/cgroup");
if (!socketExists)
{
if (insideContainer)
{
// Inside a container without socket mount — this is normal for services
// that don't need direct Docker access (like Doctor, Platform, etc.)
return result
.Pass("Running inside container — Docker socket not required")
.WithEvidence("Docker socket", e =>
{
e.Add("Path", socketPath);
e.Add("Exists", "false");
e.Add("InsideContainer", "true");
e.Add("Note", "Docker socket is not mounted. This is expected for most services. " +
"Only mount the socket if this service needs to manage containers.");
})
.Build();
}
issues.Add($"Docker socket not found at {socketPath}");
}
else if (!socketReadable || !socketWritable)
@@ -98,7 +118,7 @@ public sealed class DockerSocketCheck : IDoctorCheck
if (issues.Count > 0)
{
return result
.Fail($"{issues.Count} Docker socket issue(s)")
.Warn($"{issues.Count} Docker socket issue(s)")
.WithEvidence("Docker socket", e =>
{
e.Add("Path", socketPath);
@@ -109,8 +129,10 @@ public sealed class DockerSocketCheck : IDoctorCheck
.WithCauses(issues.ToArray())
.WithRemediation(r => r
.AddManualStep(1, "Check Docker installation", "Ensure Docker is installed and running")
.AddManualStep(2, "Add user to docker group", "Run: sudo usermod -aG docker $USER")
.AddManualStep(3, "Re-login", "Log out and back in for group changes to take effect"))
.AddManualStep(2, "Mount Docker socket", "Add -v /var/run/docker.sock:/var/run/docker.sock to docker run, " +
"or volumes: ['/var/run/docker.sock:/var/run/docker.sock'] in docker-compose.yml")
.AddManualStep(3, "Add user to docker group", "Run: sudo usermod -aG docker $USER && logout")
.WithRunbookUrl("docs/doctor/articles/docker/docker-socket.md"))
.WithVerification("stella doctor --check check.docker.socket")
.Build();
}

3
src/__Libraries/StellaOps.Doctor.Plugins.Docker/Checks/DockerStorageCheck.cs
View File

@@ -123,7 +123,8 @@ public sealed class DockerStorageCheck : IDoctorCheck
.WithRemediation(r => r
.AddManualStep(1, "Prune unused data", "Run: docker system prune -a")
.AddManualStep(2, "Check disk usage", "Run: docker system df")
.AddManualStep(3, "Add storage", "Expand disk or add additional storage"))
.AddManualStep(3, "Add storage", "Expand disk or add additional storage")
.WithRunbookUrl("docs/doctor/articles/docker/docker-storage.md"))
.WithVerification("stella doctor --check check.docker.storage")
.Build();
}