kubernetes
/
kube-state-metrics
mirror of https://github.com/kubernetes/kube-state-metrics.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
kube-state-metrics/docs/developer/guide.md

2.0 KiB
Raw Blame History

Developer Guide

This developer guide documentation is intended to assist all contributors in various code contributions. Any contribution to improving this documentation will be appreciated.

Table of Contents

Add New Kubernetes Resource Metric Collector

The following steps are needed to introduce a new resource and its respective resource metrics.

  • Reference your new resource(s) to the docs/README.md.
  • Reference your new resource(s) in the docs/cli-arguments.md as part of the --resources flag.
  • Create a new <name-of-resource>.md in the docs directory to provide documentation on the resource(s) and metrics you implemented. Follow the formatting of all other resources.
  • Add the resource(s) you are representing to the examples/standard/cluster-role.yaml under the appropriate apiGroup using the verbs: list and watch.
  • Reference and add build functions for the new resource(s) in internal/store/builder.go.
  • Reference the new resource in pkg/options/resource.go.
  • Add a sample Kubernetes manifest to be used by tests in the tests/manifests/ directory.
  • Lastly, and most importantly, actually implement your new resource(s) and its test binary in internal/store. Follow the formatting and structure of other resources.