Chris Farhood
46d59b48b5
Updated all GitHub URLs from cpfarhood to privilegedescalation organization: - Repository URLs in package.json and Artifact Hub metadata - Documentation links and references - Git remote updated No functional changes - this is purely an organizational migration. Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
[**Headlamp Sealed Secrets API v0.2.0**](../../../README.md)
|
|
|
|
***
|
|
|
|
[Headlamp Sealed Secrets API](../../../README.md) / [lib/controller](../README.md) / checkControllerHealth
|
|
|
|
# Function: checkControllerHealth()
|
|
|
|
> **checkControllerHealth**(`config`): [`AsyncResult`](../../../types/type-aliases/AsyncResult.md)\<[`ControllerHealthStatus`](../interfaces/ControllerHealthStatus.md), `string`\>
|
|
|
|
Defined in: [src/lib/controller.ts:185](https://github.com/privilegedescalation/headlamp-sealed-secrets-plugin/blob/bdf19cd3bf5a2d679b7ba949108fe9df1843c5f4/headlamp-sealed-secrets/src/lib/controller.ts#L185)
|
|
|
|
Check controller health and reachability
|
|
|
|
Attempts to reach the controller's health endpoint (/healthz) with a 5-second timeout.
|
|
Returns health status including latency and version information if available.
|
|
|
|
## Parameters
|
|
|
|
### config
|
|
|
|
[`PluginConfig`](../../../types/interfaces/PluginConfig.md)
|
|
|
|
Plugin configuration
|
|
|
|
## Returns
|
|
|
|
[`AsyncResult`](../../../types/type-aliases/AsyncResult.md)\<[`ControllerHealthStatus`](../interfaces/ControllerHealthStatus.md), `string`\>
|
|
|
|
Result containing health status (never fails - returns status even if unreachable)
|