mirrors/prometheus-operator
mirrors/prometheus-operator
1
0
Fork 0
mirror of https://github.com/prometheus-operator/prometheus-operator.git synced 2025-04-16 09:16:38 +00:00
Code Activity

Documentation: update link to image for newer Hugo (#4903)

Browse source 
Recent versions of Hugo fails to render `troubleshooting.md` when the
`custom-metrics-elements.png` image isn't located in a static directory.

To avoid further complication with the `synchronize.sh` script from the
github.com/prometheus-operator/website project, images are now stored
under `Documentation/img` and the script will copy this directory to the
`static` directory of the website. Any content that wants to include an
image needs to follow the same approach.

The caveat is that the image will not be displayed from the GitHub UI. I
have tried to use page bundles [1] which would circumvent this
limitation but it would involve moving all the individual MarkDown files
into separate directories and rearrange the site's structure.

See also https://github.com/prometheus-operator/website/pull/17

[1] https://gohugo.io/content-management/page-bundles/

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
This commit is contained in:
Simon Pasquier 2022-07-13 09:53:42 +02:00 • committed by GitHub
parent 7c77626e5e
commit 2a88230ecc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.mdox.validate.yaml
View file

@ -1,6 +1,8 @@
version: 1 version: 1
timeout: "1m" timeout: "1m"
explicitLocalValidators: true
validators: validators:
# docs.github.com returns 403 if not in browser. Cannot curl as well. # docs.github.com returns 403 if not in browser. Cannot curl as well.
- regex: 'docs\.github\.com' - regex: 'docs\.github\.com'
@ -20,3 +22,6 @@ validators:
# Ignore GitHub container packages link as it returns 404 in curl, but works in browser # Ignore GitHub container packages link as it returns 404 in curl, but works in browser
- regex: 'https://github.com/prometheus-operator/prometheus-operator/pkgs/container/prometheus-operator' - regex: 'https://github.com/prometheus-operator/prometheus-operator/pkgs/container/prometheus-operator'
type: "ignore" type: "ignore"
# Ignore links to /img/ because the generated content will resolve them correctly.
- regex: '/img/.+'
type: ignore

0
Documentation/custom-metrics-elements.png → Documentation/img/custom-metrics-elements.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 163 KiB

After

Width:  |  Height:  |  Size: 163 KiB

4
Documentation/troubleshooting.md
View file

@ -50,7 +50,9 @@ When creating/deleting/modifying `ServiceMonitor` objects it is sometimes not as
A common problem related to `ServiceMonitor` identification by Prometheus is related to an incorrect tagging, that does not match the `Prometheus` custom resource definition scope, or lack of permission for the Prometheus `ServiceAccount` to *get, list, watch* `Services` and `Endpoints` from the target application being monitored. As a general guideline consider the diagram below, giving an example of a `Deployment` and `Service` called `my-app`, being monitored by Prometheus based on a `ServiceMonitor` named `my-service-monitor`: A common problem related to `ServiceMonitor` identification by Prometheus is related to an incorrect tagging, that does not match the `Prometheus` custom resource definition scope, or lack of permission for the Prometheus `ServiceAccount` to *get, list, watch* `Services` and `Endpoints` from the target application being monitored. As a general guideline consider the diagram below, giving an example of a `Deployment` and `Service` called `my-app`, being monitored by Prometheus based on a `ServiceMonitor` named `my-service-monitor`:
![flow diagram](custom-metrics-elements.png) <!-- do not change this link without verifying that the image will display correctly on https://prometheus-operator.dev -->
![flow diagram](/img/custom-metrics-elements.png)
Note: The `ServiceMonitor` references a `Service` (not a `Deployment`, or a `Pod`), by labels *and* by the port name in the `Service`. This *port name* is optional in Kubernetes, but must be specified for the `ServiceMonitor` to work. It is not the same as the port name on the `Pod` or container, although it can be. Note: The `ServiceMonitor` references a `Service` (not a `Deployment`, or a `Pod`), by labels *and* by the port name in the `Service`. This *port name* is optional in Kubernetes, but must be specified for the `ServiceMonitor` to work. It is not the same as the port name on the `Pod` or container, although it can be.

2
scripts/go.mod
View file

@ -4,7 +4,7 @@ go 1.18
require ( require (
github.com/brancz/gojsontoyaml v0.1.0 github.com/brancz/gojsontoyaml v0.1.0
github.com/bwplotka/mdox v0.9.0 github.com/bwplotka/mdox v0.9.1-0.20220712163347-7dcc385468d7
github.com/golangci/golangci-lint v1.46.2 github.com/golangci/golangci-lint v1.46.2
github.com/google/go-jsonnet v0.18.0 github.com/google/go-jsonnet v0.18.0
github.com/jsonnet-bundler/jsonnet-bundler v0.5.1 github.com/jsonnet-bundler/jsonnet-bundler v0.5.1

4
scripts/go.sum
View file

@ -223,8 +223,8 @@ github.com/breml/errchkjson v0.3.0 h1:YdDqhfqMT+I1vIxPSas44P+9Z9HzJwCeAzjB8PxP1x
github.com/breml/errchkjson v0.3.0/go.mod h1:9Cogkyv9gcT8HREpzi3TiqBxCqDzo8awa92zSDFcofU= github.com/breml/errchkjson v0.3.0/go.mod h1:9Cogkyv9gcT8HREpzi3TiqBxCqDzo8awa92zSDFcofU=
github.com/butuzov/ireturn v0.1.1 h1:QvrO2QF2+/Cx1WA/vETCIYBKtRjc30vesdoPUNo1EbY= github.com/butuzov/ireturn v0.1.1 h1:QvrO2QF2+/Cx1WA/vETCIYBKtRjc30vesdoPUNo1EbY=
github.com/butuzov/ireturn v0.1.1/go.mod h1:Wh6Zl3IMtTpaIKbmwzqi6olnM9ptYQxxVacMsOEFPoc= github.com/butuzov/ireturn v0.1.1/go.mod h1:Wh6Zl3IMtTpaIKbmwzqi6olnM9ptYQxxVacMsOEFPoc=
github.com/bwplotka/mdox v0.9.0 h1:NRrJNWGDUjA2dWeWiJv/4WNQZp5+OcVYIHz94T6ksxs= github.com/bwplotka/mdox v0.9.1-0.20220712163347-7dcc385468d7 h1:HfWBdOFK+Ya2az0ck4DM/mer9TyFpwwnbCw0uMxQ5ow=
github.com/bwplotka/mdox v0.9.0/go.mod h1:d9tSrvKyHqgb/IuvvhncvLzbV1SfSfhH56ct1TOYncw= github.com/bwplotka/mdox v0.9.1-0.20220712163347-7dcc385468d7/go.mod h1:d9tSrvKyHqgb/IuvvhncvLzbV1SfSfhH56ct1TOYncw=
github.com/campoy/embedmd v1.0.0/go.mod h1:oxyr9RCiSXg0M3VJ3ks0UGfp98BpSSGr0kpiX3MzVl8= github.com/campoy/embedmd v1.0.0/go.mod h1:oxyr9RCiSXg0M3VJ3ks0UGfp98BpSSGr0kpiX3MzVl8=
github.com/casbin/casbin/v2 v2.1.2/go.mod h1:YcPU1XXisHhLzuxH9coDNf2FbKpjGlbCg3n9yuLkIJQ= github.com/casbin/casbin/v2 v2.1.2/go.mod h1:YcPU1XXisHhLzuxH9coDNf2FbKpjGlbCg3n9yuLkIJQ=
github.com/cenkalti/backoff v2.2.1+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QHaoyV4aDUVVkXQJJJ3NXXM= github.com/cenkalti/backoff v2.2.1+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QHaoyV4aDUVVkXQJJJ3NXXM=