You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Note:** The endpoint `mysql-root` provides the same legacy interface `mysql` with MySQL root-level privileges. It is NOT recommended to use it from security point of view.
99
99
100
100
## OCI Images
101
-
This charm uses pinned and tested version of the [charmed-mysql](https://github.com/canonical/charmed-mysql-rock/pkgs/container/charmed-mysql)ROCK image.
101
+
This charm uses pinned and tested version of the [charmed-mysql](https://github.com/canonical/charmed-mysql-rock/pkgs/container/charmed-mysql)rock.
102
102
103
103
## Security
104
104
Security issues in the Charmed MySQL K8s Operator can be reported through [LaunchPad](https://wiki.ubuntu.com/DebuggingSecurity#How%20to%20File). Please do not file GitHub issues about security issues.
Copy file name to clipboardExpand all lines: docs/explanation/e-architecture.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,13 +27,13 @@ And if you run `kubectl describe pod mysql-k8s-0`, all the containers will have
27
27
<aname="hld"></a>
28
28
## HLD (High Level Design)
29
29
30
-
The "Charmed MySQL K8s" (`workload` container) based on `mysql-image` resource defined in the [charm metadata.yaml](https://github.com/canonical/mysql-k8s-operator/blob/main/metadata.yaml). It is an official Canonical "[charmed-mysql](https://github.com/canonical/charmed-mysql-rock)" [OCI/ROCK](https://ubuntu.com/server/docs/rock-images/introduction) image, which is recursively based on Canonical SNAP “[charmed-mysql](https://snapcraft.io/charmed-mysql)” (read more about the SNAP details [here](/t/11756)).
30
+
The "Charmed MySQL K8s" (`workload` container) based on `mysql-image` resource defined in the [charm metadata.yaml](https://github.com/canonical/mysql-k8s-operator/blob/main/metadata.yaml). It is an official Canonical "[charmed-mysql](https://github.com/canonical/charmed-mysql-rock)" [OCI/Rock](https://ubuntu.com/server/docs/rock-images/introduction) image, which is recursively based on Canonical SNAP “[charmed-mysql](https://snapcraft.io/charmed-mysql)” (read more about the SNAP details [here](/t/11756)).
31
31
32
32
[Charmcraft](https://juju.is/docs/sdk/install-charmcraft) uploads an image as a [charm resource](https://charmhub.io/mysql-k8s/resources/mysql-image) to [Charmhub](https://charmhub.io/mysql-k8s) during the [publishing](https://github.com/canonical/mysql-k8s-operator/blob/main/.github/workflows/release.yaml#L40-L53), as described in the [Juju SDK How-to guides](https://juju.is/docs/sdk/publishing).
33
33
34
34
The charm supports Juju deploymed to all Kubernetes environments: [MicroK8s](https://microk8s.io/), [Charmed Kubernetes](https://ubuntu.com/kubernetes/charmed-k8s), [GKE](https://charmhub.io/mysql-k8s/docs/h-deploy-gke), [Amazon EKS](https://aws.amazon.com/eks/), ...
35
35
36
-
The OCI/ROCK ships the following components:
36
+
The OCI/Rock ships the following components:
37
37
38
38
* MySQL Community Edition (based on SNAP "[charmed-mysql](/t/11756)")
39
39
* MySQL Router (based on SNAP "[charmed-mysql](/t/11756)")
@@ -43,7 +43,7 @@ The OCI/ROCK ships the following components:
43
43
* Prometheus MySQL Router Exporter (based on SNAP "[charmed-mysql](/t/11756)")
44
44
* Prometheus Grafana dashboards and Loki alert rules are part of the charm revision and missing in SNAP.
45
45
46
-
SNAP-based ROCK images guaranties the same components versions and functionality between VM and K8s charm flavors.
46
+
SNAP-based rocks guarantee the same components versions and functionality between VM and K8s charm flavors.
47
47
48
48
Pebble runs layers of all the currently enabled services, e.g. monitoring, backups, etc:
49
49
```shell
@@ -78,7 +78,7 @@ All `exporter` services are activated after the relation with [COS Monitoring](/
78
78
79
79
> **:warning: Important:** all pebble resources must be executed under the proper user (defined in user:group options of pebble layer)!
80
80
81
-
The ROCK "charmed-mysql" also ships list of tools used by charm:
81
+
The rock "charmed-mysql" also ships list of tools used by charm:
82
82
*`mysql` - mysql client to connect `mysqld`.
83
83
*`mysqlsh` - new [mysql-shell](https://dev.mysql.com/doc/mysql-shell/8.0/en/) client to configure MySQL cluster.
84
84
*`xbcloud` - a tool to download and upload full or part of xbstream archive from/to the cloud.
@@ -136,7 +136,7 @@ Accordingly to the [Juju SDK](https://juju.is/docs/sdk/event): “an event is a
136
136
137
137
For this charm, the following events are observed:
138
138
139
-
1.[mysql_pebble_ready](https://juju.is/docs/sdk/container-name-pebble-ready-event): informs charm about the availability of the ROCK "charmed-mysql"-based `workload` K8s container. Also performs basic preparations to bootstrap the cluster on the first leader (or join the already configured cluster).
139
+
1.[mysql_pebble_ready](https://juju.is/docs/sdk/container-name-pebble-ready-event): informs charm about the availability of the rock "charmed-mysql"-based `workload` K8s container. Also performs basic preparations to bootstrap the cluster on the first leader (or join the already configured cluster).
140
140
2.[leader-elected](https://juju.is/docs/sdk/leader-elected-event): generate all the secrets to bootstrap the cluster.
141
141
5.[config_changed](https://juju.is/docs/sdk/config-changed-event): usually fired in response to a configuration change using the GUI or CLI. Create and set default cluster and cluster-set names in the peer relation databag (on the leader only).
142
142
6.[update-status](https://juju.is/docs/sdk/update-status-event): Takes care of workload health checks.
Copy file name to clipboardExpand all lines: docs/how-to/h-develop/h-develop-migratedataby/h-develop-backuprestore.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Before the data migration check all [limitations of the modern Charmed MySQL K8s
11
11
The approach:
12
12
13
13
* retrieve root/admin level credentials from legacy charm. See examples [here](/t/11992).
14
-
* install [Percona XtraBackup for MySQL](https://www.percona.com/software/mysql-database/percona-xtrabackup) inside the old charm OR remotely. Ensure version is compatible with xtrabackup in `Charmed MySQL K8s` revision you are going to deploy! See [examples](https://docs.percona.com/percona-xtrabackup/8.0/installation.html). BTW, you can use `charmed-mysql`[SNAP](https://snapcraft.io/charmed-mysql)/[ROCK](https://github.com/canonical/charmed-mysql-rock) directly (more details [here](/t/11757#hld)).
14
+
* install [Percona XtraBackup for MySQL](https://www.percona.com/software/mysql-database/percona-xtrabackup) inside the old charm OR remotely. Ensure version is compatible with xtrabackup in `Charmed MySQL K8s` revision you are going to deploy! See [examples](https://docs.percona.com/percona-xtrabackup/8.0/installation.html). BTW, you can use `charmed-mysql`[SNAP](https://snapcraft.io/charmed-mysql)/[rock](https://github.com/canonical/charmed-mysql-rock) directly (more details [here](/t/11757#hld)).
15
15
* configure storage for database backup (local or remote, S3-based is recommended).
16
16
* create a first full logical backup during the off-peak, [example of backup command](https://github.com/canonical/mysql-k8s-operator/blob/bc5f255e579033e2d501c3412d87913593ad62a3/lib/charms/mysql/v0/mysql.py#L2160-L2185).
17
17
*[restore the foreign backup](/t/9661) to Charmed MySQL Lab installation.
Copy file name to clipboardExpand all lines: docs/reference/r-requirements.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,11 +21,11 @@ Make sure your machine meets the following requirements:
21
21
- 8GB of RAM.
22
22
- 2 CPU threads.
23
23
- At least 20GB of available storage.
24
-
- Access to the internet for downloading the required OCI/ROCKs and charms.
24
+
- Access to the internet for downloading the required OCI/Rocks and charms.
25
25
26
26
## Supported architectures
27
27
28
-
The charm is based on [ROCK OCI](https://github.com/canonical/charmed-mysql-rock) named "[charmed-mysql](https://github.com/canonical/charmed-mysql-rock/pkgs/container/charmed-mysql)", which is recursively based on SNAP "[charmed-mysql](https://snapcraft.io/charmed-mysql)", which is currently available for `amd64` only! The architecture `arm64` support is planned. Please [contact us](https://chat.charmhub.io/charmhub/channels/data-platform) if you are interested in new architecture!
28
+
The charm is based on [Rock OCI](https://github.com/canonical/charmed-mysql-rock) named "[charmed-mysql](https://github.com/canonical/charmed-mysql-rock/pkgs/container/charmed-mysql)", which is recursively based on SNAP "[charmed-mysql](https://snapcraft.io/charmed-mysql)", which is currently available for `amd64` only! The architecture `arm64` support is planned. Please [contact us](https://chat.charmhub.io/charmhub/channels/data-platform) if you are interested in new architecture!
0 commit comments