feat(service-monitor): support bearer token authentication on metrics endpoint #719

2024-10-23T21:30:04Z

hiteshnayak305 commented

2024-10-23 21:30:04 +00:00

(Migrated from gitea.com)

Benefits

Can protect metrics endpoint with Bearer token authentication provided by gitea.
see PR #637 for previous discussion.

Possible drawbacks

No possible drawbacks

Applicable issues

fixes #635

Additional information

gitea:
  metrics:
    enabled: true
    token: "somepassword"
    serviceMonitor:
      enabled: true

Using above configuration is sufficient to secure /metrics endpoint with bearer token and corresponding ServiceMonitor.

Checklist

Parameters are documented in the values.yaml and added to the README.md using readme-generator-for-helm
~~Breaking changes are documented in the README.md~~ Not applicable
Templating unittests are added

Signed-off-by: Hitesh Nayak hiteshnayak305@gmail.com

### Benefits Can protect metrics endpoint with `Bearer` token authentication provided by gitea. see PR #637 for previous discussion. ### Possible drawbacks No possible drawbacks ### Applicable issues - fixes #635 ### Additional information ``` gitea: metrics: enabled: true token: "somepassword" serviceMonitor: enabled: true ``` Using above configuration is sufficient to secure /metrics endpoint with bearer token and corresponding ServiceMonitor. ### Checklist - [x] Parameters are documented in the `values.yaml` and added to the `README.md` using [readme-generator-for-helm](https://github.com/bitnami-labs/readme-generator-for-helm) - [ ] ~~Breaking changes are documented in the `README.md`~~ Not applicable - [x] Templating unittests are added Signed-off-by: Hitesh Nayak <hiteshnayak305@gmail.com>

pat-s (Migrated from gitea.com) reviewed 2024-10-23 21:30:05 +00:00

justusbunsi (Migrated from gitea.com) reviewed 2024-11-10 15:49:21 +00:00

templates/_helpers.tpl

justusbunsi (Migrated from gitea.com) commented

2024-11-10 15:53:14 +00:00

The tests in unittests/config/metrics-section_metrics-token.yaml are missing following case which currently fails as the token is configured even when metrics.enabled=false:

  - it: does not configures a token if metrics are disabled
    template: templates/gitea/config.yaml
    set:
      gitea:
        metrics:
          enabled: false
          token: "somepassword"
    asserts:
      - documentIndex: 0
        equal:
          path: stringData.metrics
          value: |-
            ENABLED=false

The tests in `unittests/config/metrics-section_metrics-token.yaml` are missing following case which currently fails as the token is configured even when `metrics.enabled=false`: ```yaml - it: does not configures a token if metrics are disabled template: templates/gitea/config.yaml set: gitea: metrics: enabled: false token: "somepassword" asserts: - documentIndex: 0 equal: path: stringData.metrics value: |- ENABLED=false ```

templates/gitea/servicemonitor.yaml

justusbunsi (Migrated from gitea.com) commented

2024-11-10 15:49:21 +00:00

Shouldn't it be not optional if the token is configured within Gitea?

Shouldn't it be not `optional` if the token is configured within Gitea?