Skip to content

Commit 3de12c3

Browse files
committed
docs: new registryMirror page
1 parent 8742496 commit 3de12c3

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
+++
2+
title = "Registry Mirror"
3+
icon = "fa-solid fa-eye"
4+
+++
5+
6+
By leveraging CAPI cluster lifecycle hooks, this handler deploys an OCI [Distribution] (Distribution) registry
7+
as a mirror on the new cluster at the `AfterControlPlaneInitialized` phase.
8+
9+
Deployment of registry mirror is opt-in via the [provider-specific cluster configuration]({{< ref ".." >}}).
10+
11+
The hook will use the [Cluster API Add-on Provider for Helm] to deploy the registry mirror resources.
12+
13+
## Example
14+
15+
To enable deployment of the registry mirror on a cluster, specify the following values:
16+
17+
```yaml
18+
apiVersion: cluster.x-k8s.io/v1beta1
19+
kind: Cluster
20+
metadata:
21+
name: <NAME>
22+
spec:
23+
topology:
24+
variables:
25+
- name: clusterConfig
26+
value:
27+
addons:
28+
registryMirror: {}
29+
```
30+
31+
[Distribution]: https://github.com/distribution/distribution
32+
[Cluster API Add-on Provider for Helm]: https://github.com/kubernetes-sigs/cluster-api-addon-provider-helm

0 commit comments

Comments
 (0)