Class ComponentsDataWrapper

constructor

• new ComponentsDataWrapper(state: DeploymentStateSchema): ComponentsDataWrapper

  Parameters

  • state: DeploymentStateSchema

  Returns ComponentsDataWrapper

state

componentIds

• get componentIds(): ComponentIdsStructure

  Returns ComponentIdsStructure

addNewComponent

• addNewComponent(
      component: BaseStateSchema,
      type: ComponentTypes,
      isReplace?: boolean,
  ): void

  Used to add new component to their respective group.

  Parameters

  • component: BaseStateSchema
  • type: ComponentTypes
  • OptionalisReplace: boolean

  Returns void

changeNodePhase

• changeNodePhase(componentId: number, phase: DeploymentPhase): void

  Parameters

  • componentId: number
  • phase: DeploymentPhase

  Returns void

getComponent

• getComponent<T extends BaseStateSchema>(
      type: ComponentTypes,
      componentId: number,
  ): T

  Type Parameters

  • T extends BaseStateSchema

  Parameters

  • type: ComponentTypes
  • componentId: number

  Returns T

getComponentById

• getComponentById<T extends BaseStateSchema>(type: ComponentTypes, id: number): T

  Type Parameters

  • T extends BaseStateSchema

  Parameters

  • type: ComponentTypes
  • id: number

  Returns T

getComponentByType

• getComponentByType<T extends BaseStateSchema>(type: ComponentTypes): T[]

  Type Parameters

  • T extends BaseStateSchema

  Parameters

  • type: ComponentTypes

  Returns T[]

getComponentsByClusterReference

• getComponentsByClusterReference<T extends BaseStateSchema>(
      type: ComponentTypes,
      clusterReference: string,
  ): T[]

  Type Parameters

  • T extends BaseStateSchema

  Parameters

  • type: ComponentTypes
  • clusterReference: string

  Returns T[]

getNewComponentId

• getNewComponentId(componentType: ComponentTypes): number

  Parameters

  • componentType: ComponentTypes

  Returns number

managePortForward

• managePortForward(
      clusterReference: string,
      podReference: PodReference,
      podPort: number,
      localPort: number,
      k8Client: K8,
      logger: SoloLogger,
      componentType: ComponentTypes,
      label: string,
      reuse?: boolean,
      nodeId?: number,
  ): Promise<number>

  Manages port forwarding for a component, checking if it's already enabled and persisting configuration

  Parameters

  • clusterReference: string

    The cluster reference to forward to

  • podReference: PodReference

    The pod reference to forward to

  • podPort: number

    The port on the pod to forward from

  • localPort: number

    The local port to forward to (starting port if not available)

  • k8Client: K8

    The Kubernetes client to use for port forwarding

  • logger: SoloLogger

    Logger for messages

  • componentType: ComponentTypes

    The component type for persistence

  • label: string

    Label for the port forward

  • reuse: boolean = false

    Whether to reuse existing port forward if available

  • OptionalnodeId: number

    Optional node ID for finding component when cluster reference is not available

  Returns Promise<number>

  The local port number that was used for port forwarding

removeComponent

• removeComponent(componentId: number, type: ComponentTypes): void

  Used to remove specific component from their respective group.

  Parameters

  • componentId: number
  • type: ComponentTypes

  Returns void