Page MenuHomePhabricator

Ensure all Chart.yaml files include required metadata fields
Open, MediumPublic

Description

Adding standardised metadata fields to every Chart.yaml would significantly improve chart maintainability across projects. This would make it easier for engineers to find relevant information about apps/services, and identify who maintains them.

It would be great if we could add the following fields to every Chart.yaml:

  • description
  • keywords
  • home
  • sources
  • maintainers
  • team

Requirements

home and team values must always point to a wikitech page, even if that directs to another page (eg mediawiki.org)

Charts

Updating Chart metadata does not require a version bump

  • airflow
  • apertium
  • api-gateway
  • aqs-http-gateway
  • benthos
  • blunderbuss
  • calculator-service
  • calico-crds
  • calico
  • ceph-csi-cephfs
  • ceph-csi-rbd
  • cert-manager
  • cfssl-issuer-crds
  • cfssl-issuer
  • changeprop
  • chart-renderer
  • chromium-render
  • citoid
  • cloudnative-pg-cluster
  • cloudnative-pg-crds
  • cloudnative-pg
  • coredns
  • cxserver
  • datahub
  • datasets-config
  • developer-portal
  • echoserver
  • eventgate
  • eventrouter
  • eventstreams
  • external-services
  • ferretdb
  • flink-app
  • flink-kubernetes-operator-crds
  • flink-kubernetes-operator
  • function-evaluator
  • function-orchestrator
  • growthbook
  • helm-state-metrics
  • ipoid
  • jaeger
  • k8s-controller-sidecars
  • kafka-dev
  • kafka-mirrormaker
  • kartotherian
  • kask
  • knative-serving-crds
  • knative-serving
  • kserve-inference
  • kserve
  • kube-state-metrics
  • linkrecommendation
  • machinetranslation
  • mathoid
  • mcrouter
  • mediawiki-common
  • mediawiki-dev
  • mediawiki-dumps-legacy
  • mediawiki
  • miscweb
  • mobileapps
  • mpic
  • opensearch-cluster
  • opensearch-operator-crds
  • opensearch-operator
  • opentelemetry-collector
  • push-notifications
  • python-webapp
  • ratelimit
  • raw
  • recommendation-api
  • secrets
  • shellbox
  • spark-history
  • spark-operator-crds
  • spark-operator
  • spark-support
  • statsd-exporter
  • superset
  • tegola-vector-tiles
  • termbox
  • thumbor
  • toolhub
  • validating-admission-policies
  • wikifeeds
  • zotero

Examples

apiVersion: v2
description: A Helm chart for mcrouter
kubeVersion: ">=1.23"
name: mcrouter
version: 0.1.1
keywords:
  - mcrouter
  - memcached
home: https://wikitech.wikimedia.org/wiki/Memcached_for_MediaWiki
sources:
  - https://gerrit.wikimedia.org/r/admin/repos/operations/docker-images/production-images
team: https://wikitech.wikimedia.org/wiki/SRE/Service_Operations
maintainers:
  - name: Effie Mouzeli
    email: effie@wikimedia.org

Event Timeline

Change #1218245 had a related patch set uploaded (by Effie Mouzeli; author: Effie Mouzeli):

[operations/deployment-charts@master] mcrouter: update chart metadata

https://gerrit.wikimedia.org/r/1218245

Change #1218245 merged by jenkins-bot:

[operations/deployment-charts@master] mcrouter: update chart metadata

https://gerrit.wikimedia.org/r/1218245

Change #1218270 had a related patch set uploaded (by Effie Mouzeli; author: Effie Mouzeli):

[operations/deployment-charts@master] cxserver: update chart metadata

https://gerrit.wikimedia.org/r/1218270

Are you planning to enforce this via CI checks?

Scott_French moved this task from Inbox to Backlog on the ServiceOps new board.