machines | @threefold/grid

Hierarchy

BaseModule
- machines

Constructors

constructor

new machines(config: GridClientConfig): machines

Overrides BaseModule.constructor
- Defined in packages/grid_client/src/modules/machines.ts:26
Parameters
- config: GridClientConfig
Returns machines

Properties

backendStorage

backendStorage: BackendStorage

config

config: GridClientConfig

deploymentFactory

deploymentFactory: DeploymentFactory

moduleName

moduleName: string = "machines"

projectName

projectName: string = ""

rmb

rmb: RMB

tfClient

tfClient: TFClient

twinDeploymentHandler

twinDeploymentHandler: TwinDeploymentHandler

vm

vm: VMHL

workloadTypes

workloadTypes: WorkloadTypes[] = ...

Methods

_add

_add(deployment_name: string, node_id: number, oldDeployments: Deployment[], twinDeployments: TwinDeployment[], network?: Network): Promise<{ contracts: { created: any[]; deleted: any[]; updated: any[] } }>

Inherited from BaseModule._add
- Defined in packages/grid_client/src/modules/base.ts:482
Parameters
- deployment_name: string
- node_id: number
- oldDeployments: Deployment[]
- twinDeployments: TwinDeployment[]
- network: Network = null
Returns Promise<{ contracts: { created: any[]; deleted: any[]; updated: any[] } }>

_createDeployment

_createDeployment(options: MachinesModel): Promise<[TwinDeployment[], Network, string]>

- Defined in packages/grid_client/src/modules/machines.ts:31
Parameters
- options: MachinesModel
Returns Promise<[TwinDeployment[], Network, string]>

_delete

_delete(name: string): Promise<{ created: any[]; deleted: any[]; updated: any[] }>

Inherited from BaseModule._delete
- Defined in packages/grid_client/src/modules/base.ts:539
Parameters
- name: string
Returns Promise<{ created: any[]; deleted: any[]; updated: any[] }>

_deleteInstance

_deleteInstance(module: ZdbHL | KubernetesHL | VMHL, deployment_name: string, name: string): Promise<{ created: any[]; deleted: any[]; updated: any[] }>

Inherited from BaseModule._deleteInstance
- Defined in packages/grid_client/src/modules/base.ts:525
Parameters
- module: ZdbHL | KubernetesHL | VMHL
- deployment_name: string
- name: string
Returns Promise<{ created: any[]; deleted: any[]; updated: any[] }>

_get

_get(name: string): Promise<Deployment[]>

Inherited from BaseModule._get
- Defined in packages/grid_client/src/modules/base.ts:243
Parameters
- name: string
Returns Promise<Deployment[]>

_getContractIdFromNodeId

_getContractIdFromNodeId(name: string, nodeId: number): Promise<number>

Inherited from BaseModule._getContractIdFromNodeId
- Defined in packages/grid_client/src/modules/base.ts:134
Parameters
- name: string
- nodeId: number
Returns Promise<number>

_getDeploymentNodeIds

_getDeploymentNodeIds(name: string): Promise<number[]>

Inherited from BaseModule._getDeploymentNodeIds
- Defined in packages/grid_client/src/modules/base.ts:125
Parameters
- name: string
Returns Promise<number[]>

_getDiskData

_getDiskData(deployments: Deployment[], name: string, contractId: number): { cache: undefined; expected_shards: undefined; message: string; metricsEndpoint: undefined; minimal_shards: undefined; prefix: undefined; qsfs_zdbs_name: undefined; size: number; state: ResultStates } | { cache: number; expected_shards: number; message: string; metricsEndpoint: string; minimal_shards: number; prefix: string; qsfs_zdbs_name: any; size: any; state: ResultStates }

Inherited from BaseModule._getDiskData
- Defined in packages/grid_client/src/modules/base.ts:214
Parameters
- deployments: Deployment[]
- name: string
- contractId: number
Returns { cache: undefined; expected_shards: undefined; message: string; metricsEndpoint: undefined; minimal_shards: undefined; prefix: undefined; qsfs_zdbs_name: undefined; size: number; state: ResultStates } | { cache: number; expected_shards: number; message: string; metricsEndpoint: string; minimal_shards: number; prefix: string; qsfs_zdbs_name: any; size: any; state: ResultStates }

_getMachinePubIP

_getMachinePubIP(deploymentName: string, deployments: any, publicIPWorkloadName: string): Promise<PublicIPResult>

Inherited from BaseModule._getMachinePubIP
- Defined in packages/grid_client/src/modules/base.ts:165
Parameters
- deploymentName: string
- deployments: any
- publicIPWorkloadName: string
Returns Promise<PublicIPResult>

_getNodeIdFromContractId

_getNodeIdFromContractId(name: string, contractId: number): Promise<number>

Inherited from BaseModule._getNodeIdFromContractId
- Defined in packages/grid_client/src/modules/base.ts:142
Parameters
- name: string
- contractId: number
Returns Promise<number>

_getWorkloadsByTypes

_getWorkloadsByTypes(deploymentName: string, deployments: any, types: WorkloadTypes[]): Promise<Workload[]>

Inherited from BaseModule._getWorkloadsByTypes
- Defined in packages/grid_client/src/modules/base.ts:151
Parameters
- deploymentName: string
- deployments: any
- types: WorkloadTypes[]
Returns Promise<Workload[]>

_getZmachineData

_getZmachineData(deploymentName: string, deployments: any, workload: Workload): Promise<Record<string, unknown>>

Inherited from BaseModule._getZmachineData
- Defined in packages/grid_client/src/modules/base.ts:178
Parameters
- deploymentName: string
- deployments: any
- workload: Workload
Returns Promise<Record<string, unknown>>

_list

_list(): Promise<string[]>

Inherited from BaseModule._list
- Defined in packages/grid_client/src/modules/base.ts:108
Returns Promise<string[]>

_update

_update(module: ZdbHL | KubernetesHL | VMHL, name: string, oldDeployments: Deployment[], twinDeployments: TwinDeployment[], network?: Network): Promise<"Nothing found to update" | { contracts: { created: any[]; deleted: any[]; updated: any[] } }>

Inherited from BaseModule._update
- Defined in packages/grid_client/src/modules/base.ts:438
Parameters
- module: ZdbHL | KubernetesHL | VMHL
- name: string
- oldDeployments: Deployment[]
- twinDeployments: TwinDeployment[]
- network: Network = null
Returns Promise<"Nothing found to update" | { contracts: { created: any[]; deleted: any[]; updated: any[] } }>

_updateWithPubIP

_updateWithPubIP(module: ZdbHL | KubernetesHL | VMHL, name: string, oldDeployments: Deployment[], twinDeployments: TwinDeployment[], network?: Network): Promise<TwinDeployment[]>

Inherited from BaseModule._updateWithPubIP
- Defined in packages/grid_client/src/modules/base.ts:284
Parameters
- module: ZdbHL | KubernetesHL | VMHL
- name: string
- oldDeployments: Deployment[]
- twinDeployments: TwinDeployment[]
- network: Network = null
Returns Promise<TwinDeployment[]>

_updateWithoutPubIP

_updateWithoutPubIP(module: ZdbHL | KubernetesHL | VMHL, name: string, oldDeployments: Deployment[], twinDeployments: TwinDeployment[], network?: Network): Promise<TwinDeployment[]>

Inherited from BaseModule._updateWithoutPubIP
- Defined in packages/grid_client/src/modules/base.ts:340
Parameters
- module: ZdbHL | KubernetesHL | VMHL
- name: string
- oldDeployments: Deployment[]
- twinDeployments: TwinDeployment[]
- network: Network = null
Returns Promise<TwinDeployment[]>

add_machine

add_machine(options: AddMachineModel): Promise<{ contracts: { created: any[]; deleted: any[]; updated: any[] } }>

- Defined in packages/grid_client/src/modules/machines.ts:149
Parameters
- options: AddMachineModel
Returns Promise<{ contracts: { created: any[]; deleted: any[]; updated: any[] } }>

delete

delete(options: MachinesDeleteModel): Promise<{ created: any[]; deleted: any[]; updated: any[] }>

- Defined in packages/grid_client/src/modules/machines.ts:121
Parameters
- options: MachinesDeleteModel
Returns Promise<{ created: any[]; deleted: any[]; updated: any[] }>

delete_machine

delete_machine(options: DeleteMachineModel): Promise<{ created: any[]; deleted: any[]; updated: any[] }>

- Defined in packages/grid_client/src/modules/machines.ts:200
Parameters
- options: DeleteMachineModel
Returns Promise<{ created: any[]; deleted: any[]; updated: any[] }>

deploy

deploy(options: MachinesModel): Promise<{ contracts: { created: any[]; deleted: any[]; updated: any[] }; wireguard_config: string }>

- Defined in packages/grid_client/src/modules/machines.ts:87
Parameters
- options: MachinesModel
Returns Promise<{ contracts: { created: any[]; deleted: any[]; updated: any[] }; wireguard_config: string }>

exists

exists(name: string): Promise<boolean>

Inherited from BaseModule.exists
- Defined in packages/grid_client/src/modules/base.ts:112
Parameters
- name: string
Returns Promise<boolean>

filter_pub_and_noPub_deployments

filter_pub_and_noPub_deployments(deployments: Deployment[] | TwinDeployment[]): any[][]

Inherited from BaseModule.filter_pub_and_noPub_deployments
- Defined in packages/grid_client/src/modules/base.ts:419
Parameters
- deployments: Deployment[] | TwinDeployment[]
Returns any[][]

get

get(options: MachinesGetModel): Promise<Deployment[]>

- Defined in packages/grid_client/src/modules/machines.ts:114
Parameters
- options: MachinesGetModel
Returns Promise<Deployment[]>

getDeploymentContracts

getDeploymentContracts(name: string): Promise<any>

Inherited from BaseModule.getDeploymentContracts
- Defined in packages/grid_client/src/modules/base.ts:59
Parameters
- name: string
Returns Promise<any>

getDeploymentPath

getDeploymentPath(name: string): string

Inherited from BaseModule.getDeploymentPath
- Defined in packages/grid_client/src/modules/base.ts:55
Parameters
- name: string
Returns string

getObj

getObj(deploymentName: string): Promise<Record<string, unknown>[]>

- Defined in packages/grid_client/src/modules/machines.ts:103
Parameters
- deploymentName: string
Returns Promise<Record<string, unknown>[]>

list

list(): Promise<string[]>

- Defined in packages/grid_client/src/modules/machines.ts:99
Returns Promise<string[]>

reject_update_pubIP_of_oldDeployment

reject_update_pubIP_of_oldDeployment(oldDeployments: Deployment[], twinDeployments: TwinDeployment[], name: string): Promise<void>

Inherited from BaseModule.reject_update_pubIP_of_oldDeployment
- Defined in packages/grid_client/src/modules/base.ts:378
Parameters
- oldDeployments: Deployment[]
- twinDeployments: TwinDeployment[]
- name: string
Returns Promise<void>

save

save(name: string, contracts: Record<string, unknown[]>): Promise<void>

Inherited from BaseModule.save
- Defined in packages/grid_client/src/modules/base.ts:68
Parameters
- name: string
- contracts: Record<string, unknown[]>
Returns Promise<void>

update

update(options: MachinesModel): Promise<"Nothing found to update" | { contracts: { created: any[]; deleted: any[]; updated: any[] } }>

- Defined in packages/grid_client/src/modules/machines.ts:129
Parameters
- options: MachinesModel
Returns Promise<"Nothing found to update" | { contracts: { created: any[]; deleted: any[]; updated: any[] } }>

workloadExists

workloadExists(name: string, oldDeployment: Deployment[]): boolean

Inherited from BaseModule.workloadExists
- Defined in packages/grid_client/src/modules/base.ts:116
Parameters
- name: string
- oldDeployment: Deployment[]
Returns boolean

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: GridClientConfig

Returns machines

Properties

backendStorage

config

deploymentFactory

moduleName

projectName

rmb

tfClient

twinDeploymentHandler

vm

workloadTypes

Methods

_add

Parameters

deployment_name: string

node_id: number

oldDeployments: Deployment[]

twinDeployments: TwinDeployment[]

network: Network = null

Returns Promise<{ contracts: { created: any[]; deleted: any[]; updated: any[] } }>

_createDeployment

Parameters

options: MachinesModel

Returns Promise<[TwinDeployment[], Network, string]>

_delete

Parameters

name: string

Returns Promise<{ created: any[]; deleted: any[]; updated: any[] }>

_deleteInstance

Parameters

module: ZdbHL | KubernetesHL | VMHL

deployment_name: string

name: string

Returns Promise<{ created: any[]; deleted: any[]; updated: any[] }>

_get

Parameters

name: string

Returns Promise<Deployment[]>

_getContractIdFromNodeId

Parameters

name: string

nodeId: number

Returns Promise<number>

_getDeploymentNodeIds

Parameters

name: string

Returns Promise<number[]>

_getDiskData

Parameters

deployments: Deployment[]

name: string

contractId: number

_getMachinePubIP

Parameters

deploymentName: string

deployments: any

publicIPWorkloadName: string

Returns Promise<PublicIPResult>

_getNodeIdFromContractId

Parameters

name: string

contractId: number

Returns Promise<number>

_getWorkloadsByTypes

Parameters

deploymentName: string

deployments: any

types: WorkloadTypes[]

Returns Promise<Workload[]>

_getZmachineData