Module: lib/k8s/apiProxy

    Interfaces

    Type aliases

    StreamErrCb

    Ƭ StreamErrCb: (err: Error & { status?: number }, cancelStreamFunc?: () => void) => void

    Type declaration

    ▸ (err, cancelStreamFunc?): void

    Parameters
    Name Type
    err Error & { status?: number }
    cancelStreamFunc? () => void
    Returns

    void

    Defined in

    lib/k8s/apiProxy.ts:224


    StreamResultsCb

    Ƭ StreamResultsCb: (…args: any[]) => void

    Type declaration

    ▸ (…args): void

    Parameters
    Name Type
    ...args any[]
    Returns

    void

    Defined in

    lib/k8s/apiProxy.ts:223

    Functions

    apiFactory

    apiFactory(…args): Object

    Parameters

    Name Type
    ...args [group: string, version: string, resource: string] | [group: string, version: string, resource: string][]

    Returns

    Object

    Name Type
    delete (name: string, queryParams?: QueryParameters ) => Promise<any>
    get (name: string, cb: StreamResultsCb , errCb: StreamErrCb , queryParams?: QueryParameters ) => Promise<() => void>
    isNamespaced boolean
    list (cb: StreamResultsCb , errCb: StreamErrCb , queryParams?: QueryParameters ) => Promise<() => void>
    patch (body: OpPatch[], name: string, queryParams?: QueryParameters ) => Promise<any>
    post (body: KubeObjectInterface , queryParams?: QueryParameters ) => Promise<any>
    put (body: KubeObjectInterface , queryParams?: QueryParameters ) => Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:290


    apiFactoryWithNamespace

    apiFactoryWithNamespace(…args): Object

    Parameters

    Name Type
    ...args [group: string, version: string, resource: string, includeScale: boolean] | [group: string, version: string, resource: string, includeScale: boolean][]

    Returns

    Object

    Name Type
    scale? { get: (namespace: string, name: string) => Promise<any> ; put: (body: { metadata: KubeMetadata ; spec: { replicas: number } }) => Promise<any> }
    scale.get (namespace: string, name: string) => Promise<any>
    scale.put (body: { metadata: KubeMetadata ; spec: { replicas: number } }) => Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:340


    apply

    apply(body): Promise<JSON>

    Parameters

    Name Type
    body KubeObjectInterface

    Returns

    Promise<JSON>

    Defined in

    lib/k8s/apiProxy.ts:794


    deleteCluster

    deleteCluster(cluster): Promise<any>

    Parameters

    Name Type
    cluster string

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:881


    listPortForward

    listPortForward(cluster): Promise<any>

    Parameters

    Name Type
    cluster string

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:939


    metrics

    metrics(url, onMetrics, onError?): Promise<() => void>

    Parameters

    Name Type
    url string
    onMetrics (arg: KubeMetrics []) => void
    onError? (err: ApiError ) => void

    Returns

    Promise<() => void>

    Defined in

    lib/k8s/apiProxy.ts:836


    patch

    patch(url, json, autoLogoutOnAuthError?, requestOptions?): Promise<any>

    Parameters

    Name Type Default value
    url string undefined
    json any undefined
    autoLogoutOnAuthError boolean true
    requestOptions Object {}

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:491


    post

    post(url, json, autoLogoutOnAuthError?, requestOptions?): Promise<any>

    Parameters

    Name Type Default value
    url string undefined
    json object | KubeObjectInterface | JSON undefined
    autoLogoutOnAuthError boolean true
    requestOptions Object {}

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:480


    put

    put(url, json, autoLogoutOnAuthError?, requestOptions?): Promise<any>

    Parameters

    Name Type Default value
    url string undefined
    json Partial< KubeObjectInterface > undefined
    autoLogoutOnAuthError boolean true
    requestOptions Object {}

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:502


    remove

    remove(url, requestOptions?): Promise<any>

    Parameters

    Name Type
    url string
    requestOptions Object

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:513


    request

    request(path, params?, autoLogoutOnAuthError?, useCluster?, queryParams?): Promise<any>

    Parameters

    Name Type Default value
    path string undefined
    params RequestParams {}
    autoLogoutOnAuthError boolean true
    useCluster boolean true
    queryParams? QueryParameters undefined

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:134


    setCluster

    setCluster(clusterReq): Promise<any>

    Parameters

    Name Type
    clusterReq ClusterRequest

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:872


    startPortForward

    startPortForward(cluster, namespace, podname, containerPort, service, serviceNamespace, port?, id?): Promise<any>

    Parameters

    Name Type Default value
    cluster string undefined
    namespace string undefined
    podname string undefined
    containerPort string | number undefined
    service string undefined
    serviceNamespace string undefined
    port? string undefined
    id string ''

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:885


    stopOrDeletePortForward

    stopOrDeletePortForward(cluster, id, stopOrDelete?): Promise<string>

    Parameters

    Name Type Default value
    cluster string undefined
    id string undefined
    stopOrDelete boolean true

    Returns

    Promise<string>

    Defined in

    lib/k8s/apiProxy.ts:921


    stream

    stream(url, cb, args): Object

    Parameters

    Name Type
    url string
    cb StreamResultsCb
    args StreamArgs

    Returns

    Object

    Name Type
    cancel () => void
    getSocket () => null | WebSocket

    Defined in

    lib/k8s/apiProxy.ts:670


    streamResult

    streamResult(url, name, cb, errCb, queryParams?): Promise<() => void>

    Parameters

    Name Type
    url string
    name string
    cb StreamResultsCb
    errCb StreamErrCb
    queryParams? QueryParameters

    Returns

    Promise<() => void>

    Defined in

    lib/k8s/apiProxy.ts:518


    streamResults

    streamResults(url, cb, errCb, queryParams): Promise<() => void>

    Parameters

    Name Type
    url string
    cb StreamResultsCb
    errCb StreamErrCb
    queryParams undefined | QueryParameters

    Returns

    Promise<() => void>

    Defined in

    lib/k8s/apiProxy.ts:559


    testAuth

    testAuth(): Promise<any>

    Returns

    Promise<any>

    Defined in

    lib/k8s/apiProxy.ts:865