Options
All
  • Public
  • Public/Protected
  • All
Menu

Declarative interface for the Kubernetes Operator.

Hierarchy

  • Operator

Index

Constructors

constructor

Properties

api

api: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Custom HTTP API served over /api.

Optional apollo

apollo: ApolloServer

ApolloServer served over /graphql.

kubectl

kubectl: KubeInterface

Interface to Kubernetes API Server.

options

Operator configuration.

service

service: WebService

WebService object used to expose the endpoint.

watchers

watchers: ResourceWatcher[]

List of ResourceWatcher objects.

webapp

webapp: Application

Endpoint to access the GraphQL API, custom API, HealthChecks and metrics.

Methods

healthCheck

  • healthCheck(): Promise<boolean>
  • Hook called by WebService on requests to /health.

    NB: if that method is not overidden, it will always return true.

    Returns Promise<boolean>

    true if the operator is healthy or false otherwise.

initialize

  • initialize(): Promise<void>
  • Hook called by WebService before listenning for requests.

    Returns Promise<void>

metrics

  • metrics(): Promise<{}>
  • Hook called by WebService on requests to /metrics.

    NB: if that method is not overidden, it will always return {}.

    Returns Promise<{}>

    A JSON-serializable object containing the metrics to export.

terminate

  • terminate(): Promise<void>
  • Hook called by WebService before shutting down (on SIGINT or SIGTERM).

    Returns Promise<void>

Generated using TypeDoc