planetscale / planetscale/vitess-operator

Add an option to use k8s as the topology server

Open
#74 6 comments 3 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

We recently merged the k8s topology into Vitess. This allows Vitess to run without requiring a dedicated topology service. It's actually so useful that it's the default for the 2.X Helm charts.

It should be pretty easy to update the operator to support the k8s topo. It will just need to create the following extra resources:

  1. The vitesstopologynode crd (could be done during operator installation)
  2. ServiceAccounts for all component pods that need to use the topology.
  3. RBAC for the ServiceAccounts that allow them full access to vitesstopologynodes
  4. Set the right topo flags, it should just be -topo_implementation=k8s the root doesn't change and the server_address doesn't matter because the components will use their in-cluster kubeconfig to detect everything else by default.

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 installation logic and the component pod specifications, then inspect how Vitess topology flags are configured. Done means the operator creates or installs the vitesstopologynode CRD, ServiceAccounts, and RBAC, and configures the k8s topology implementation for relevant components.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.