diff --git a/docs/canonicalk8s/index.md b/docs/canonicalk8s/index.md index f84017892..772823ec7 100644 --- a/docs/canonicalk8s/index.md +++ b/docs/canonicalk8s/index.md @@ -25,7 +25,7 @@ Deploy from Snap package Deploy with Juju Deploy with Cluster API Community -Release notes +Release notes ``` diff --git a/docs/canonicalk8s/release.md b/docs/canonicalk8s/release.md deleted file mode 100644 index ff4bc2dc1..000000000 --- a/docs/canonicalk8s/release.md +++ /dev/null @@ -1,2 +0,0 @@ -```{include} src/snap/reference/releases.md -``` \ No newline at end of file diff --git a/docs/src/snap/reference/index.md b/docs/src/snap/reference/index.md index bd7a9217f..3cd928b05 100644 --- a/docs/src/snap/reference/index.md +++ b/docs/src/snap/reference/index.md @@ -22,7 +22,6 @@ proxy troubleshooting architecture Community -roadmap ``` ## Other documentation types diff --git a/docs/src/snap/reference/releases.md b/docs/src/snap/reference/releases.md index b6035eb58..f4a4618e4 100644 --- a/docs/src/snap/reference/releases.md +++ b/docs/src/snap/reference/releases.md @@ -1,39 +1,24 @@ # Release notes -## Rolling preview release +This is an index page for all the available releases of {{product}}. Each entry +will take you to version specific information including new features, bug fixes +and backwards-incompatible changes. -In advance of a GA release of {{product}}, you can still install and -try out the newest distribution of Kubernetes. +## Releases -You need two commands to get a single node cluster, one for installation and -another for cluster bootstrap. You can try it out now on your console by -installing the k8s snap from the beta channel: +```{toctree} +:titlesonly: +:maxdepth: 2 +/src/snap/reference/versions/1.31 ``` -sudo snap install k8s --channel=1.30-classic/beta --classic -sudo k8s bootstrap -``` - -Currently {{product}} is working towards general availability, but you -can install it now to try: -- **Clustering** - need high availability or just an army of worker nodes? - {{product}} is eminently scalable, see the [tutorial on adding - more nodes][nodes]. -- **Networking** - Our built-in network component allows cluster administrators - to automatically scale and secure network policies across the cluster. Find - out more in our [how-to guides][networking]. -- **Observability** - {{product}} ships with [COS Lite], so you never - need to wonder what your cluster is actually doing. See the [observability - documentation] for more details. -Follow along with the [tutorial] to get started! +## Release policy and schedule +Our release cadence and support window for all Kubernetes-related products are +available on the main Ubuntu website, on the [release cycle page][]. -[tutorial]: ../tutorial/getting-started -[nodes]: ../tutorial/add-remove-nodes -[COS Lite]: https://charmhub.io/cos-lite -[networking]: ../howto/networking/index -[observability documentation]: ../../charm/howto/cos-lite \ No newline at end of file +[release cycle page]: https://ubuntu.com/about/release-cycle#canonical-kubernetes-release-cycle \ No newline at end of file diff --git a/docs/src/snap/reference/roadmap.md b/docs/src/snap/reference/roadmap.md deleted file mode 100644 index a97ae5657..000000000 --- a/docs/src/snap/reference/roadmap.md +++ /dev/null @@ -1,22 +0,0 @@ -# Roadmap - -The {{product}} team enthusiastically supports the idea of a public -roadmap, letting everyone know the headline features we are working on and the -future direction and priorities of the project. - -Our roadmap matches the cadence of the Ubuntu release cycle, so `24.10` is the -same as the release date for Ubuntu 24.10. This does not precisely map to the -release cycle of Kubernetes versions, so please consult the [release notes] for -specifics of what features have been delivered. - - -``` {csv-table} {{product}} public roadmap - :file: ../../assets/roadmap.csv - :widths: 30, 30 - :header-rows: 1 -``` - - - - -[release notes]: ./releases \ No newline at end of file diff --git a/docs/src/snap/reference/versions/1.31.md b/docs/src/snap/reference/versions/1.31.md new file mode 100644 index 000000000..dfd26183f --- /dev/null +++ b/docs/src/snap/reference/versions/1.31.md @@ -0,0 +1,91 @@ +# 1.31 + +**{{product}} 1.31 - Release notes - XX November 2024** + +Welcome to the initial release of {{product}}! +These release notes cover the highlights of this release. + +## Requirements and compatibility + +{{product}} can be installed on a variety of operating systems using several +methods. For specific requirements, see the [Installation guides]. + +## What’s new + +- **Clustering** - need high availability or just an army of worker nodes? + {{product}} is eminently scalable, see the [tutorial on adding + more nodes][nodes]. +- **Networking** - Our built-in network component allows cluster administrators + to automatically scale and secure network policies across the cluster. Find + out more in our [how-to guides][networking]. +- **Observability** - {{product}} ships with [COS Lite], so you never + need to wonder what your cluster is actually doing. See the [observability + documentation] for more details. +- **\[Kubernetes\] AppArmor** - AppArmor support is now stable in Kubernetes + 1.31. Protect your containers using AppArmor by setting the + `appArmorProfile.type` field in the container's `securityContext`. See the + upstream docs [AppArmor tutorial][]. + +## Also in this release + +- Make use of AWS native storage ([see guide][]). +- Customise cluster bootstrap arguments ([see bootstrap configuration][]). + +## Deprecated features + + - **\[Kubernetes\] SHA-1 signature support** - See the + [upstream note][SHA-1] regarding SHA-1 signatures. + +## Fixed bugs and issues + + - [k8sd false positive error message](https://github.com/canonical/k8s-snap/issues/777) + +## Known issues + + - [] + +## Contributors + +Many thanks to [@neoaggelos], [@bschimke95], [@evilnick], +[@eaudetcobello], [@louiseschmidtgen], [@mateoflorido], [@berkayoz], +[@addyess], [@HomayoonAlimohammadi], [@ktsakalozos], [@kwmonroe], [@maci3jka], +[@petrutlucian94], [@nhennigan], [@claudiubelu], [@aznashwan], [@YanisaHS], +[@hemanthnakkina], [@dulmandakh], [@perk]. + + + +[Installation guides]: ../../howto/install/index +[tutorial]: ../../tutorial/getting-started +[nodes]: ../../tutorial/add-remove-nodes +[COS Lite]: https://charmhub.io/cos-lite +[networking]: ../../howto/networking/index +[observability documentation]: ../../../charm/howto/cos-lite +[release cycle page]: https://ubuntu.com/about/release-cycle#canonical-kubernetes-release-cycle +[AppArmor tutorial]: https://kubernetes.io/docs/tutorials/security/apparmor/ +[SHA-1]: https://kubernetes.io/blog/2024/08/13/kubernetes-v1-31-release/#a-note-about-sha-1-signature-support +[see guide]: ../../howto/storage/cloud/ +[see bootstrap configuration]:../bootstrap-config-reference.md + + +[@perk]: https://github.com/perk +[@neoaggelos]: https://github.com/neoaggelos +[@bschimke95]: https://github.com/bschimke95 +[@evilnick]: https://github.com/evilnick +[@eaudetcobello]: https://github.com/eaudetcobello +[@louiseschmidtgen]: https://github.com/louiseschmidtgen +[@mateoflorido]: https://github.com/mateoflorido +[@berkayoz]: https://github.com/berkayoz +[@addyess]: https://github.com/addyess +[@HomayoonAlimohammadi]: https://github.com/HomayoonAlimohammadi +[@ktsakalozos]: https://github.com/ktsakalozos +[@kwmonroe]: https://github.com/kwmonroe +[@maci3jka]: https://github.com/maci3jka +[@petrutlucian94]: https://github.com/petrutlucian94 +[@nhennigan]: https://github.com/nhennigan +[@claudiubelu]: https://github.com/claudiubelu +[@aznashwan]: https://github.com/aznashwan +[@YanisaHS]: https://github.com/YanisaHS +[@hemanthnakkina]: https://github.com/hemanthnakkina +[@dulmandakh]: https://github.com/dulmandakh + +