From 501ff2c4de9262bc4df3d60dcffc6d32d3465fc4 Mon Sep 17 00:00:00 2001 From: Yuvaraj Kakaraparthi Date: Mon, 27 Mar 2023 18:44:10 -0700 Subject: [PATCH] mirroring instructions for Cluster API --- docs/mirroring/README.md | 2 ++ docs/mirroring/cluster-api.md | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 docs/mirroring/cluster-api.md diff --git a/docs/mirroring/README.md b/docs/mirroring/README.md index e0e46e0..ade0b16 100644 --- a/docs/mirroring/README.md +++ b/docs/mirroring/README.md @@ -39,6 +39,7 @@ For specific tools we have these guides: - For cri-dockerd see: [cri-dockerd.md](./cri-dockerd.md) - For kubeadm see: [kubeadm.md](./kubeadm.md) - For kOps see: [kOps.md](./kOps.md) +- For Cluster API see: [cluster-api.md](./cluster-api.md) ## Mirroring Images @@ -128,6 +129,7 @@ For specific tools we have these guides: - For cri-dockerd see: [cri-dockerd.md](./cri-dockerd.md) - For kubeadm see: [kubeadm.md](./kubeadm.md) - For kOps see: [kOps.md](./kOps.md) +- For Cluster API see: [cluster-api.md](./cluster-api.md) [identifying-images]: #Identifying-Images-To-Mirror [mirroring-images]: #Mirroring-Images diff --git a/docs/mirroring/cluster-api.md b/docs/mirroring/cluster-api.md new file mode 100644 index 0000000..c9de6a3 --- /dev/null +++ b/docs/mirroring/cluster-api.md @@ -0,0 +1,21 @@ +# Mirroring with Cluster API + +## Identifying Images To Mirror + +You can use [`clusterctl`](https://cluster-api.sigs.k8s.io/clusterctl/overview.html) to list the images used by Cluster API and the Cluster API provider in use: +``` +clusterctl init list-images --infrastructure +``` +For more details see: +https://cluster-api.sigs.k8s.io/clusterctl/commands/additional-commands.html#clusterctl-init-list-images + +## Mirroring Images + +See our general list of [mirroring options](./README.md#Mirroring-Images) + +## Using Mirrored Images + +To use Cluster API with mirrored images, you can configure clusterctl to use image overrides. + +For more details see: +https://cluster-api.sigs.k8s.io/clusterctl/configuration.html#image-overrides