Prepare release notes for 1.29+ck2 and now 1.29+ck3 (#843)

* Prepare release notes for 1.29+ck2, update generator templates * insert a line feed so as to not break web renderer * Beginning notes on how to reconfigure for keystone in 1.29 (#845) * Correct command mistakes in keystone upgrade nodes, add Day2 Ops section * Add installation instructions to use LDAP or Keystone Auth for fresh installations * Applied review comments from Nick --------- Co-authored-by: Nick Veitch <[email protected]> Co-authored-by: Kevin W Monroe <[email protected]>
charmed-kubernetes · Jun 25, 2024 · 90106db · 90106db
1 parent 2565a5d
commit 90106db
Show file tree

Hide file tree

Showing 12 changed files with 614 additions and 156 deletions.
diff --git a/assets/keystone.yaml b/assets/keystone.yaml
@@ -1,28 +1,38 @@
-series: bionic
+series: jammy
 applications:
   keystone:
-    charm: cs:keystone
+    charm: keystone
+    channel: yoga/stable
     num_units: 1
     options:
-      openstack-origin: cloud:bionic-rocky
       worker-multiplier: 0.25
       preferred-api-version: 3
-  mysql:
-    charm: cs:percona-cluster
-    num_units: 1
-    options:
-      innodb-buffer-pool-size: 256M
-      max-connections: 1000
   openstack-dashboard:
-    charm: cs:openstack-dashboard
+    charm: openstack-dashboard
+    channel: yoga/stable
     num_units: 1
     expose: true
+  mysql:
+    charm: mysql-innodb-cluster
+    channel: 8.0/stable
+    constraints: cores=2 mem=8G root-disk=64G
+    num_units: 3
     options:
-      openstack-origin: cloud:bionic-rocky
+      enable-binlogs: true
+      innodb-buffer-pool-size: 256M
+      max-connections: 2000
+      wait-timeout: 3600
+  keystone-mysql-router:
+    channel: 8.0/stable
+    charm: mysql-router
+  openstack-dashboard-mysql-router:
+    channel: 8.0/stable
+    charm: mysql-router
+
 relations:
-- - keystone:shared-db
-  - mysql:shared-db
-- - openstack-dashboard:identity-service
-  - keystone:identity-service
-- - openstack-dashboard:shared-db
-  - mysql:shared-db
+- [openstack-dashboard:identity-service, keystone:identity-service]
+- [keystone-mysql-router:db-router, mysql:db-router]
+- [keystone-mysql-router:shared-db, keystone:shared-db]
+- [openstack-dashboard-mysql-router:db-router, mysql:db-router]
+- [openstack-dashboard-mysql-router:shared-db, openstack-dashboard:shared-db]
+
diff --git a/generator/k8s_docs_tools/templates/release-notes-header.j2 b/generator/k8s_docs_tools/templates/release-notes-header.j2
@@ -1,14 +1,17 @@
 ---
-wrapper_template: "templates/docs/markdown.html"
+wrapper_template: templates/docs/markdown.html
 markdown_includes:
-  nav: "kubernetes/docs/shared/_side-navigation.md"
+  nav: kubernetes/docs/shared/_side-navigation.md
 context:
-  title: "{{ release }} Release notes"
+  title: {{ release }} Release notes
   description: Release notes for Charmed Kubernetes
 keywords: kubernetes, release, notes
-tags: [news]
+tags: 
+  - news
 sidebar: k8smain-sidebar
 permalink: {{ release }}/release-notes.html
-layout: [base, ubuntu-com]
+layout:
+  - base
+  - ubuntu-com
 toc: False
 ---
diff --git a/generator/k8s_docs_tools/templates/supported-versions.j2 b/generator/k8s_docs_tools/templates/supported-versions.j2
@@ -66,11 +66,14 @@ Only the latest three versions of Charmed Kubernetes are supported at any time.
 
 ## Professional support
 
-For additional support, learn more about [Ubuntu Pro][support] as well as
+For additional support, learn more about [Ubuntu Pro][pro] as well as
 [managed Kubernetes solutions][managed] from Canonical.
 
+Please visit the Canonical [Support page][support] for more details of our
+professional support programmes.
 <!-- LINKS -->
 
+[pro]: /pro
 [support]: /support
 [managed]: /kubernetes/managed
 [releases]: https://github.com/charmed-kubernetes/bundle/tree/main/releases

diff --git a/pages/k8s/1.29/release-notes.md b/pages/k8s/1.29/release-notes.md
@@ -1,22 +1,112 @@
 ---
-wrapper_template: templates/docs/markdown.html
+wrapper_template: "templates/docs/markdown.html"
 markdown_includes:
-  nav: kubernetes/docs/shared/_side-navigation.md
+  nav: "kubernetes/docs/shared/_side-navigation.md"
 context:
-  title: 1.29 Release notes
+  title: "1.29 Release notes"
   description: Release notes for Charmed Kubernetes
 keywords: kubernetes, release, notes
-tags:
-  - news
+tags: [news]
 sidebar: k8smain-sidebar
 permalink: 1.29/release-notes.html
-layout:
-  - base
-  - ubuntu-com
+layout: [base, ubuntu-com]
 toc: false
-
 ---
 
+# 1.29+ck3
+
+### Jun 14, 2024 - `charmed-kubernetes --channel 1.29/stable`
+
+The release bundle can also be 
+[downloaded here](https://raw.githubusercontent.com/charmed-kubernetes/bundle/main/releases/1.29/bundle.yaml).
+
+## Notable Fixes
+
+### Kubernetes-Control-Plane
+
+* [LP#2068770](https://bugs.launchpad.net/bugs/2068770)
+  Upgrade `keystone-credentials` relation with a warning and docs change to [ldap][]
+* [LP#2070053](https://bugs.launchpad.net/bugs/2070053)
+  Upgrade `ceph-client` relation with a warning and docs change to [ceph][]
+
+# 1.29+ck2
+
+### May 30, 2024 - `charmed-kubernetes --channel 1.29/stable`
+
+The release bundle can also be 
+[downloaded here](https://raw.githubusercontent.com/charmed-kubernetes/bundle/main/releases/1.29/bundle.yaml).
+
+## What's new
+
+### Integration gaps
+
+- Vault storage: [vault](https://charmhub.io/vault)
+  - The charm returns support for encryption-at-rest of the secrets in etcd
+    which were created using a relation to `vault-kv`. The cluster secrets
+    stored in etcd are encrypted and can only be unlocked by a key which is
+    stored in Vault.
+- Kubernetes-Worker:
+  - LP#2066049: The charm returns support for the `ingress-proxy` relation.
+
+## Notable Fixes
+
+### Kubernetes-Control-Plane
+
+* [LP#2058269](https://bugs.launchpad.net/bugs/2058269)
+  Stray "\n" characters after an upgrade to 1.29
+
+* [LP#2067427](https://bugs.launchpad.net/bugs/2067427)
+  Improved build reliability via pinning python dependencies
+
+### Kubernetes-Worker
+
+* [LP#2065251](https://bugs.launchpad.net/bugs/2065251)
+  The charm waits appropriately for tokens when related with cos-agent
+
+A list of all bug fixes and minor updates in this release can be found at
+[the launchpad milestone page for 1.29+ck2](https://launchpad.net/charmed-kubernetes/+milestone/1.29+ck2).
+
+# 1.29+ck1 Bugfix release
+
+### April 20, 2024 - `charmed-kubernetes --channel 1.29/stable`
+
+The release bundle can also be [downloaded here](https://raw.githubusercontent.com/charmed-kubernetes/bundle/main/releases/1.29/bundle.yaml).
+
+## Notable Fixes
+
+### Etcd and EasyRSA
+
+* [LP#2061581](https://bugs.launchpad.net/bugs/2061581)
+  Could not find a version that satisfies the requirement setuptools>=64
+
+### Docker-Registry
+
+* [LP#2049360](https://bugs.launchpad.net/bugs/2049360)
+  image corruption with docker-registry charm
+
+### Kubernetes-Control-Plane
+
+* [LP#2052140](https://bugs.launchpad.net/bugs/2052140)
+  grafana agent config not rendered completely
+
+### Calico-Enterprise
+
+* [LP#2053143](https://bugs.launchpad.net/bugs/2053143)
+  Tigera units do not become active after the first installation of the bundle
+
+### Ceph-CSI
+
+* [LP#2054486](https://bugs.launchpad.net/bugs/2054486)
+  ceph-csi charm does not handle ceph-fs correctly
+
+### Kubernetes-Worker
+
+* [LP#2054819](https://bugs.launchpad.net/bugs/2054819)
+  New alert rules shipped from k8s worker
+
+A list of all bug fixes and minor updates in this release can be found at
+[the launchpad milestone page for 1.29+ck1](https://launchpad.net/charmed-kubernetes/+milestone/1.29+ck1).
+
 # 1.29
 
 ### February 12, 2024 - `charmed-kubernetes --channel 1.29/stable`
@@ -27,68 +117,74 @@ The release bundle can also be [downloaded here](https://raw.githubusercontent.c
 
 ### Charmed Operator Framework (Ops)
 
-We're pleased to announce the completion of the Charmed Kubernetes refactor that began
-last year. Core charms have moved from the `reactive` and `pod-spec` styles to the `ops`
-framework. This shift aims to enable access to common charm libraries, gain better Juju support,
-and provide a more consistent charming experience for community engagement.
+We're pleased to announce the completion of the Charmed Kubernetes refactor
+that began last year. Core charms have moved from the `reactive` and `pod-spec`
+styles to the `ops` framework. This shift aims to enable access to common charm
+libraries, gain better Juju support, and provide a more consistent charming
+experience for community engagement.
 
 ### Out of the box monitoring enhancements
 
-The Canonical Observability Stack (COS) gathers, processes, visualises and alerts on
-telemetry signals generated by workloads running both within and outside of Juju. COS
-provides an out of the box observability suite relying on the best-in-class open-source
-observability tools.
+The Canonical Observability Stack (COS) gathers, processes, visualises and
+alerts on telemetry signals generated by workloads running both within and
+outside of Juju. COS provides an out of the box observability suite relying on
+the best-in-class open-source observability tools.
 
 This release expands our COS integration so that it includes rich monitoring for the
 control plane and worker node components of Charmed Kubernetes.
 
 ### Ceph CSI
 
-Ceph CSI resource management has been decoupled from the `kubernetes-control-plane`
-charm. All new deployments should leverage the [ceph-csi][] charm for Ceph storage
-provisioning, including support for CephFS. See the [updated documentation][ceph] for
-details on deploying Charmed Kubernetes with Ceph support.
+Ceph CSI resource management has been decoupled from the
+`kubernetes-control-plane` charm. All new deployments should use the
+[ceph-csi][] charm for Ceph storage provisioning, including support for CephFS.
+See the [updated documentation][ceph] for details on deploying Charmed
+Kubernetes with Ceph support.
 
 ### OpenStack integration
 
-OpenStack capabilities (including cinder storage and cloud provider) have been decoupled
-from the `kubernetes-control-plane` charm. All new deployments should leverage the new
-`openstack-integrator`, `openstack-controller-manager`, and `cinder-csi` charms. See the
-[updated documentation][openstack] for more details.
+OpenStack capabilities (including cinder storage and cloud provider) have been
+decoupled from the `kubernetes-control-plane` charm. All new deployments should
+use the new `openstack-integrator`, `openstack-controller-manager`, and
+`cinder-csi` charms. See the [updated documentation][openstack] for more
+details.
 
 ### NVIDIA GPU Operator
 
-The new [nvidia-gpu-operator][] charm simplifies the management of NVIDIA GPU resources
-in a Kubernetes cluster. See the [updated documentation][gpu-workers] for details on
-deploying Charmed Kubernetes with GPU workers.
+The new [nvidia-gpu-operator][] charm simplifies the management of NVIDIA GPU
+resources in a Kubernetes cluster. See the [updated documentation][gpu-workers]
+for details on deploying Charmed Kubernetes with GPU workers.
 
 ### LXD deployment
 
-Updated recommendations for deploying Charmed Kubernetes in a LXD environment are now
-available. See the [local install documentation][install-local] for details.
+Updated recommendations for deploying Charmed Kubernetes in a LXD environment
+are now available. See the [local install documentation][install-local] for
+details.
 
 ### Manual cloud deployment
 
-Guidelines for deploying Charmed Kubernetes to pre-existing machines are now available.
-See the [manual cloud documentation][install-existing] for details.
+Guidelines for deploying Charmed Kubernetes to pre-existing machines are now
+available. See the [manual cloud documentation][install-existing] for details.
 
 ### Container networking enhancements
 
 #### Kube-OVN 1.12
 
-Charmed Kubernetes continues its commitment to advanced container networking with
-support for the Kube-OVN CNI. This release includes a Kube-OVN upgrade to v1.12. You can
-find more information about features and fixes in the upstream release notes.
+Charmed Kubernetes continues its commitment to advanced container networking
+with support for the Kube-OVN CNI. This release includes a Kube-OVN upgrade to
+v1.12. You can find more information about features and fixes in the upstream
+release notes.
 
 #### Tigera Calico Enterprise
 
-The `calico-enterprise` charm debuts as a new container networking option for Charmed
-Kubernetes in this release. This charm brings advanced Calico networking/network policy
-support and is offered as an alternative to the default Calico CNI.
+The `calico-enterprise` charm debuts as a new container networking option for
+Charmed Kubernetes in this release. This charm brings advanced Calico
+networking/network policy support and is offered as an alternative to the
+default Calico CNI.
 
 ## Fixes
 
-All bug fixes and other feature updates in this release can be found at
+All bug fixes and other feature updates in this release can be found at 
 [the launchpad milestone page for 1.29](https://launchpad.net/charmed-kubernetes/+milestone/1.29).
 
 <a id='notes-issues'> </a>
@@ -135,8 +231,10 @@ relevant sections of the [upstream release notes][upstream-changelog-1.29].
 [rel]: /kubernetes/docs/release-notes
 [ceph-csi]: https://charmhub.io/ceph-csi?channel=1.29/stable
 [ceph]: /kubernetes/docs/ceph
+[ldap]: /kubernetes/docs/ldap
 [openstack]: /kubernetes/openstack-integration
 [nvidia-gpu-operator]: https://charmhub.io/nvidia-gpu-operator?channel=1.29/stable
 [gpu-workers]: /kubernetes/docs/gpu-workers
 [install-local]: /kubernetes/docs/install-local
 [install-existing]: /kubernetes/docs/install-existing
+[ldap]: /kuberntes/docs/ldap
diff --git a/pages/k8s/1.29/upgrading.md b/pages/k8s/1.29/upgrading.md
@@ -18,7 +18,12 @@ toc: False
     <span class="p-notification__title">Caution:</span>
     <p class="p-notification__message">This release includes topology changes and new best practices for integrating <strong>Charmed Kubernetes</strong> with other Juju ecosystem solutions. Be sure to read and understand the *What's new* section of the <a href="/kubernetes/docs/1.29/release-notes">1.29 release notes</a> prior to upgrading your cluster.<br/>
     <br/>
-    Additionally, some features from previous <strong>Charmed Kubernetes</strong> releases are not yet available in this release. If you rely on a component identified as an *Integration gap* in the <a href="/kubernetes/docs/1.29/release-notes#notes-issues">Notes and Known Issues</a> section of the release notes, remain on release 1.28 (or earlier) and do not upgrade to 1.29 at this time.</p>
+    Additionally, some features from previous <strong>Charmed Kubernetes</strong> releases are not yet available in this release. If you rely on a component identified as an *Integration gap* in the <a href="/kubernetes/docs/1.29/release-notes#notes-issues">Notes and Known Issues</a> section of the release notes, remain on release 1.28 (or earlier) and do not upgrade to 1.29 at this time.<br/>
+    <br/>
+    Some specific scenarios for thoese using particular configurations are also covered in the 
+    <a href="/kubernetes/docs/upgrade-notes"> Upgrade notes document</a>, particularly concerning those using 
+    observability, LDAP/Keystone integration and Ceph.<br/>
+    </p>
   </div>
 </div>
 

diff --git a/pages/k8s/ceph.md b/pages/k8s/ceph.md
@@ -13,6 +13,13 @@ layout: [base, ubuntu-com]
 toc: False
 ---
 
+<div class="p-notification--positive is-inline">
+  <div markdown="1" class="p-notification__content">
+    <span class="p-notification__title">Note:</span>
+    <p class="p-notification__message">This guide uses the ceph-csi and cephfs operator charms available with Charmed Kubernetes 1.29 and above. For previous versions, see the <a href="/kubernetes/docs/storage">generic storage guide</a> to integrate Ceph without these charms.</p>
+  </div>
+</div>
+
 Many workloads that you may want to run on your Kubernetes cluster will require some
 form of available storage. This guide will help you deploy **Charmed Kubernetes** with
 **Ceph** container storage support. Available storage backends include `ceph-xfs`,

diff --git a/pages/k8s/how-to-cos-lite.md b/pages/k8s/how-to-cos-lite.md
@@ -109,12 +109,12 @@ Deploy the grafana-agent:
 Juju deploy grafana-agent
 ```
 
-Relate `grafana-agent` to `k8s`, `kubernetes-control-plane` and `kubernetes-worker`:
+Relate `grafana-agent` to charmed kubernetes applications:
 
 ```
-juju integrate grafana-agent:cos-agent k8s:cos-agent
 juju integrate grafana-agent:cos-agent kubernetes-control-plane:cos-agent
 juju integrate grafana-agent:cos-agent kubernetes-worker:cos-agent
+juju integrate grafana-agent:cos-agent kubeapi-load-balancer:cos-agent
 ```
 
 Relate `grafana-agent` to the COS Lite offered interfaces: