Skip to content

Commit 49b09f9

Browse files
Sync docs from Discourse (#625)
Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 025afd6 commit 49b09f9

File tree

4 files changed

+63
-21
lines changed

4 files changed

+63
-21
lines changed

docs/explanation/e-users.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,7 @@ mysql> select Host,User,account_locked from mysql.user where User like 'mysql_ro
122122
> juju relate mysql-k8s myclientapp
123123
```
124124
125-
<a name="extra-user-roles"></a>
126-
### Extra user roles
127125
128-
When an application charm requests a new user through the relation/integration it can specify that the user should have the `admin` role in the `extra-user-roles` field. The `admin` role enables the new user to read and write to all databases (for the `mysql` system database it can only read data) and also to create and delete non-system databases.
129-
130-
**Note**: `extra-user-roles` is supported by modern interface `mysql_client` only and missing for legacy `mysql` interface. Read more about the supported charm interfaces [here](/t/10249).
131126
132127
133128
<a name="admin-port"></a>

docs/how-to/h-enable-tracing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This feature is available for Charmed MySQL K8s revision 146+ only.
2525
Enabling tracing with Tempo requires that you:
2626
- Have deployed a Charmed MySQL K8s application
2727
- See [How to manage units](https://discourse.charmhub.io/t/charmed-mysql-k8s-how-to-manage-units/9659)
28-
- Have deployed a 'cos-lite' bundle from the `latest/edge` track in a Kubernetes environment
28+
- Have deployed a 'cos-lite' bundle in a Kubernetes environment
2929
- See [Getting started on MicroK8s](https://charmhub.io/topics/canonical-observability-stack/tutorials/install-microk8s)
3030

3131
---
@@ -81,10 +81,10 @@ juju consume k8s:admin/cos.tempo
8181

8282
<a href="#heading--consume"><h2 id="heading--consume"> Consume interfaces </h2></a>
8383

84-
First, deploy [Grafana Agent K8s](https://charmhub.io/grafana-agent-k8s) from the `latest/edge` channel:
84+
First, deploy [Grafana Agent K8s](https://charmhub.io/grafana-agent-k8s) from the `1/stable` channel:
8585

8686
```shell
87-
juju deploy grafana-agent-k8s --channel latest/edge
87+
juju deploy grafana-agent-k8s --channel 1/stable
8888
```
8989

9090
Then, integrate Grafana Agent K8s with the consumed interface from the previous section:
@@ -109,7 +109,7 @@ SAAS Status Store URL
109109
tempo active k8s admin/cos.tempo
110110

111111
App Version Status Scale Charm Channel Rev Address Exposed Message
112-
grafana-agent-k8s 0.40.4 active 1 grafana-agent-k8s latest/edge 93 10.152.183.63 no grafana-dashboards-provider: off, logging-consumer: off, send-remote-write: off
112+
grafana-agent-k8s 0.40.4 active 1 grafana-agent-k8s 1/stable 115 10.152.183.63 no grafana-dashboards-provider: off, logging-consumer: off, send-remote-write: off
113113
mysql-k8s 8.0.37-0ubuntu0.22.04.3 active 1 mysql-k8s 0 10.152.183.135 no Primary
114114

115115
Unit Workload Agent Address Ports Message

docs/how-to/h-troubleshooting.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,40 @@
44
55
Ensure you went into the real issue which requires the manual activity. Run `juju status` and check the [list of charm statuses](/t/11866) and recommended activities there.
66

7+
8+
## One offline unit and other units as secondaries
9+
10+
**Problem:** The primary unit went offline and primary reelection failed, rendered remaining units in RO mode.
11+
**Solution:**
12+
1. Restart `mysqld_safe` service on secondaries, i.e.:
13+
```shell
14+
# for each secondarie unit `n`
15+
juju ssh --container mysql mysql-k8s/n pebble restart mysqld_safe
16+
```
17+
2. Wait update-status hook to trigger recovery. For faster recovery, it's possible to speed up the update-status hook with:
18+
```shell
19+
juju model-config update-status-hook-interval=30s -m mymodel
20+
# after recovery, set default interval of 5 minutes
21+
juju model-config update-status-hook-interval=5m -m mymodel
22+
```
23+
24+
**Explanation:** When restarting secondaries, all MySQL instance will return as offline, which will trigger a cluster recovery.
25+
26+
27+
## Two primaries, one in "split-brain" state
28+
29+
**Problem:** Original primary had a transitory network cut, and a new primary was elected. On returning, old primary enter split-brain state.
30+
31+
**Solution:**
32+
1. Restart `mysqld_safe` service on secondaries, i.e.:
33+
```shell
34+
# using `n` as the unit in split brain state
35+
juju ssh --container mysql mysql-k8s/n pebble restart mysqld_safe
36+
```
37+
2. Wait unit rejoin the cluster
38+
39+
**Explanation:** On restart, unit will reset it state and try to rejoin the cluster as a secondary.
40+
741
## Logs
842
943
Please be familiar with [Juju logs concepts](https://juju.is/docs/juju/log) and learn [how to manage Juju logs](https://juju.is/docs/juju/manage-logs).

docs/reference/r-releases.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,17 @@ To learn more about the different release tracks and channels, see the [Juju doc
66

77
To see all releases and commits, check the [Charmed MySQL K8s Releases page on GitHub](https://github.com/canonical/mysql-k8s-operator/releases).
88

9-
| Release | MySQL version | Juju version | [TLS encryption](/t/9655)* | [COS monitoring](/t/9981) | [Minor version upgrades](/t/11752) | [Cross-regional async replication](/t/13458) |
10-
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
11-
| [240], [241] | 8.0.41 | `3.5.4+` | ![check] | ![check] | ![check] | ![check] |
12-
| [210], [211] | 8.0.39 | `3.5.4+` | ![check] | ![check] | ![check] | ![check] |
13-
| [180], [181] | 8.0.37 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] |
14-
| [153] | 8.0.36 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] |
15-
| [127] | 8.0.35 | `3.1.6+` | | ![check] | ![check] | |
16-
| [113] | 8.0.34 | `3.1.6+` | | ![check] | ![check] | |
17-
| [99] | 8.0.34 | `3.1.6+` | | ![check] | ![check] | |
18-
| [75] | 8.0.32 | `2.9.32+` | | ![check] | ![check] | |
9+
| Release | MySQL version | Juju version | [TLS encryption](/t/9655)* | [COS monitoring](/t/9981) | [Minor version upgrades](/t/11752) | [Cross-regional async replication](/t/13458) | [Point-in-time recovery](/t/9963)
10+
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
11+
| [254], [255] | 8.0.41 | `3.5.4+` | ![check] | ![check] | ![check] | ![check] | ![check] |
12+
| [240], [241] | 8.0.41 | `3.5.4+` | ![check] | ![check] | ![check] | ![check] | |
13+
| [210], [211] | 8.0.39 | `3.5.4+` | ![check] | ![check] | ![check] | ![check] | |
14+
| [180], [181] | 8.0.37 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] | |
15+
| [153] | 8.0.36 | `3.4.3+` | ![check] | ![check] | ![check] | ![check] | |
16+
| [127] | 8.0.35 | `3.1.6+` | | ![check] | ![check] | | |
17+
| [113] | 8.0.34 | `3.1.6+` | | ![check] | ![check] | | |
18+
| [99] | 8.0.34 | `3.1.6+` | | ![check] | ![check] | | |
19+
| [75] | 8.0.32 | `2.9.32+` | | ![check] | ![check] | | |
1920

2021
\* **TLS encryption**: Support for **`v2` or higher** of the [`tls-certificates` interface](https://charmhub.io/tls-certificates-interface/libraries/tls_certificates). This means that you can integrate with [modern TLS charms](https://charmhub.io/topics/security-with-x-509-certificates).
2122

@@ -29,14 +30,24 @@ Several [revisions](https://juju.is/docs/sdk/revision) are released simultaneous
2930
>
3031
> See: [`juju set-constraints`](https://juju.is/docs/juju/juju-set-constraints), [`juju info`](https://juju.is/docs/juju/juju-info)
3132
32-
### Release 210-211
33+
### Release 254-255
34+
35+
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
36+
|:--------:|:-----:|:-----:|:-----:|
37+
|[254] || ![check] | ![check] |
38+
|[255] | ![check]| | ![check] |
39+
40+
[details=Older releases]
41+
42+
### Release 240-241
3343

3444
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
3545
|:--------:|:-----:|:-----:|:-----:|
3646
|[240] |![check] | | ![check] |
3747
|[241] | | ![check]| ![check] |
3848

39-
[details=Older releases]
49+
### Release 210-211
50+
4051
| Revision | amd64 | arm64 | Ubuntu 22.04 LTS
4152
|:--------:|:-----:|:-----:|:-----:|
4253
|[210] |![check] | | ![check] |
@@ -81,6 +92,8 @@ Several [revisions](https://juju.is/docs/sdk/revision) are released simultaneous
8192
[/details]
8293

8394
<!-- LINKS -->
95+
[255]: https://github.com/canonical/mysql-k8s-operator/releases/tag/rev255
96+
[254]: https://github.com/canonical/mysql-k8s-operator/releases/tag/rev255
8497
[240]: https://github.com/canonical/mysql-k8s-operator/releases/tag/rev240
8598
[241]: https://github.com/canonical/mysql-k8s-operator/releases/tag/rev240
8699
[210]: https://github.com/canonical/mysql-k8s-operator/releases/tag/rev210

0 commit comments

Comments
 (0)