planetscale / planetscale/vitess-operator

Allow custom vtgate/vtctld Service names

Open
#82 4 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
372
Forks
102
Avg merge
3d 5h
Merged PRs (30d)
15

Description

Currently, the vtgate Service name has a unique, deterministic hash suffix. This was part of a strategy to avoid collisions in the multi-tenant environment for which our operator was initially designed. For those running the operator in their own, controlled environments, the hash suffix makes it unnecessarily difficult to configure apps to connect to Vitess.

We should make the hash suffix optional for at least the main vtgate/vtctld Services, and possibly also the per-cell vtgate Services. Ideally we would also make the suffix disabled by default, but unfortunately that would be a backwards-incompatible change for those of us already running the operator in production.

To avoid over-constraining the user's choice, we could support this by adding an optional field to override the default Service name to a custom value.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the operator entry points that construct the main vtgate and vtctld Service names, then inspect how per-cell vtgate Services and user-facing configuration are represented. Clarify whether the change should use an optional custom name, an optional hash suffix, or both, while preserving current defaults; done means the selected Services can be addressed by the configured names without breaking existing deployments.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes
Domain
devops, infrastructure
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.