📖 Cluster API State Metrics proposal

[chrischdi]

Signed-off-by: Christian Schlotter [email protected]

What this PR does / why we need it:

Proposal to address parts of #1477.

This proposal outlines a new experimental component for exposing metrics specific to CAPI's CRs.

[chrischdi]

I checked the mentioned links and was able to reach them

/retest

[chrischdi]

I checked the mentioned links and was able to reach them

/retest

This doesn't restart the gh action tests :-(

[killianmuldoon]

This doesn't restart the gh action tests :-(

Yeah - it's a bother - we have an issue here: kubernetes/test-infra#25831

These can be restarted manually and will re-run on another push. The MD link checker is flaky so it's probably fine, so I don't think there's anything to worry about here 😄

[killianmuldoon]

/lgtm

Can't wait to get this into the repo!

[fabriziopandini]

/lgtm
Looking forward to getting this under /exp and in our tilt setup.
As this is accomplished I think we should consider

• to document how to install this new component, so we can start getting feedback from the broader audience
• providing some pre-defined Prometheus dashboard
  But can come as a follow up iteration

[chrischdi]

I identified and fixed some small things:

• added a _paused metric, this is already implemented in https://github.com/mercedes-benz/cluster-api-state-metrics
• fixed formatting for some tables
• fixed version reference for the capi_machine_info metric

[chrischdi]

Also added already implemented capi_machineset_status_available_replicas metric

[chrischdi]

/retest

[chrischdi]

I squashed the commits :-)

[chrischdi]

The test Check Markdown links / Broken Links (pull_request) looks again like a false positive :-(

[enxebre]

thanks lgtm after squashing, we can always iterate later as we need it.

[chrischdi]

Squashed the commits :-)

[fabriziopandini]

/lgtm

[seanschneeweiss]

Great work - so happy to see this being integrated into CAPI.

[chrischdi]

Great work - so happy to see this being integrated into CAPI.

Thanks for these (hopefully) last findings :-)

[chrischdi]

Broken Links check has again false-positives:

FILE: ./docs/book/src/clusterctl/provider-contract.md
[✖] https://help.github.com/en/github/administering-a-repository/creating-releases

7 links checked.

ERROR: 1 dead links found!
[✖] https://help.github.com/en/github/administering-a-repository/creating-releases → Status: 403

Github Action issue: gaurav-nelson/github-action-markdown-link-check#136

[sbueringer]

Great work folks!

/lgtm

@fabriziopandini WDYT can we merge this proposal (or tomorrow :)) given that the lazy-consensus deadline is today? (#6404 (comment))

[johannesfrey]

Thanks again!

/lgtm

[tobiasgiese]

/retest
/lgtm

Thanks @chrischdi 🙂

[seanschneeweiss]

/lgtm

Thank you @chrischdi

[fabriziopandini]

/approve
/lgtm
🎉

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [fabriziopandini]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[sbueringer]

/hold cancel

[sbueringer]

Looks like the linkchecker consistently fails since 2 days: https://github.com/kubernetes-sigs/cluster-api/actions/workflows/lint-docs.yaml
(the action is not run on every PR)

EDIT: trying to fix it here: #6451

[sbueringer]

Markdown link checker fix can be found here: #6451