projectcalico/calico

Helm "enable metrics" boolean and other config options not well documented

Closed

#6,887 opened on Oct 21, 2022

View on GitHubContributor guide
 (10 comments) (0 reactions) (1 assignee)Go (1,594 forks)auto 404
area/helmgood first issuehelp wantedkind/enhancementstale

Repository metrics

Stars
 (7,292 stars)
PR merge metrics
 (PR metrics pending)

Description

Expected Behavior

A number of common helm charts have a value you can set to enable metrics reporting. Since calico has a metrics interface, having a clean way to enable it via helm would be nice.

Current Behavior

You must manually patch the instance to enable metrics

Possible Solution

Add a boolean to values.yml and the relevant templates to enable the metrics service on request.

Steps to Reproduce (for bugs)

  1. Install via helm
  2. look for way to enable metrics as a parameter

Context

A consistent way to enable metrics across a wide array of helm charts makes things easier.

Your Environment

  • Calico version: 3.24.2
  • Orchestrator version (e.g. kubernetes, mesos, rkt): 1.25.2
  • Operating System and version: CentOS Stream9
  • Link to your project (optional):

Contributor guide

Research direction
Add a boolean to values.yml and the relevant templates to enable the metrics service on request.
Tech stack
go
Domain
devopsinfrastructure
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HelmKubernetes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70