From c538a2209992e29ba2930da035f20241e2f051c0 Mon Sep 17 00:00:00 2001 From: Simon Hammes Date: Thu, 16 Jul 2026 21:44:02 +0200 Subject: [PATCH] docs: fix dead links --- docs/development/integration_testing.md | 8 ++++---- docs/running.md | 4 ++-- docs/runtime_options.md | 2 +- docs/storage/README.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/development/integration_testing.md b/docs/development/integration_testing.md index 6185db6985..22d921c17f 100644 --- a/docs/development/integration_testing.md +++ b/docs/development/integration_testing.md @@ -2,7 +2,7 @@ ## Docker-based tests -The cAdvisor integration tests are run per-pr using [Github Actions](https://help.github.com/en/actions). Workflow configuration can be found at [.github/workflows/test.yml](.github/workflows/test.yml). Tests are executed in Docker containers run on MS Azure virtual machines. +The cAdvisor integration tests are run per-pr using [Github Actions](https://help.github.com/en/actions). Workflow configuration can be found at [.github/workflows/test.yml](../../.github/workflows/test.yml). Tests are executed in Docker containers run on MS Azure virtual machines. To run them locally Docker must be installed on your machine. Following command allows you to execute default suite of integration tests: @@ -12,7 +12,7 @@ make docker-test-integration Build scripts take care of building cAdvisor and integration tests, and executing them against running cAdvisor process. -In order to run non-default tests suites (e.g. such that rely on third-party C libraries) you must source one of the files available at [build/config](build/config), e.g.: +In order to run non-default tests suites (e.g. such that rely on third-party C libraries) you must source one of the files available at [build/config](../../build/config), e.g.: ``` source build/config/libpfm4.sh && make docker-test-integration @@ -22,11 +22,11 @@ All the necessary packages will be installed, build flags will be applied and ad ## VM-base tests (legacy) -The cAdvisor integration tests are run per-pr using the [kubernetes node-e2e testing framework](https://github.com/kubernetes/community/blob/master/contributors/devel/e2e-node-tests.md) on GCE instances. To make use of this framework, complete the setup of GCP described in the node-e2e testing framework, clone `k8s.io/kubernetes`, and from that repository run: +The cAdvisor integration tests are run per-pr using the [kubernetes node-e2e testing framework](https://github.com/kubernetes/community/blob/main/contributors/devel/sig-node/e2e-node-tests.md) on GCE instances. To make use of this framework, complete the setup of GCP described in the node-e2e testing framework, clone `k8s.io/kubernetes`, and from that repository run: ``` $ make test-e2e-node TEST_SUITE=cadvisor REMOTE=true ``` -This will create a VM, build cadvisor, run integration tests on that VM, retrieve logs, and will clean up the test afterwards. See the [node-e2e testing documentation](https://github.com/kubernetes/community/blob/master/contributors/devel/e2e-node-tests.md) for more running options. +This will create a VM, build cadvisor, run integration tests on that VM, retrieve logs, and will clean up the test afterwards. See the [node-e2e testing documentation](https://github.com/kubernetes/community/blob/main/contributors/devel/sig-node/e2e-node-tests.md) for more running options. To simply run the tests against an existing cAdvisor: diff --git a/docs/running.md b/docs/running.md index e8f9b356ac..8ccb6dc49b 100644 --- a/docs/running.md +++ b/docs/running.md @@ -26,11 +26,11 @@ otherwise cAdvisor can not connect to docker daemon. - If cadvisor scrapes `process` metrics due to `--disable_metrics` or `--enable_metrics` options, you need to add `--pid=host` and `--privileged` for `docker run` to get `/proc/pid/fd` path in host. - If cAdvisor needs to be run in Docker container without `--privileged` option it is possible to add host devices to container using `--dev` and specify security options using `--security-opt` with secure computing mode (seccomp). - For details related to seccomp please [see](https://docs.docker.com/engine/security/seccomp/), the default Docker profile can be found [here](https://github.com/moby/moby/blob/master/profiles/seccomp/default.json). + For details related to seccomp please [see](https://docs.docker.com/engine/security/seccomp/), the default Docker profile can be found [here](https://github.com/moby/profiles/blob/main/seccomp/default.json). For example to run cAdvisor with perf support in Docker container without `--privileged` option it is required to: - Set perf_event_paranoid using `sudo sysctl kernel.perf_event_paranoid=-1`, see [documentation](https://www.kernel.org/doc/Documentation/sysctl/kernel.txt) - - Add "perf_event_open" syscall into syscalls array with the action: "SCMP_ACT_ALLOW" in [default Docker profile](https://github.com/moby/moby/blob/master/profiles/seccomp/default.json) + - Add "perf_event_open" syscall into syscalls array with the action: "SCMP_ACT_ALLOW" in [default Docker profile](https://github.com/moby/profiles/blob/main/seccomp/default.json) - Run Docker container with following options: ``` docker run \ diff --git a/docs/runtime_options.md b/docs/runtime_options.md index f77551b7cc..61a21fb2bc 100644 --- a/docs/runtime_options.md +++ b/docs/runtime_options.md @@ -17,7 +17,7 @@ This document describes a set of runtime flags available in cAdvisor. ## Container Hints -Container hints are a way to pass extra information about a container to cAdvisor. In this way cAdvisor can augment the stats it gathers. For more information on the container hints format see its [definition](../container/common/container_hints.go). Note that container hints are only used by the raw container driver today. +Container hints are a way to pass extra information about a container to cAdvisor. In this way cAdvisor can augment the stats it gathers. For more information on the container hints format see its [definition](../lib/container/common/container_hints.go). Note that container hints are only used by the raw container driver today. ``` --container_hints="/etc/cadvisor/container_hints.json": location of the container hints file diff --git a/docs/storage/README.md b/docs/storage/README.md index a649bbceee..be982716d6 100644 --- a/docs/storage/README.md +++ b/docs/storage/README.md @@ -4,7 +4,7 @@ cAdvisor supports exporting stats to various storage driver plugins. To enable a ## Storage drivers -- [BigQuery](https://cloud.google.com/bigquery/). See the [documentation](../../storage/bigquery/README.md) for usage. +- [BigQuery](https://cloud.google.com/bigquery/). See the [documentation](../../cmd/internal/storage/bigquery/README.md) for usage. - [ElasticSearch](https://www.elastic.co/). See the [documentation](elasticsearch.md) for usage and examples. - [InfluxDB](https://influxdb.com/). See the [documentation](influxdb.md) for usage and examples. - [Kafka](http://kafka.apache.org/). See the [documentation](kafka.md) for usage.