Skip to content

Confusing SubdomainPolicy Comment in CRD #571

Closed
@nicole-lihui

Description

@nicole-lihui

What happened:

The comments for SubdomainShared and SubdomainUniquePerReplica in the CRD are misleading.
They incorrectly describe the Service and hostname behavior under each SubdomainPolicy.

For example, the current comment says in Shared mode, replica 0 will have a hostname like my-lws-0.my-lws, suggesting there are multiple Services involved, which is not accurate.

type SubdomainPolicy string
const (
// SubdomainShared will create a single headless service that all replicas
// will share. The host names look like:
// Replica 0: my-lws-0.my-lws, my-lws-0-1.my-lws
// Replica 1: my-lws-1.my-lws, my-lws-1-1.my-lws
SubdomainShared SubdomainPolicy = "Shared"
// UniquePerReplica will create a headless service per replica
// The pod host names look like:
// Replica 0: my-lws-0.my-lws-0,my-lws-0-1.my-lws-0, my-lws-0-2.my-lws-0
// Replica 1: my-lws-1.my-lws-1,my-lws-1-1.my-lws-1, my-lws-1-2.my-lws-1
SubdomainUniquePerReplica SubdomainPolicy = "UniquePerReplica"
)

What you expected to happen:

In Shared mode: there is only one headless Service shared by all replicas, e.g., vllm-pd-lws.

In UniquePerReplica mode: there is one Service per replica, e.g., vllm-pd-lws-0, vllm-pd-lws-1, etc.

Environment:

  • Kubernetes version (use kubectl version):
  • LWS version (use git describe --tags --dirty --always): 0.6.2
  • Cloud provider or hardware configuration:
  • OS (e.g: cat /etc/os-release):
  • Kernel (e.g. uname -a):
  • Install tools:
  • Others:

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/bugCategorizes issue or PR as related to a bug.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions