Skip to main content

WorkerNodeConfig

This class represents the configuration for a worker node in a cluster. It specifies parameters such as the group name, desired number of replicas, and optional minimum and maximum replica counts. It also allows for custom Ray start parameters, pod templates, and resource requests/limits.

Attributes​

  • group_name: string

    • The name of the group.

  • replicas: integer

    • The number of replicas.

  • min_replicas: Optional[integer] = None

    • The minimum number of replicas.

  • max_replicas: Optional[integer] = None

    • The maximum number of replicas.

  • ray_start_params: Optional[Dict[str, str]] = None

    • Parameters for starting Ray.

  • pod_template: Optional[PodTemplate] = None

    • The pod template.

  • requests: Optional[Resources] = None

    • The resource requests.

  • limits: Optional[Resources] = None

    • The resource limits.

Constructors​

  • Initializes a WorkerNodeConfig object.

  • Parameters

    • group_name: string
      • The name of the group for the worker nodes.
    • replicas: integer
      • The desired number of replicas for the worker nodes.
    • min_replicas: integer
      • The minimum number of replicas for the worker nodes.
    • max_replicas: integer
      • The maximum number of replicas for the worker nodes.
    • ray_start_params: dict
      • Optional dictionary of parameters to start Ray with.
    • pod_template: PodTemplate
      • Optional Pod template for the worker nodes.
    • requests: Resources
      • Optional resource requests for the worker nodes.
    • limits: Resources
      • Optional resource limits for the worker nodes.