Skip to content

Commit 769b48f

Browse files
github-actions[bot]upload-charms-docs-bot
and
upload-charms-docs-bot
authored
[discourse-gatekeeper] Migrate charm docs (#373)
* 'modified: docs/reference/r-releases-group/r-releases.md // new: docs/reference/r-releases-group/r-releases-rev203.md' * 'modified: docs/reference/r-releases-group/r-releases-rev203.md,docs/reference/r-releases-group/r-releases.md' * 'modified: docs/reference/r-releases-group/r-releases-rev203.md' * 'modified: docs/reference/r-releases-group/r-releases-rev196.md,docs/reference/r-releases-group/r-releases-rev151.md,docs/reference/r-releases-group/r-releases-rev203.md' * 'modified: docs/reference/r-contacts.md' * 'modified: docs/reference/r-profiles.md' * 'modified: docs/reference/r-contacts.md' --------- Co-authored-by: upload-charms-docs-bot <[email protected]>
1 parent 528121c commit 769b48f

File tree

6 files changed

+63
-11
lines changed

6 files changed

+63
-11
lines changed

docs/reference/r-contacts.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
# Contacts
1+
# Contact
22

3-
Contact Canonical Data Platform team in [Mattermost](https://chat.charmhub.io/charmhub/channels/data-platform) (preferred).
3+
Charmed MySQL is an open source project that warmly welcomes community contributions, suggestions, fixes, and constructive feedback.
4+
* Raise software issues or feature requests on [**GitHub**](https://github.com/canonical/mysql-operator/issues/new/choose)
5+
* Report security issues through [**Launchpad**](https://wiki.ubuntu.com/DebuggingSecurity#How%20to%20File)
6+
* Contact the Canonical Data Platform team through our [Matrix](https://matrix.to/#/#charmhub-data-platform:ubuntu.com) channel.
7+
[note]
8+
Our legacy [Mattermost](https://chat.charmhub.io/charmhub/channels/data-platform) channel is read-only until January 31, 2025.
9+
[/note]
410

5-
Report your ideas/issues on [GitHub](https://github.com/canonical/mysql-operator/issues/new/choose).</br>
6-
Security issues should be reported through [LaunchPad](https://wiki.ubuntu.com/DebuggingSecurity#How%20to%20File).</br>Please do NOT file GitHub issues on security topics.
711

8-
Useful links:
12+
## Useful links
913
* [Canonical Data Fabric](https://ubuntu.com/data/)
1014
* [Charmed MySQL](https://charmhub.io/mysql)
1115
* [Git sources for Charmed MySQL](https://github.com/canonical/mysql-operator)
12-
* [Canonical Data Platform on Launchpad](https://launchpad.net/~data-platform)
16+
* [Canonical Data on Launchpad](https://launchpad.net/~data-platform)
17+
* [Canonical Data on Matrix](https://matrix.to/#/#charmhub-data-platform:ubuntu.com)
1318
* [Mailing list on Launchpad](https://lists.launchpad.net/data-platform/)

docs/reference/r-profiles.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ juju deploy mysql --config profile=testing
1212

1313
|Value|Description|Tech details|
1414
| --- | --- | ----- |
15-
|`production`<br>(default)|[Maximum performance](https://github.com/canonical/mysql-operator/blob/main/lib/charms/mysql/v0/mysql.py#L766-L775)| ~75% of [unit memory](https://juju.is/docs/juju/unit) granted for MySQL|
16-
|`testing`|[Minimal resource usage](https://github.com/canonical/mysql-operator/blob/main/lib/charms/mysql/v0/mysql.py#L759-L764)| innodb_buffer_pool_size = 20MB<br/>innodb_buffer_pool_chunk_size=1MB<br/>group_replication_message_cache_size=128MB<br/>max_connections=20<br/>performance-schema-instrument='memory/%=OFF' |
15+
|`production`<br>(default)|[Maximum performance](https://github.com/canonical/mysql-operator/blob/main/lib/charms/mysql/v0/mysql.py#L766-L775)| ~75% of [unit memory](https://juju.is/docs/juju/unit) granted for MySQL<br/>max_connections=[RAM/12MiB](https://github.com/canonical/mysql-operator/blob/53e54745f47b6d2184c54386ee984792cb939152/lib/charms/mysql/v0/mysql.py#L2092) (max safe value)|
16+
|`testing`|[Minimal resource usage](https://github.com/canonical/mysql-operator/blob/main/lib/charms/mysql/v0/mysql.py#L759-L764)| innodb_buffer_pool_size = 20MB<br/>innodb_buffer_pool_chunk_size=1MB<br/>group_replication_message_cache_size=128MB<br/>max_connections=100<br/>performance-schema-instrument='memory/%=OFF' |
1717

1818
## Config change
1919

docs/reference/r-releases-group/r-releases-rev151.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Charmed MySQL revision 151
2-
<sub>Thursday, April 20, 2023</sub>
2+
<sub>April 20, 2023</sub>
33

44
Dear community, this is to inform you that new Canonical Charmed MySQL charm is published in `8.0/stable` charmhub channel for bare-metal/virtual-machines.
55

docs/reference/r-releases-group/r-releases-rev196.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Charmed MySQL revision 196
2-
<sub>Friday, September 29, 2023</sub>
2+
<sub>September 29, 2023</sub>
33

44
Dear community, this is to inform you that new Canonical Charmed MySQL is published in `8.0/stable` [charmhub](https://charmhub.io/mysql?channel=8.0/stable) channel for IAAS/VM.
55

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Charmed MySQL revision 203
2+
> :warning: The revision is currently available in `8.0/candidate` only (**WIP**).
3+
<!-- <sub>January 3, 2024</sub> -->
4+
5+
Dear community, this is to inform you that new Canonical Charmed MySQL is published in `8.0/stable` [charmhub](https://charmhub.io/mysql?channel=8.0/stable) channel for IAAS/VM.
6+
7+
## The features you can start using today:
8+
9+
* Add [profile-limit-memory](https://charmhub.io/mysql/configure?channel=8.0/edge#profile-limit-memory) option [[PR#331](https://github.com/canonical/mysql-operator/pull/331)][[DPE-2654](https://warthogs.atlassian.net/browse/DPE-2654)]
10+
* Add [logrotation](https://charmhub.io/mysql/docs/e-logs?channel=8.0/edge) for general/error/slowquery text logs [[PR#329](https://github.com/canonical/mysql-operator/pull/329)][[DPE-1796](https://warthogs.atlassian.net/browse/DPE-1796)]
11+
* Use labels for internal Juju secrets in [[PR#348](https://github.com/canonical/mysql-operator/pull/348)][[DPE-2886](https://warthogs.atlassian.net/browse/DPE-2886)]
12+
* Updated data-platform-libs for external secrets [[PR#333](https://github.com/canonical/mysql-operator/pull/333)]
13+
* All the functionality from [the previous revisions](/t/11881)
14+
15+
## Bugfixes included:
16+
17+
Canonical Data issues are now public on both [Jira](https://warthogs.atlassian.net/jira/software/c/projects/DPE/issues/) and [GitHub](https://github.com/canonical/mysql-operator/issues) platforms.<br/>[GitHub Releases](https://github.com/canonical/mysql-operator/releases) provide a detailed list of bugfixes/PRs/Git commits for each revision.<br/>Highlights for the current revision:
18+
19+
* Fixed single unit upgrade [[PR#340](https://github.com/canonical/mysql-operator/pull/340)][[DPE-2662](https://warthogs.atlassian.net/browse/DPE-2662)]
20+
* Fixed dateformat in logrotate config to avoid causing filename conflicts after 24hrs of uptime [[PR#363](https://github.com/canonical/mysql-operator/pull/363)][[DPE-3063](https://warthogs.atlassian.net/browse/DPE-3063)]
21+
* Stops logging FLUSH LOG statements to the MySQL binlog which is causing GTID conflicts and prevents the member from self-healing [[PR#336](https://github.com/canonical/mysql-operator/pull/336)]
22+
23+
## What is inside the charms:
24+
25+
* Charmed MySQL ships the latest MySQL “8.0.34-0ubuntu0.22.04.1”
26+
* CLI mysql-shell updated to "8.0.34-0ubuntu0.22.04.1~ppa1"
27+
* Backup tools xtrabackup/xbcloud updated to "8.0.34-29"
28+
* The Prometheus mysqld-exporter is "0.14.0-0ubuntu0.22.04.1~ppa1"
29+
* VM charms based on [Charmed MySQL](https://snapcraft.io/charmed-mysql) SNAP (Ubuntu LTS “22.04” - ubuntu:22.04-based) revision 69
30+
* Principal charms supports the latest LTS series “22.04” only
31+
* Subordinate charms support LTS “22.04” and “20.04” only
32+
33+
## Technical notes:
34+
35+
* Upgrade (`juju refresh`) is possible from this revision 196+
36+
* Use this operator together with a modern operator "[MySQL Router](https://charmhub.io/mysql-router?channel=dpe/beta)"
37+
* Please check additionally [the previously posted restrictions](/t/11881)
38+
39+
## How to reach us:
40+
41+
If you would like to chat with us about your use-cases or ideas, you can reach us at [Canonical Mattermost public channel](https://chat.charmhub.io/charmhub/channels/data-platform) or [Discourse](https://discourse.charmhub.io/). Check all other contact details [here](/t/11867).
42+
43+
Consider [opening a GitHub issue](https://github.com/canonical/mysql-operator/issues) if you want to open a bug report.<br/>[Contribute](https://github.com/canonical/mysql-operator/blob/main/CONTRIBUTING.md) to the project!
44+
45+
## Hints:
46+
47+
Please check [all the previous release notes](/t/11881) if you are jumping over the several stable revisions!

docs/reference/r-releases-group/r-releases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Canonical publishes here release notes for production ready revisions available in [CharmHub](https://charmhub.io) [channels](https://juju.is/docs/sdk/channel):
44

5-
* [revision 203](/t/12718) in `8.0/stable` (WIP)
5+
* [revision 203](/t/12718) in `8.0/candidate` (WIP)
66
* [revision 196](/t/11883) in `8.0/stable`
77
* [revision 151](/t/11882) in `8.0/stable`
88

0 commit comments

Comments
 (0)