From 2180c58e6299a90aee670675daea5140552d2fee Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 9 Feb 2025 22:27:02 +0900 Subject: [PATCH] Update docs for Prometheus: move the description for Docker image compatibility Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 9 +++++++++ docs/configuring-playbook-prometheus-nginxlog.md | 9 --------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 7b97fb4ba..e37175569 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -73,6 +73,15 @@ If you enable Grafana, a dedicated `NGINX PROXY` Grafana dashboard will be creat **Note**: nginx is only used internally by this Ansible playbook. With Traefik being our default reverse-proxy, collecting nginx metrics is less relevant. +#### Docker image compatibility (optional) + +At the moment of writing only images for `amd64` and `arm64` architectures are available. The playbook currently does not support [self-building](./self-building.md) a container image on other architectures. You can however use a custom-build image by setting: + +```yaml +matrix_prometheus_nginxlog_exporter_docker_image_arch_check_enabled: false +matrix_prometheus_nginxlog_exporter_docker_image: path/to/docker/image:tag +``` + ### Extending the configuration There are some additional things you may wish to configure about Prometheus. diff --git a/docs/configuring-playbook-prometheus-nginxlog.md b/docs/configuring-playbook-prometheus-nginxlog.md index 244d124b7..6689d0d26 100644 --- a/docs/configuring-playbook-prometheus-nginxlog.md +++ b/docs/configuring-playbook-prometheus-nginxlog.md @@ -25,15 +25,6 @@ When using an external Prometheus server, you'll need to expose metrics publicly For password-protection, use or (`matrix_prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_enabled` and `matrix_prometheus_nginxlog_exporter_container_labels_metrics_middleware_basic_auth_users`). -### Docker Image Compatibility (optional) - -At the moment of writing only images for `amd64` and `arm64` architectures are available. The playbook currently does not support [self-building](./self-building.md) a container image on other architectures. You can however use a custom-build image by setting: - -```yaml -matrix_prometheus_nginxlog_exporter_docker_image_arch_check_enabled: false -matrix_prometheus_nginxlog_exporter_docker_image: path/to/docker/image:tag -``` - ### Extending the configuration There are some additional things you may wish to configure about the component.