Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[release-1.9] 📖 README.md cherry-pick changes related to vm templates #2961

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 26 additions & 87 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,93 +55,32 @@ Basically:

## Kubernetes versions with published OVAs

Note: These OVAs 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, it is
highly recommended to build and use your own custom images.

<table>
<tr>
<th>Kubernetes</th>
<th>Ubuntu 18.04</th>
<th>Ubuntu 20.04</th>
<th>Ubuntu 22.04</th>
<th>Photon 3</th>
<th>Photon 5</th>
<th>Flatcar Stable</th>
</tr>

<tr>
<td>v1.24.11</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.24.11/ubuntu-1804-kube-v1.24.11.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.24.11/ubuntu-1804-kube-v1.24.11.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.24.11/ubuntu-2004-kube-v1.24.11.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.24.11/ubuntu-2004-kube-v1.24.11.ova.sha256">sha256</a></td>
<td>N/A</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.24.11/photon-3-kube-v1.24.11.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.24.11/photon-3-kube-v1.24.11.ova.sha256">sha256</a></td>
<td>N/A</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.24.11/flatcar-stable-3374.2.5-kube-v1.24.11.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.24.11/flatcar-stable-3374.2.5-kube-v1.24.11.ova.sha256">sha256</a></td>
</tr>

<tr>
<td>v1.25.7</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.25.7/ubuntu-1804-kube-v1.25.7.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.25.7/ubuntu-1804-kube-v1.25.7.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.25.7/ubuntu-2004-kube-v1.25.7.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.25.7/ubuntu-2004-kube-v1.25.7.ova.sha256">sha256</a></td>
<td>N/A</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.25.7/photon-3-kube-v1.25.7.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.25.7/photon-3-kube-v1.25.7.ova.sha256">sha256</a></td>
<td>N/A</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.25.7/flatcar-stable-3374.2.5-kube-v1.25.7.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.25.7/flatcar-stable-3374.2.5-kube-v1.25.7.ova.sha256">sha256</a></td>
</tr>

<tr>
<td>v1.26.2</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.26.2/ubuntu-1804-kube-v1.26.2.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.26.2/ubuntu-1804-kube-v1.26.2.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.26.2/ubuntu-2004-kube-v1.26.2.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.26.2/ubuntu-2004-kube-v1.26.2.ova.sha256">sha256</a></td>
<td>N/A</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.26.2/photon-3-kube-v1.26.2.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.26.2/photon-3-kube-v1.26.2.ova.sha256">sha256</a></td>
<td>N/A</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.26.2/flatcar-stable-3374.2.5-kube-v1.26.2.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.26.2/flatcar-stable-3374.2.5-kube-v1.26.2.ova.sha256">sha256</a></td>
</tr>

<tr>
<td>v1.27.3</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.27.3/ubuntu-1804-kube-v1.27.3.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.27.3/ubuntu-1804-kube-v1.27.3.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.27.3/ubuntu-2004-kube-v1.27.3.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.27.3/ubuntu-2004-kube-v1.27.3.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.27.3/ubuntu-2204-kube-v1.27.3.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.27.3/ubuntu-2204-kube-v1.27.3.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.27.3/photon-3-kube-v1.27.3.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.27.3/photon-3-kube-v1.27.3.ova.sha256">sha256</a></td>
<td>N/A</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.27.3/flatcar-stable-3510.2.4-kube-v1.27.3.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.27.3/flatcar-stable-3510.2.4-kube-v1.27.3.ova.sha256">sha256</a></td>
</tr>

<tr>
<td>v1.28.0</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.28.0/ubuntu-1804-kube-v1.28.0.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.28.0/ubuntu-1804-kube-v1.28.0.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.28.0/ubuntu-2004-kube-v1.28.0.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.28.0/ubuntu-2004-kube-v1.28.0.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.28.0/ubuntu-2204-kube-v1.28.0.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.28.0/ubuntu-2204-kube-v1.28.0.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.28.0/photon-3-kube-v1.28.0.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.28.0/photon-3-kube-v1.28.0.ova.sha256">sha256</a></td>
<td>N/A</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.28.0/flatcar-stable-3510.2.6-kube-v1.28.0.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.28.0/flatcar-stable-3510.2.6-kube-v1.28.0.ova.sha256">sha256</a></td>
</tr>

<tr>
<td>v1.29.0</td>
<td>N/A</td>
<td>N/A</td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.29.0/ubuntu-2204-kube-v1.29.0.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.29.0/ubuntu-2204-kube-v1.29.0.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.29.0/photon-3-kube-v1.29.0.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.29.0/photon-3-kube-v1.29.0.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.29.0/photon-5-kube-v1.29.0.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.29.0/photon-5-kube-v1.29.0.ova.sha256">sha256</a></td>
<td><a href="https://storage.googleapis.com/capv-templates/v1.29.0/flatcar-stable-3602.2.3-kube-v1.29.0.ova">ova</a>, <a href="https://storage.googleapis.com/capv-templates/v1.29.0/flatcar-stable-3602.2.3-kube-v1.29.0.ova.sha256">sha256</a></td>
</tr>

</table>

A full list of the published machine images for CAPV may be obtained with the following command:

```shell
gsutil ls gs://capv-templates/*
```

Or, to produce a list of URLs for the same image files (and their checksums), the following command may be used:

```shell
gsutil ls gs://capv-templates/*/*.{ova,sha256} | sed 's~^gs://~https://storage.googleapis.com/~'
```
**Note:** These OVAs are **not updated for security fixes** and it is recommended to always use the latest
versions for distribution packages and patch version for the Kubernetes version you wish to run. For
production-like environments, it is highly recommended to build and use your own custom images.

**Note:** We recently moved the OVAs from the community GCP project to [Github releases](https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases). Going forward new OVAs will only be uploaded to a dedicated Github release with the name `templates/<Kubernetes Version>`.

**Note:** Big OVAs will be split into multiple parts. To use them please download all parts and use `cat part1 part2 part3 > out.ova` to join them again.

| Kubernetes | Ubuntu 18.04 | Ubuntu 20.04 | Ubuntu 22.04 | Photon 3 | Photon 5 | Flatcar Stable |
|:-----------|:------------:|:------------:|:------------:|:--------:|:--------:|:--------------:|
| [v1.24.11] | ✓ | ✓ | | ✓ | | ✓ |
| [v1.25.7] | ✓ | ✓ | | ✓ | | ✓ |
| [v1.26.2] | ✓ | ✓ | | ✓ | | ✓ |
| [v1.27.3] | ✓ | ✓ | ✓ | ✓ | | ✓ |
| [v1.28.0] | ✓ | ✓ | ✓ | ✓ | | ✓ |
| [v1.29.0] | | | ✓ | ✓ | ✓ | ✓ |

[v1.24.11]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/tag/templates/v1.24.11
[v1.25.7]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/tag/templates/v1.25.7
[v1.26.2]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/tag/templates/v1.26.2
[v1.27.3]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/tag/templates/v1.27.3
[v1.28.0]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/tag/templates/v1.28.0
[v1.29.0]: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/tag/templates/v1.29.0

A full list of the published machine images for CAPV can be found by [searching for releases](https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases?q=templates%2F&expanded=true)
on the repository having the prefix `templates/` and taking a look at the available assets.

## Documentation

Expand Down
Loading