> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siderolabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

> RegistryMirrorConfig configures an image registry mirror.

# RegistryMirrorConfig

```yaml theme={null}
apiVersion: v1alpha1
kind: RegistryMirrorConfig
name: registry.k8s.io # Registry name to apply the mirror configuration to.
# List of mirror endpoints for the registry.
endpoints:
    - url: https://my-private-registry.local:5000 # The URL of the registry mirror endpoint.
    - url: http://my-harbor/v2/registry-k8s.io/ # The URL of the registry mirror endpoint.
      overridePath: true # Use endpoint path as supplied, without adding `/v2/` suffix.
skipFallback: true # Skip fallback to the original registry if none of the mirrors are available
```

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`name`</td>
      <td>string</td>
      <td>Registry name to apply the mirror configuration to.<br /><br />Registry name is the first segment of image identifier, with 'docker.io'<br />being default one.<br /><br />A special name '\*' can be used to define mirror configuration<br />that applies to all registries.</td>

      <td />
    </tr>

    <tr>
      <td>`endpoints`</td>
      <td><a href="#endpoints%5B%5D">RegistryEndpoint</a></td>
      <td>List of mirror endpoints for the registry.<br />Mirrors will be used in the order they are specified,<br />falling back to the default registry is `skipFallback` is not set to true.</td>

      <td />
    </tr>

    <tr>
      <td>`skipFallback`</td>
      <td>bool</td>
      <td>Skip fallback to the original registry if none of the mirrors are available<br />or contain the requested image.</td>

      <td />
    </tr>
  </tbody>
</table>

## endpoints\[]

RegistryEndpoint defines a registry mirror endpoint.

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`url`</td>
      <td>URL</td>
      <td>The URL of the registry mirror endpoint.</td>

      <td />
    </tr>

    <tr>
      <td>`overridePath`</td>
      <td>bool</td>
      <td>Use endpoint path as supplied, without adding `/v2/` suffix.</td>

      <td />
    </tr>
  </tbody>
</table>