Skip to content

Protect metric services via firewall when exposing them

Anton Smith requested to merge docs/protect-metrics-when-exposing-them into master

What does this MR do?

There is some confusion regarding the IP whitelist step and that it will protect all metric endpoints.

In reality, the IP whitelist will only protect the GitLab metrics endpoint since requests to this endpoint go through GitLab-Rails.

Other bundled metric services that are configured to bind on the network interface DO NOT go through the IP whitelist because these requests do not go through GitLab-Rails, rather the request goes directly to the respective metric service.

Therefore, let's add some docs to advise readers to add ingress firewall rules to protect these metric services when exposing them on the network interface.

Do note I've reordered the steps and I've added configurations examples for missing metrics (Registry, and Pgbouncer).

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
  • [ ]
Edited by Anton Smith

Merge request reports