planetscale / planetscale/vitess-operator

Reducing yaml file for VitessCluster Kind

Open
#611 0 comments 0 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

Do we have any option for maintaining clearness with VitessCluster Kind yaml file?
So what we have noticed about it:

  • repeatable vttablet extra flags for each keyspace
  • repeatable vttablet affinity definition for each keyspace
  • repeatable vttablet volumes, volumeMounts, extraEnv, mysqld configOverrides, sidecarContainers

All of these makes a huge yaml file when you have a lot of keyspaces defined.
Is there any options for definition of common configs etc. to be reused/included for each keyspaces and only some specific configs to be added under keyspaces?

With around 10 keyspaces we have almost 2k+ lines of cluster definition (it could be reduced without those repetitive stuff there)
Also noticed some flags don't have same key name, but hold the same value for example:
vtgate vault flags

  • mysql_auth_vault_addr:
  • mysql_auth_vault_path:
  • mysql_auth_vault_ttl:

vttablet vault flags

  • db-credentials-vault-ttl:
  • db-credentials-vault-addr:
  • db-credentials-vault-path:

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 reviewing the VitessCluster Kind YAML and catalog the repeated vttablet flags, affinity, volumes, mounts, environment, mysqld overrides, and sidecar definitions across keyspaces. Compare the vtgate and vttablet Vault flag names and clarify the desired reuse or inclusion mechanism; the issue does not define an implementation or acceptance criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes
Domain
devops, infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.