Class: Node

    lib/k8s/node .Node

    Hierarchy

    • any

      Node

    Constructors

    constructor

    new Node(json)

    Parameters

    Name Type
    json KubeNode

    Inherited from

    makeKubeObject<KubeNode>(‘node’).constructor

    Defined in

    lib/k8s/cluster.ts:317

    Properties

    apiEndpoint

    Static apiEndpoint: Object

    Type declaration

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

    Defined in

    lib/k8s/node.ts:56


    className

    Static className: string

    Inherited from

    makeKubeObject<KubeNode>(‘node’).className

    Defined in

    lib/k8s/cluster.ts:318

    Accessors

    spec

    get spec(): Object

    Returns

    Object

    Name Type
    podCIDR string
    taints { effect: string ; key: string }[]

    Defined in

    lib/k8s/node.ts:62


    status

    get status(): Object

    Returns

    Object

    Name Type
    addresses { address: string ; type: string }[]
    allocatable { cpu: any ; ephemeralStorage: any ; hugepages_1Gi: any ; hugepages_2Mi: any ; memory: any ; pods: any }
    allocatable.cpu any
    allocatable.ephemeralStorage any
    allocatable.hugepages_1Gi any
    allocatable.hugepages_2Mi any
    allocatable.memory any
    allocatable.pods any
    capacity { cpu: any ; ephemeralStorage: any ; hugepages_1Gi: any ; hugepages_2Mi: any ; memory: any ; pods: any }
    capacity.cpu any
    capacity.ephemeralStorage any
    capacity.hugepages_1Gi any
    capacity.hugepages_2Mi any
    capacity.memory any
    capacity.pods any
    conditions Omit< KubeCondition , "lastProbeTime" | "lastUpdateTime"> & { lastHeartbeatTime: string }[]
    nodeInfo { architecture: string ; bootID: string ; containerRuntimeVersion: string ; kernelVersion: string ; kubeProxyVersion: string ; kubeletVersion: string ; machineID: string ; operatingSystem: string ; osImage: string ; systemUUID: string }
    nodeInfo.architecture string
    nodeInfo.bootID string
    nodeInfo.containerRuntimeVersion string
    nodeInfo.kernelVersion string
    nodeInfo.kubeProxyVersion string
    nodeInfo.kubeletVersion string
    nodeInfo.machineID string
    nodeInfo.operatingSystem string
    nodeInfo.osImage string
    nodeInfo.systemUUID string

    Defined in

    lib/k8s/node.ts:58

    Methods

    getExternalIP

    getExternalIP(): string

    Returns

    string

    Defined in

    lib/k8s/node.ts:83


    getInternalIP

    getInternalIP(): string

    Returns

    string

    Defined in

    lib/k8s/node.ts:87


    apiList

    Static apiList(onList, onError?, opts?): any

    Parameters

    Name Type
    onList (arg: any[]) => void
    onError? (err: ApiError ) => void
    opts? ApiListSingleNamespaceOptions

    Returns

    any

    Inherited from

    makeKubeObject<KubeNode>(‘node’).apiList

    Defined in

    lib/k8s/cluster.ts:293


    getAuthorization

    Static Optional getAuthorization(arg, resourceAttrs?): any

    Parameters

    Name Type
    arg string
    resourceAttrs? AuthRequestResourceAttrs

    Returns

    any

    Inherited from

    makeKubeObject<KubeNode>(‘node’).getAuthorization

    Defined in

    lib/k8s/cluster.ts:320


    getErrorMessage

    Static getErrorMessage(err?): null | string

    Parameters

    Name Type
    err? null | ApiError

    Returns

    null | string

    Inherited from

    makeKubeObject<KubeNode>(‘node’).getErrorMessage

    Defined in

    lib/k8s/cluster.ts:316


    useApiGet

    Static useApiGet(onGet, name, namespace?, onError?): void

    Parameters

    Name Type
    onGet (…args: any) => void
    name string
    namespace? string
    onError? (err: ApiError ) => void

    Returns

    void

    Inherited from

    makeKubeObject<KubeNode>(‘node’).useApiGet

    Defined in

    lib/k8s/cluster.ts:303


    useApiList

    Static useApiList(onList, onError?, opts?): any

    Parameters

    Name Type
    onList (arg: any[]) => void
    onError? (err: ApiError ) => void
    opts? ApiListOptions

    Returns

    any

    Inherited from

    makeKubeObject<KubeNode>(‘node’).useApiList

    Defined in

    lib/k8s/cluster.ts:298


    useGet

    Static useGet(name, namespace?): [any, null | ApiError , (item: any) => void, (err: null | ApiError ) => void]

    Parameters

    Name Type
    name string
    namespace? string

    Returns

    [any, null | ApiError , (item: any) => void, (err: null | ApiError ) => void]

    Inherited from

    makeKubeObject<KubeNode>(‘node’).useGet

    Defined in

    lib/k8s/cluster.ts:312


    useList

    Static useList(opts?): [any[], null | ApiError , (items: any[]) => void, (err: null | ApiError ) => void]

    Parameters

    Name Type
    opts? ApiListOptions

    Returns

    [any[], null | ApiError , (items: any[]) => void, (err: null | ApiError ) => void]

    Inherited from

    makeKubeObject<KubeNode>(‘node’).useList

    Defined in

    lib/k8s/cluster.ts:309


    useMetrics

    Static useMetrics(): [null | KubeMetrics [], null | ApiError ]

    Returns

    [null | KubeMetrics [], null | ApiError ]

    Defined in

    lib/k8s/node.ts:66