Update installer-reference.md (#5585) (#5594)

* Update installer-reference.md * ci: auto-formatting prettier issues * docs: edit example * docs: add diagram example * Optimised images with calibre/image-actions * docs: update image format * Optimised images with calibre/image-actions * docs: update image * docs: update image format * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions --------- Co-authored-by: antongisli <[email protected]> Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Lenny Chen <[email protected]> (cherry picked from commit e02c694) Co-authored-by: antongisli <[email protected]>
spectrocloud · Jan 28, 2025 · e2eecbb · e2eecbb
1 parent b85c47a
commit e2eecbb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md b/docs/docs-content/clusters/edge/edge-configuration/installer-reference.md
@@ -128,7 +128,7 @@ stylus:
 #### Registry Mapping Rules
 
 Use registry mapping rules to map a domain name to an external registry. The `registryMappingRules` parameter accepts a
-list of key-value pairs where the key is the domain name and the value is URL mapping to the external registry.
+list of key-value pairs where the key is the domain name and the value is a URL mapping to the external registry.
 
 Below is an example of registry mapping rules. The registry in the code snippet, `example.registry.com/internal-images`
 is assumed to contain the images that are mapped from the external registries.
@@ -148,6 +148,13 @@ stylus:
       "grc.io/spectro-images-public": "example.registry.com/internal-images"
 ```
 
+All matched portion on the source URL will be replaced with the mapped value and any unmatched path is preserved. Using
+the example in the following diagram, if an image named `alpine:latest` is stored at
+`somedomain.com/somepath/example-repo/alpine:latest`, the mapping rules will rewrite image pulls so that they reference
+`targetdomain.com/other/path/example-repo/alpine:latest`.
+
+![Example of registry mapping rules](/clusters_edge_edge-configuration_installer-reference_registry-mapping.webp)
+
 ##### Airgap Environment
 
 In an airgap environment, use the `registryMappingRules` parameter to map domain names to external registries that were

diff --git a/...ts/docs/images/clusters_edge_edge-configuration_installer-reference_registry-mapping.webp b/...ts/docs/images/clusters_edge_edge-configuration_installer-reference_registry-mapping.webp