Skip to content

Commit 6e96172

Browse files
authored
Merge pull request #2126 from mboersma/ref-image-availability
Add warning to docs about reference image availability
2 parents 16a804d + 07b6485 commit 6e96172

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

docs/book/src/topics/custom-images.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,35 @@ This document will help you get a CAPZ Kubernetes cluster up and running with yo
66

77
An *image* defines the operating system and Kubernetes components that will populate the disk of each node in your cluster.
88

9-
By default, images offered by "capi" in the [Azure Marketplace][azure-marketplace] are used. You can list these *reference images* with this command:
9+
By default, images offered by "capi" in the [Azure Marketplace][azure-marketplace] are used.
10+
11+
You can list these *reference images* with this command:
1012

1113
```bash
1214
az vm image list --publisher cncf-upstream --offer capi --all -o table
1315
```
1416

15-
Note: These images are not updated for security fixes and it is recommended to always use the latest patch version for the Kubernetes version you wish to run. For production-like environments, and for more control over your nodes, it is highly recommended to build and use your own custom images.
17+
It is recommended to use the latest patch release of Kubernetes for a [supported minor release][supported-k8s].
18+
19+
<aside class="note warning">
20+
21+
<h1> Availability </h1>
22+
23+
The Cluster API for Azure team publishes *reference images* for each Kubernetes release, for both Linux and Windows.
24+
25+
Reference images for versions of Kubernetes which have known security issues or which are no longer [supported by Cluster API][supported-capi] will be removed from the Azure Marketplace.
26+
27+
</aside>
28+
29+
<aside class="note warning">
30+
31+
<h1> Security </h1>
32+
33+
The reference images are not updated with security fixes. They are intended only to facilitate testing and to help users try out Cluster API for Azure.
34+
35+
The reference images should not be used in a production environment. It is highly recommended to [maintain your own custom image](#building-a-custom-image) instead.
36+
37+
</aside>
1638

1739
## Building a custom image
1840

@@ -159,4 +181,6 @@ spec:
159181
[kubeadm-preflight-checks]: https://github.com/kubernetes/kubeadm/blob/master/docs/design/design_v1.10.md#preflight-checks
160182
[replication-recommendations]: https://docs.microsoft.com/azure/virtual-machines/linux/shared-image-galleries#scaling
161183
[shared-image-gallery]: https://docs.microsoft.com/azure/virtual-machines/linux/shared-image-galleries
184+
[supported-capi]: https://cluster-api.sigs.k8s.io/reference/versions.html#supported-kubernetes-versions
185+
[supported-k8s]: https://kubernetes.io/releases/version-skew-policy/#supported-versions
162186
[upgrading-workload-clusters]: https://cluster-api.sigs.k8s.io/tasks/kubeadm-control-plane.html#upgrading-workload-clusters

0 commit comments

Comments
 (0)