chore: fix rocks terminology (#417)

canonical · May 29, 2024 · d310ba9 · d310ba9
1 parent 6c09910
commit d310ba9
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -98,7 +98,7 @@ juju relate mysql-k8s:mysql wordpress-k8s:db
 **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.
 
 ## OCI Images
-This charm uses pinned and tested version of the [charmed-mysql](https://github.com/canonical/charmed-mysql-rock/pkgs/container/charmed-mysql) ROCK image.
+This charm uses pinned and tested version of the [charmed-mysql](https://github.com/canonical/charmed-mysql-rock/pkgs/container/charmed-mysql) rock.
 
 ## Security
 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.

diff --git a/docs/explanation/e-architecture.md b/docs/explanation/e-architecture.md
@@ -27,13 +27,13 @@ And if you run `kubectl describe pod mysql-k8s-0`, all the containers will have
 <a name="hld"></a>
 ## HLD (High Level Design)
 
-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)).
+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)).
 
 [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).
 
 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/), ...
 
-The OCI/ROCK ships the following components:
+The OCI/Rock ships the following components:
 
 * MySQL Community Edition (based on SNAP "[charmed-mysql](/t/11756)") 
 * MySQL Router (based on SNAP "[charmed-mysql](/t/11756)") 
@@ -43,7 +43,7 @@ The OCI/ROCK ships the following components:
 * Prometheus MySQL Router Exporter (based on SNAP "[charmed-mysql](/t/11756)") 
 * Prometheus Grafana dashboards and Loki alert rules are part of the charm revision and missing in SNAP.
 
-SNAP-based ROCK images guaranties the same components versions and functionality between VM and K8s charm flavors.
+SNAP-based rocks guarantee the same components versions and functionality between VM and K8s charm flavors.
 
 Pebble runs layers of all the currently enabled services, e.g. monitoring, backups, etc: 
 ```shell
@@ -78,7 +78,7 @@ All `exporter` services are activated after the relation with [COS Monitoring](/
 
 > **:warning: Important:** all pebble resources must be executed under the proper user (defined in  user:group options of pebble layer)!
 
-The ROCK "charmed-mysql" also ships list of tools used by charm:
+The rock "charmed-mysql" also ships list of tools used by charm:
 * `mysql` - mysql client to connect `mysqld`.
 * `mysqlsh` - new [mysql-shell](https://dev.mysql.com/doc/mysql-shell/8.0/en/) client to configure MySQL cluster.
 * `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
 
 For this charm, the following events are observed:
 
-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). 
+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). 
 2. [leader-elected](https://juju.is/docs/sdk/leader-elected-event): generate all the secrets to bootstrap the cluster.
 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).
 6. [update-status](https://juju.is/docs/sdk/update-status-event): Takes care of workload health checks.

diff --git a/docs/how-to/h-develop/h-develop-migratedataby/h-develop-backuprestore.md b/docs/how-to/h-develop/h-develop-migratedataby/h-develop-backuprestore.md
@@ -11,7 +11,7 @@ Before the data migration check all [limitations of the modern Charmed MySQL K8s
 The approach:
 
 * retrieve root/admin level credentials from legacy charm. See examples [here](/t/11992).
-* 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)).
+* 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)).
 * configure storage for database backup (local or remote, S3-based is recommended).
 * 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).
 * [restore the foreign backup](/t/9661) to Charmed MySQL Lab installation.

diff --git a/docs/reference/r-releases-group/r-releases-rev113.md b/docs/reference/r-releases-group/r-releases-rev113.md
@@ -30,7 +30,7 @@ Canonica Data issues are now public on both [Jira](https://warthogs.atlassian.ne
 * CLI mysql-shell updated to "8.0.34-0ubuntu0.22.04.1~ppa1"
 * Backup tools xtrabackup/xbcloud  updated to "8.0.34-29"
 * The Prometheus mysqld-exporter is "0.14.0-0ubuntu0.22.04.1~ppa1"
-* K8s charms [based on our](https://github.com/orgs/canonical/packages?tab=packages&q=charmed) ROCK OCI (Ubuntu LTS “22.04” - ubuntu:22.04-based) based on SNAP revision 69
+* K8s charms [based on our](https://github.com/orgs/canonical/packages?tab=packages&q=charmed) rock (Ubuntu LTS “22.04” - ubuntu:22.04-based) based on SNAP revision 69
 * Principal charms supports the latest LTS series “22.04” only
 * Subordinate charms support LTS “22.04” and “20.04” only
 

diff --git a/docs/reference/r-releases-group/r-releases-rev75.md b/docs/reference/r-releases-group/r-releases-rev75.md
@@ -22,7 +22,7 @@ Dear community, this is to inform you that new Canonical Charmed MySQL K8s charm
 ## What is inside the charms:
 
 * Charmed MySQL K8s charm ships the latest MySQL “8.0.32-0ubuntu0.22.04.2”
-* K8s charms [based on our](https://github.com/orgs/canonical/packages?tab=packages&q=charmed) ROCK OCI (Ubuntu LTS “22.04” - ubuntu:22.04-based)
+* K8s charms [based on our](https://github.com/orgs/canonical/packages?tab=packages&q=charmed) rock (Ubuntu LTS “22.04” - ubuntu:22.04-based)
 * Principal charms supports the latest LTS series “22.04” only.
 * Subordinate charms support LTS “22.04” and “20.04” only.
 
@@ -33,7 +33,7 @@ Compatibility with legacy charms:
 
 Please contact us, see details below, if you are considering migrating from other “legacy” charms not mentioned above. Additionally:
 * Tracks description:
-  * Charm MySQL K8s charm follows the SNAP track “8.0” (through repacked ROCK/OCI image).
+  * Charm MySQL K8s charm follows the SNAP track “8.0” (through repacked rock/OCI image).
 * No “latest” track in use (no surprises in tracking “latest/stable”)!
   * Charmed MySQL K8s charms provide [legacy charm](/t/11236) through “latest/stable”.
 * Charm lifecycle flowchart diagrams: [MySQL](https://github.com/canonical/mysql-k8s-operator/tree/main/docs/reference).

diff --git a/docs/reference/r-releases-group/r-releases-rev99.md b/docs/reference/r-releases-group/r-releases-rev99.md
@@ -44,7 +44,7 @@ Canonical Data issues are now public on both [Jira](https://warthogs.atlassian.n
 * CLI mysql-shell updated to "8.0.34-0ubuntu0.22.04.1~ppa1"
 * Backup tools xtrabackup/xbcloud  updated to "8.0.34-29"
 * The Prometheus mysqld-exporter is "0.14.0-0ubuntu0.22.04.1~ppa1"
-* K8s charms [based on our](https://github.com/orgs/canonical/packages?tab=packages&q=charmed) ROCK OCI (Ubuntu LTS “22.04” - ubuntu:22.04-based)
+* K8s charms [based on our](https://github.com/orgs/canonical/packages?tab=packages&q=charmed) rock (Ubuntu LTS “22.04” - ubuntu:22.04-based)
 * Principal charms supports the latest LTS series “22.04” only.
 * Subordinate charms support LTS “22.04” and “20.04” only.
 

diff --git a/docs/reference/r-requirements.md b/docs/reference/r-requirements.md
@@ -21,11 +21,11 @@ Make sure your machine meets the following requirements:
 - 8GB of RAM.
 - 2 CPU threads.
 - At least 20GB of available storage.
-- Access to the internet for downloading the required OCI/ROCKs and charms.
+- Access to the internet for downloading the required OCI/Rocks and charms.
 
 ## Supported architectures
 
-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!
+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!
 
 <a name="mysql-gr-limits"></a>
 ## MySQL Group Replication requirements