diff --git a/docs/features/image_name_substitution.md b/docs/features/image_name_substitution.md index 0cf2d4cf8f0..45ea6038b49 100644 --- a/docs/features/image_name_substitution.md +++ b/docs/features/image_name_substitution.md @@ -5,7 +5,7 @@ Testcontainers supports automatic substitution of Docker image names. This allows replacement of an image name specified in test code with an alternative name - for example, to replace the name of a Docker Hub image dependency with an alternative hosted on a private image registry. -This is advisable to avoid [Docker Hub rate limiting](./pull_rate_limiting.md), and some companies will prefer this for policy reasons. +This is advisable to avoid [Docker Hub rate limiting](../supported_docker_environment/image_registry_rate_limiting.md), and some companies will prefer this for policy reasons. This page describes four approaches for image name substitution: @@ -14,7 +14,7 @@ This page describes four approaches for image name substitution: * [Developing a custom function for transforming image names on the fly](#developing-a-custom-function-for-transforming-image-names-on-the-fly) * [Overriding image names individually in configuration](#overriding-image-names-individually-in-configuration) -It is assumed that you have already set up a private registry hosting [all the Docker images your build requires](./pull_rate_limiting.md#which-images-are-used-by-testcontainers). +It is assumed that you have already set up a private registry hosting [all the Docker images your build requires](../supported_docker_environment/image_registry_rate_limiting.md#which-images-are-used-by-testcontainers). @@ -25,7 +25,7 @@ Consider this if: * You use only a few images and updating code is not a chore * All developers and CI machines in your organisation have access to a common registry server -* You also use one of the automated mechanisms to substitute [the images that Testcontainers itself requires](./pull_rate_limiting.md#which-images-are-used-by-testcontainers) +* You also use one of the automated mechanisms to substitute [the images that Testcontainers itself requires](../supported_docker_environment/image_registry_rate_limiting.md#which-images-are-used-by-testcontainers) This approach simply entails modifying test code manually, e.g. changing: diff --git a/docs/features/pull_rate_limiting.md b/docs/supported_docker_environment/image_registry_rate_limiting.md similarity index 81% rename from docs/features/pull_rate_limiting.md rename to docs/supported_docker_environment/image_registry_rate_limiting.md index be266545afb..a136a12b25e 100644 --- a/docs/features/pull_rate_limiting.md +++ b/docs/supported_docker_environment/image_registry_rate_limiting.md @@ -11,9 +11,9 @@ As of the current version of Testcontainers ({{latest_version}}): * every image directly used by your tests * images pulled by Testcontainers itself to support functionality: - * [`testcontainers/ryuk`](https://hub.docker.com/r/testcontainers/ryuk) - performs fail-safe cleanup of containers, and always required (unless [Ryuk is disabled](./configuration.md#disabling-ryuk)) - * [`alpine`](https://hub.docker.com/r/_/alpine) - used to check whether images can be pulled at startup, and always required (unless [startup checks are disabled](./configuration.md#disabling-the-startup-checks)) - * [`testcontainers/sshd`](https://hub.docker.com/r/testcontainers/sshd) - required if [exposing host ports to containers](./networking.md#exposing-host-ports-to-the-container) + * [`testcontainers/ryuk`](https://hub.docker.com/r/testcontainers/ryuk) - performs fail-safe cleanup of containers, and always required (unless [Ryuk is disabled](../features/configuration.md#disabling-ryuk)) + * [`alpine`](https://hub.docker.com/r/_/alpine) - used to check whether images can be pulled at startup, and always required (unless [startup checks are disabled](../features/configuration.md#disabling-the-startup-checks)) + * [`testcontainers/sshd`](https://hub.docker.com/r/testcontainers/sshd) - required if [exposing host ports to containers](../features/networking.md#exposing-host-ports-to-the-container) * [`testcontainers/vnc-recorder`](https://hub.docker.com/r/testcontainers/vnc-recorder) - required if using [Webdriver containers](../modules/webdriver_containers.md) and using the screen recording feature * [`docker/compose`](https://hub.docker.com/r/docker/compose) - required if using [Docker Compose](../modules/docker_compose.md) * [`alpine/socat`](https://hub.docker.com/r/alpine/socat) - required if using [Docker Compose](../modules/docker_compose.md) diff --git a/mkdocs.yml b/mkdocs.yml index 0fa9b2b4c91..90404a80749 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,6 +36,7 @@ nav: - features/container_logs.md - features/creating_images.md - features/configuration.md + - features/image_name_substitution.md - features/advanced_options.md - Modules: - Databases: @@ -86,6 +87,7 @@ nav: - supported_docker_environment/continuous_integration/bitbucket_pipelines.md - supported_docker_environment/windows.md - supported_docker_environment/logging_config.md + - supported_docker_environment/image_registry_rate_limiting.md - Getting help: getting_help.md - Contributing: - contributing.md