Doctor plugin checks: implement health check classes and documentation
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:
@@ -120,6 +120,7 @@ public sealed class CiSystemConnectivityCheck : IDoctorCheck
|
||||
rb.AddStep(2, "Refresh credentials",
|
||||
$"stella ci auth refresh {unhealthy[0]}",
|
||||
CommandType.Manual);
|
||||
rb.WithRunbookUrl("docs/doctor/articles/integration/integration-ci-system.md");
|
||||
})
|
||||
.WithVerification($"stella doctor --check {CheckId}")
|
||||
.Build();
|
||||
@@ -145,6 +146,7 @@ public sealed class CiSystemConnectivityCheck : IDoctorCheck
|
||||
rb.AddStep(1, "Check runner status",
|
||||
$"stella ci runners {noRunners[0]}",
|
||||
CommandType.Shell);
|
||||
rb.WithRunbookUrl("docs/doctor/articles/integration/integration-ci-system.md");
|
||||
})
|
||||
.WithVerification($"stella doctor --check {CheckId}")
|
||||
.Build();
|
||||
|
||||
@@ -126,7 +126,8 @@ public sealed class GitProviderCheck : IDoctorCheck
|
||||
"Git provider service is down")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Verify Git URL", "Check Git:Url configuration")
|
||||
.AddManualStep(2, "Test connectivity", $"curl -v {gitUrl}"))
|
||||
.AddManualStep(2, "Test connectivity", $"curl -v {gitUrl}")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-git.md"))
|
||||
.WithVerification("stella doctor --check check.integration.git")
|
||||
.Build();
|
||||
}
|
||||
|
||||
@@ -174,7 +174,8 @@ public sealed class IntegrationWebhookHealthCheck : IDoctorCheck
|
||||
.WithRemediation(rb => rb
|
||||
.AddStep(1, "Monitor webhook metrics",
|
||||
"stella webhooks stats",
|
||||
CommandType.Shell))
|
||||
CommandType.Shell)
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-webhooks.md"))
|
||||
.WithVerification($"stella doctor --check {CheckId}")
|
||||
.Build();
|
||||
}
|
||||
|
||||
@@ -95,7 +95,8 @@ public sealed class LdapConnectivityCheck : IDoctorCheck
|
||||
"Network connectivity issues")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Check LDAP server", "Verify LDAP server is running and accessible")
|
||||
.AddManualStep(2, "Test connectivity", $"telnet {host} {port}"))
|
||||
.AddManualStep(2, "Test connectivity", $"telnet {host} {port}")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-ldap.md"))
|
||||
.WithVerification("stella doctor --check check.integration.ldap")
|
||||
.Build();
|
||||
}
|
||||
@@ -143,7 +144,8 @@ public sealed class LdapConnectivityCheck : IDoctorCheck
|
||||
"Network unreachable")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Check LDAP configuration", "Verify Ldap:Host and Ldap:Port settings")
|
||||
.AddManualStep(2, "Check DNS", $"nslookup {host}"))
|
||||
.AddManualStep(2, "Check DNS", $"nslookup {host}")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-ldap.md"))
|
||||
.WithVerification("stella doctor --check check.integration.ldap")
|
||||
.Build();
|
||||
}
|
||||
|
||||
@@ -89,7 +89,8 @@ public sealed class ObjectStorageCheck : IDoctorCheck
|
||||
"Firewall blocking connection")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Check S3 endpoint", "Verify S3:Endpoint configuration")
|
||||
.AddManualStep(2, "Test connectivity", $"curl -v {endpoint}"))
|
||||
.AddManualStep(2, "Test connectivity", $"curl -v {endpoint}")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-s3-storage.md"))
|
||||
.WithVerification("stella doctor --check check.integration.s3.storage")
|
||||
.Build();
|
||||
}
|
||||
@@ -148,7 +149,8 @@ public sealed class ObjectStorageCheck : IDoctorCheck
|
||||
"Network unreachable")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Check S3 service", "Verify MinIO or S3 service is running")
|
||||
.AddManualStep(2, "Check DNS", $"nslookup {new Uri(endpoint).Host}"))
|
||||
.AddManualStep(2, "Check DNS", $"nslookup {new Uri(endpoint).Host}")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-s3-storage.md"))
|
||||
.WithVerification("stella doctor --check check.integration.s3.storage")
|
||||
.Build();
|
||||
}
|
||||
|
||||
@@ -114,7 +114,8 @@ public sealed class OciRegistryCheck : IDoctorCheck
|
||||
"Registry service is down")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Verify registry URL", "Check OCI:RegistryUrl configuration")
|
||||
.AddManualStep(2, "Test connectivity", $"curl -v {registryUrl}/v2/"))
|
||||
.AddManualStep(2, "Test connectivity", $"curl -v {registryUrl}/v2/")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-oci-registry.md"))
|
||||
.WithVerification("stella doctor --check check.integration.oci.registry")
|
||||
.Build();
|
||||
}
|
||||
|
||||
@@ -129,7 +129,8 @@ public sealed class OidcProviderCheck : IDoctorCheck
|
||||
"OIDC provider does not support discovery")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Verify issuer URL", "Check Oidc:Issuer configuration")
|
||||
.AddManualStep(2, "Test discovery", $"curl -v {discoveryUrl}"))
|
||||
.AddManualStep(2, "Test discovery", $"curl -v {discoveryUrl}")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-oidc.md"))
|
||||
.WithVerification("stella doctor --check check.integration.oidc")
|
||||
.Build();
|
||||
}
|
||||
@@ -149,7 +150,8 @@ public sealed class OidcProviderCheck : IDoctorCheck
|
||||
"OIDC provider is down")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Verify issuer URL", "Check Oidc:Issuer configuration")
|
||||
.AddManualStep(2, "Test connectivity", $"curl -v {issuer}/.well-known/openid-configuration"))
|
||||
.AddManualStep(2, "Test connectivity", $"curl -v {issuer}/.well-known/openid-configuration")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-oidc.md"))
|
||||
.WithVerification("stella doctor --check check.integration.oidc")
|
||||
.Build();
|
||||
}
|
||||
|
||||
@@ -121,6 +121,7 @@ public sealed class SecretsManagerConnectivityCheck : IDoctorCheck
|
||||
rb.AddStep(2, "Refresh authentication",
|
||||
$"stella secrets auth refresh {unhealthy[0]}",
|
||||
CommandType.Manual);
|
||||
rb.WithRunbookUrl("docs/doctor/articles/integration/integration-secrets-manager.md");
|
||||
})
|
||||
.WithVerification($"stella doctor --check {CheckId}")
|
||||
.Build();
|
||||
@@ -149,6 +150,7 @@ public sealed class SecretsManagerConnectivityCheck : IDoctorCheck
|
||||
rb.AddStep(2, "Check seal status",
|
||||
$"stella secrets status {sealed_[0]}",
|
||||
CommandType.Shell);
|
||||
rb.WithRunbookUrl("docs/doctor/articles/integration/integration-secrets-manager.md");
|
||||
})
|
||||
.WithVerification($"stella doctor --check {CheckId}")
|
||||
.Build();
|
||||
|
||||
@@ -90,7 +90,8 @@ public sealed class SmtpCheck : IDoctorCheck
|
||||
"Network connectivity issues")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Check SMTP server", "Verify SMTP server is running")
|
||||
.AddManualStep(2, "Test connectivity", $"telnet {host} {port}"))
|
||||
.AddManualStep(2, "Test connectivity", $"telnet {host} {port}")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-smtp.md"))
|
||||
.WithVerification("stella doctor --check check.integration.smtp")
|
||||
.Build();
|
||||
}
|
||||
@@ -138,7 +139,8 @@ public sealed class SmtpCheck : IDoctorCheck
|
||||
"Network unreachable")
|
||||
.WithRemediation(r => r
|
||||
.AddManualStep(1, "Check SMTP configuration", "Verify Smtp:Host and Smtp:Port settings")
|
||||
.AddManualStep(2, "Check DNS", $"nslookup {host}"))
|
||||
.AddManualStep(2, "Check DNS", $"nslookup {host}")
|
||||
.WithRunbookUrl("docs/doctor/articles/integration/integration-smtp.md"))
|
||||
.WithVerification("stella doctor --check check.integration.smtp")
|
||||
.Build();
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user