Options
All
  • Public
  • Public/Protected
  • All
Menu

Module operator/types

Type definitions for the operator module.

Index

Type aliases

Type aliases

ApolloOptions

ApolloOptions: ApolloServerExpressConfig & { enabled: boolean }

Extends the ApolloServer configuration.

OperatorOptions

OperatorOptions: { apiFactory: (kubectl: KubeInterface) => express.RequestHandler; apolloOptions: ApolloOptions; authCookieName: string; cookieSecret: string; corsOptions: CorsOptions; kubeOptions: KubeInterfaceOptions; serverOptions: ServerOptions; watchers: ResourceWatcher[] }

Operator configuration.

Type declaration

  • [extraOption: string]: any

    Extra Options for children classes.

  • apiFactory: (kubectl: KubeInterface) => express.RequestHandler

      • Returns a custom HTTP API capable of interacting with the Kubernetes API Server.

        Parameters

        Returns express.RequestHandler

  • apolloOptions: ApolloOptions

    Configuration for ApolloServer.

  • authCookieName: string

    Name of the HttpOnly authentication cookie (see operator/auth).

  • cookieSecret: string

    Encryption secret for cookies.

  • corsOptions: CorsOptions

    Cross-Origin Resource Sharing configuration.

  • kubeOptions: KubeInterfaceOptions

    Configuration for KubeInterface.

  • serverOptions: ServerOptions

    Configuration for ServerFactory.

  • watchers: ResourceWatcher[]

    List of ResourceWatcher.

RecursivePartial

RecursivePartial<T>: {[ P in keyof T]: RecursivePartial<T[P]> }

Make all (nested) fields in a type optional.

Type parameters

  • T

ServerInfo

ServerInfo: { port: number; server: http.Server | https.Server }

Required informations to start listening.

Type declaration

  • port: number

    Port to listen to.

  • server: http.Server | https.Server

    HTTP(S) server that needs to listen.

ServerList

ServerList: ServerInfo[]

List of ServerInfo returned by ServerFactory.make.

ServerOptions

ServerOptions: { http: { enabled: boolean; port: number }; https: { ca: string; cert: string; enabled: boolean; key: string; port: number } }

ServerFactory configuration.

Type declaration

  • http: { enabled: boolean; port: number }

    HTTP Server configuration.

    • enabled: boolean

      Enable/Disable the HTTP server.

    • port: number

      Port to listen to.

  • https: { ca: string; cert: string; enabled: boolean; key: string; port: number }

    HTTPS Server configuration

    • ca: string

      Path to PEM encoded Server Certificate Authority.

    • cert: string

      Path to PEM encoded Server Certificate Public Key.

    • enabled: boolean

      Enable/Disable the HTTPS server.

    • key: string

      Path to PEM encoded Server Certificate Private Key.

    • port: number

      Port to listen to.

Generated using TypeDoc