Skip to content

Commit 95391d6

Browse files
Sync docs from Discourse (#545)
Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 06c7939 commit 95391d6

File tree

4 files changed

+137
-15
lines changed

4 files changed

+137
-15
lines changed

docs/overview.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,14 @@ Charmed MySQL K8s is an official distribution of MySQL. It’s an open-source pr
8484
| 2 | h-contribute | [Contribute](/t/14655) |
8585
| 1 | reference | [Reference]() |
8686
| 2 | r-releases | [Release Notes](/t/11878) |
87+
| 3 | r-revision-210-211 | [Revision 210/211](/t/16133) |
8788
| 3 | r-revision-180-181 | [Revision 180/181](/t/15276) |
8889
| 3 | r-revision-153 | [Revision 153](/t/14072) |
8990
| 3 | r-revision-127 | [Revision 127](/t/13522) |
9091
| 3 | r-revision-113 | [Revision 113](/t/12221) |
9192
| 3 | r-revision-99 | [Revision 99](/t/11880) |
9293
| 3 | r-revision-75 | [Revision 75](/t/11879) |
93-
| 2 | r-requirements | [Requirements](/t/11421) |
94+
| 2 | r-system-requirements | [System requirements](/t/11421) |
9495
| 2 | r-testing | [Testing](/t/11772) |
9596
| 2 | r-profiles | [Profiles](/t/11892) |
9697
| 2 | r-plugins-extensions | [Plugins/extensions](/t/15482) |
@@ -114,4 +115,4 @@ Charmed MySQL K8s is an official distribution of MySQL. It’s an open-source pr
114115
| 2 | h-development| [Development](/t/11884) |
115116
| 3 | h-upgrade-major | [Perform a major upgrade](/t/11750) |
116117
| 3 | h-rollback-major | [Perform a major rollback](/t/11751) |
117-
-->
118+
--> Charmed MySQL K8s Documentation

docs/reference/r-releases.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ To see all releases and commits, check the [Charmed MySQL K8s Releases page on G
88

99
| Release | MySQL version | Juju version | [TLS encryption](/t/9655)* | [COS monitoring](/t/9981) | [Minor version upgrades](/t/11752) | [Cross-regional async replication](/t/13458) |
1010
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
11+
| [210], [211] | 8.0.39 | `3.5.4+` | ![check] | ![check] | ![check] | ![check] |
1112
| [180], [181] | 8.0.37 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] |
1213
| [153] | 8.0.36 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] |
1314
| [127] | 8.0.35 | `3.1.6+` | | ![check] | ![check] | |
@@ -23,53 +24,59 @@ For more details about each feature/interface, refer to the documentation linked
2324
## Architecture and base
2425
Several [revisions](https://juju.is/docs/sdk/revision) are released simultaneously for different [bases/series](https://juju.is/docs/juju/base) using the same charm code. In other words, one release contains multiple revisions.
2526

26-
> If you do not specify a revision on deploy time, Juju will automatically choose the revision that matches your base and architecture.
27+
> If you do not specify a revision on deploy time, Juju will automatically choose the revision that matches your base and architecture.
28+
>
29+
> See: [`juju set-constraints`](https://juju.is/docs/juju/juju-set-constraints), [`juju info`](https://juju.is/docs/juju/juju-info)
2730
28-
> If you deploy a specific revision, **you must make sure it matches your base and architecture** via the tables below or with [`juju info`](https://juju.is/docs/juju/juju-info)
31+
### Release 210-211
2932

30-
### Release 180-181 (`8.0/stable`)
33+
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
34+
|:--------:|:-----:|:-----:|:-----:|
35+
|[210] |![check] | | ![check] |
36+
|[211] | | ![check]| ![check] |
37+
38+
[details=Older releases]
39+
### Release 180-181
3140

3241
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
3342
|:--------:|:-----:|:-----:|:-----:|
3443
|[180] |![check] | | ![check] |
3544
|[181] | | ![check]| ![check] |
3645

37-
[details=Release 153]
46+
### Release 153
3847

3948
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
4049
|:--------:|:-----:|:-----:|:-----:|
4150
|[153] |![check]| | ![check] |
42-
[/details]
4351

44-
[details=Release 127]
52+
### Release 127
4553

4654
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
4755
|:--------:|:-----:|:-----:|:-----:|
4856
|[127] |![check]| | ![check] |
49-
[/details]
5057

51-
[details=Release 113]
58+
### Release 113
5259

5360
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
5461
|:--------:|:-----:|:-----:|:-----:|
5562
|[113] |![check]| | ![check] |
56-
[/details]
5763

58-
[details=Release 99]
64+
### Release 99
5965

6066
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
6167
|:--------:|:-----:|:-----:|:-----:|
6268
|[99] |![check]| | ![check] |
63-
[/details]
6469

65-
[details=Release 75]
70+
### Release 75
6671

6772
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
6873
|:--------:|:-----:|:-----:|:-----:|
6974
|[75] |![check]| | ![check] |
7075
[/details]
7176

7277
<!-- LINKS -->
78+
[210]: /t/16133
79+
[211]: /t/16133
7380
[180]: /t/15276
7481
[181]: /t/15276
7582
[153]: /t/14072

docs/reference/r-revision-210-211.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
>Reference > Release Notes > [All revisions] > Revision 211/210
2+
3+
# Revision 211/210
4+
<sub>January 6, 2025</sub>
5+
6+
Dear community,
7+
8+
Canonical's newest Charmed MySQL K8s operator has been published in the [8.0/stable channel]:
9+
* Revision 210 is built for `amd64` on Ubuntu 22.04 LTS
10+
* Revision 211 is built for `arm64` on Ubuntu 22.04 LTS
11+
12+
If you are jumping over several stable revisions, check [previous release notes][All revisions] before upgrading.
13+
14+
---
15+
16+
## Highlights
17+
* Updated MySQL to `v8.0.39` ([PR #488](https://github.com/canonical/mysql-k8s-operator/pull/488)) ([DPE-4573](https://warthogs.atlassian.net/browse/DPE-4573))
18+
* Added fully-featured terraform module ([PR #522](https://github.com/canonical/mysql-k8s-operator/pull/522)) ([DPE-5627](https://warthogs.atlassian.net/browse/DPE-5627))
19+
* See also: [How to deploy on Terraform](/t/14926)
20+
* Updated COS alert rule descriptions ([PR #519](https://github.com/canonical/mysql-k8s-operator/pull/519)) ([DPE-5659](https://warthogs.atlassian.net/browse/DPE-5659))
21+
* See also: [How to enable alert rules](/t/15488),
22+
* Bumped juju versions ([PR #517](https://github.com/canonical/mysql-k8s-operator/pull/517))
23+
* `v2.9.50` -> `v2.9.51`
24+
* `v3.4.5` -> `v3.5.4`
25+
26+
## Features and improvements
27+
* Integrated with Tempo HA and tested relay support of tracing traffic through `grafana-agent-k8s` ([PR #518](https://github.com/canonical/mysql-k8s-operator/pull/518)) ([DPE-5312](https://warthogs.atlassian.net/browse/DPE-5312))
28+
* Adopted admin address throughout charm ([PR #502](https://github.com/canonical/mysql-k8s-operator/pull/502)) ([DPE-5178](https://warthogs.atlassian.net/browse/DPE-5178))
29+
* Avoid ambiguous service selector when multiple `mysql` apps in a model have the same cluster-name ([PR #501](https://github.com/canonical/mysql-k8s-operator/pull/501)) ([DPE-4861](https://warthogs.atlassian.net/browse/DPE-4861))
30+
* Ensure that uninitialized variable not referenced in `_is_cluster_blocked` helper ([PR #507](https://github.com/canonical/mysql-k8s-operator/pull/507)) ([DPE-5481](https://warthogs.atlassian.net/browse/DPE-5481))
31+
* Recover from pod restarts during cluster creation during setup ([PR #499](https://github.com/canonical/mysql-k8s-operator/pull/499))
32+
* Added timeout on node count query ([PR #514](https://github.com/canonical/mysql-k8s-operator/pull/514)) ([DPE-5582](https://warthogs.atlassian.net/browse/DPE-5582))
33+
34+
## Bugfixes and maintenance
35+
36+
* Fixed unit-initialized test may break when run too early ([PR #491](https://github.com/canonical/mysql-k8s-operator/pull/491)) ([DPE-5209](https://warthogs.atlassian.net/browse/DPE-5209))
37+
* Common credentials fixture and `exec` timeout workaround ([PR #493](https://github.com/canonical/mysql-k8s-operator/pull/493)) ([DPE-5210](https://warthogs.atlassian.net/browse/DPE-5210))
38+
* Fixed /database requested wait container ([PR #500](https://github.com/canonical/mysql-k8s-operator/pull/500)) ([DPE-5385](https://warthogs.atlassian.net/browse/DPE-5385))
39+
* Attempted to stabilize failing integration tests ([PR #496](https://github.com/canonical/mysql-k8s-operator/pull/496))
40+
* Add test to ensure correct k8s endpoints created for clusters with the same name ([PR #508](https://github.com/canonical/mysql-k8s-operator/pull/508))
41+
* Add check to ensure peer databag populated before reconciling mysqld exporter pebble layers ([PR #505](https://github.com/canonical/mysql-k8s-operator/pull/505)) ([DPE-5417](https://warthogs.atlassian.net/browse/DPE-5417))
42+
* Add base in test_multi_relations to workaround libjuju bug ([PR #506](https://github.com/canonical/mysql-k8s-operator/pull/506)) ([DPE-5480](https://warthogs.atlassian.net/browse/DPE-5480))
43+
44+
[details=Libraries, testing, and CI]
45+
46+
* increased key logs verbosity (s/debug/info/) ([PR #513](https://github.com/canonical/mysql-k8s-operator/pull/513))
47+
* Run juju 3.6 nightly tests against 3.6/stable ([PR #533](https://github.com/canonical/mysql-k8s-operator/pull/533))
48+
* Test for multi-relation scale in/out ([PR #489](https://github.com/canonical/mysql-k8s-operator/pull/489)) ([DPE-4613](https://warthogs.atlassian.net/browse/DPE-4613))
49+
* Test against juju 3.6/candidate + upgrade dpw to v23.0.5 ([PR #527](https://github.com/canonical/mysql-k8s-operator/pull/527))
50+
* Added workflow for nightly scheduled tests with juju 3.6 ([PR #490](https://github.com/canonical/mysql-k8s-operator/pull/490)) ([DPE-4976](https://warthogs.atlassian.net/browse/DPE-4976))
51+
* Switch from tox build wrapper to charmcraft.yaml overrides ([PR #509](https://github.com/canonical/mysql-k8s-operator/pull/509))
52+
* Update canonical/charming-actions action to v2.6.3 ([PR #497](https://github.com/canonical/mysql-k8s-operator/pull/497))
53+
* Update codecov/codecov-action action to v5 ([PR #526](https://github.com/canonical/mysql-k8s-operator/pull/526))
54+
* Update data-platform-workflows to v23.1.0 ([PR #532](https://github.com/canonical/mysql-k8s-operator/pull/532))
55+
* Update dependency canonical/microk8s to v1.31 ([PR #495](https://github.com/canonical/mysql-k8s-operator/pull/495))
56+
* Update dependency cryptography to v43 [SECURITY] ([PR #498](https://github.com/canonical/mysql-k8s-operator/pull/498))
57+
58+
[/details]
59+
60+
## Requirements and compatibility
61+
* (increased) MySQL version: `v8.0.37` -> `v8.0.39`
62+
* (increased) Minimum Juju 2 version:`v2.9.50` -> `v2.9.51`
63+
* (increased) Minimum Juju 3 version:`v3.4.5` -> `v3.5.4`
64+
65+
See the [system requirements] for more details about Juju versions and other software and hardware prerequisites.
66+
67+
### Packaging
68+
69+
This charm is based on the Charmed MySQL K8s [rock image]. It packages:
70+
* [mysql-server-8.0] `v8.0.39`
71+
* [mysql-router] `v8.0.39`
72+
* [mysql-shell] `v8.0.38`
73+
* [prometheus-mysqld-exporter] `v0.14.0`
74+
* [prometheus-mysqlrouter-exporter] `v5.0.1`
75+
* [percona-xtrabackup] `v8.0.35`
76+
77+
See the [`/lib/charms` directory on GitHub] for more details about all supported libraries.
78+
79+
See the [`metadata.yaml` file on GitHub] for a full list of supported interfaces.
80+
81+
82+
<!-- Topics -->
83+
[All revisions]: /t/11878
84+
[system requirements]: /t/11421
85+
86+
<!-- GitHub -->
87+
[`/lib/charms` directory on GitHub]: https://github.com/canonical/mysql-k8s-operator/tree/main/lib/charms
88+
[`metadata.yaml` file on GitHub]: https://github.com/canonical/mysql-k8s-operator/blob/main/metadata.yaml
89+
90+
<!-- Charmhub -->
91+
[8.0/stable channel]: https://charmhub.io/mysql?channel=8.0/stable
92+
93+
<!-- Snap/Rock -->
94+
[`charmed-mysql` packaging]: https://github.com/canonical/charmed-mysql-rock
95+
96+
[MySQL Libraries tab]: https://charmhub.io/mysql/libraries
97+
98+
[113/114]: https://github.com/canonical/charmed-mysql-snap/releases/tag/rev114
99+
[rock image]: https://github.com/canonical/charmed-mysql-rock/pkgs/container/charmed-mysql
100+
101+
[mysql-server-8.0]: https://launchpad.net/ubuntu/+source/mysql-8.0/
102+
[mysql-router]: https://launchpad.net/ubuntu/+source/mysql-8.0/
103+
[mysql-shell]: https://launchpad.net/~data-platform/+archive/ubuntu/mysql-shell
104+
[prometheus-mysqld-exporter]: https://launchpad.net/~data-platform/+archive/ubuntu/mysqld-exporter
105+
[prometheus-mysqlrouter-exporter]: https://launchpad.net/~data-platform/+archive/ubuntu/mysqlrouter-exporter
106+
[percona-xtrabackup]: https://launchpad.net/~data-platform/+archive/ubuntu/xtrabackup
107+
108+
109+
<!-- Badges -->
110+
[juju-2_amd64]: https://img.shields.io/badge/Juju_2.9.51-amd64-darkgreen?labelColor=ea7d56
111+
[juju-3_amd64]: https://img.shields.io/badge/Juju_3.4.6-amd64-darkgreen?labelColor=E95420
112+
[juju-3_arm64]: https://img.shields.io/badge/Juju_3.4.6-arm64-blue?labelColor=E95420

docs/reference/r-requirements.md renamed to docs/reference/r-system-requirements.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The charm supports several Juju releases from [2.9 LTS](https://juju.is/docs/juj
2323

2424
| Juju major release | Supported minor versions | Compatible charm revisions |Comment |
2525
|:--------|:-----|:-----|:-----|
26+
| ![3.6 LTS] | `3.6.1+` | 213+ | |
2627
| ![3.5] | `3.5.2+` | [153]+ | |
2728
| ![3.4] | `3.4.3+` | [153]+ | Known issues with `3.4.2`: [bug #1](https://bugs.launchpad.net/juju/+bug/2065284), [bug #2](https://bugs.launchpad.net/juju/+bug/2064772) |
2829
| ![3.1] | `3.1.6+` | [99]+ | |
@@ -61,4 +62,5 @@ The charm is based on the [charmed-mysql ROCK OCI](https://github.com/canonical/
6162
[2.9 LTS]: https://img.shields.io/badge/2.9_LTS-%23E95420?label=Juju
6263
[3.1]: https://img.shields.io/badge/3.1-%23E95420?label=Juju
6364
[3.4]: https://img.shields.io/badge/3.4-%23E95420?label=Juju
64-
[3.5]: https://img.shields.io/badge/3.5-%23E95420?label=Juju
65+
[3.5]: https://img.shields.io/badge/3.5-%23E95420?label=Juju
66+
[3.6 LTS]: https://img.shields.io/badge/3.6_LTS-%23E95420?label=Juju

0 commit comments

Comments
 (0)