Skip to content

Commit 37dc1e8

Browse files
chore: fix rocks terminology (#246)
## Issue "ROCK" should be "rock" ## Solution Replace all occurrences --------- Co-authored-by: Carl Csaposs <[email protected]>
1 parent 70c5495 commit 37dc1e8

File tree

7 files changed

+12
-12
lines changed

7 files changed

+12
-12
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Canonical Data issues are now public on both [Jira](https://warthogs.atlassian.n
2121
* Charmed MySQL Router K8s ships the latest MySQL Router “8.0.34-0ubuntu0.22.04.1”
2222
* CLI mysql-shell updated to "8.0.34-0ubuntu0.22.04.1~ppa1"
2323
* The Prometheus mysql-router-exporter is "4.0.5-0ubuntu0.22.04.1~ppa1"
24-
* 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)
24+
* K8s charms [based on our](https://github.com/orgs/canonical/packages?tab=packages&q=charmed) rock (Ubuntu LTS “22.04” - ubuntu:22.04-based)
2525
* Principal charms supports the latest LTS series “22.04” only.
2626

2727
## Technical notes:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Canonical Data issues are now public on both [Jira](https://warthogs.atlassian.n
2626
* Charmed MySQL Router K8s ships MySQL Router “8.0.34-0ubuntu0.22.04.1”
2727
* CLI mysql-shell version is "8.0.34-0ubuntu0.22.04.1~ppa1"
2828
* The Prometheus mysql-router-exporter is "4.0.5-0ubuntu0.22.04.1~ppa1"
29-
* 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
29+
* 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
3030
* Principal charms supports the latest LTS series “22.04” only
3131
* Subordinate charms support LTS “22.04” and “20.04” only
3232

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Canonical Data issues are now public on both [Jira](https://warthogs.atlassian.n
2424
* Charmed MySQL Router K8s ships MySQL Router “8.0.35-0ubuntu0.22.04.1”
2525
* CLI mysql-shell version is "8.0.35-0ubuntu0.22.04.1~ppa1"
2626
* The Prometheus mysql-router-exporter is "4.0.5-0ubuntu0.22.04.1~ppa1"
27-
* 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)
27+
* K8s charms [based on our](https://github.com/orgs/canonical/packages?tab=packages&q=charmed) rock (Ubuntu LTS “22.04” - ubuntu:22.04-based)
2828
* Principal charms supports the latest LTS series “22.04” only
2929

3030
## Technical notes:

docs/reference/r-requirements.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Make sure your machine meets the following requirements:
1818
- 8GB of RAM.
1919
- 2 CPU threads.
2020
- At least 20GB of available storage.
21-
- Access to the internet for downloading the required OCI/ROCKs and charms.
21+
- Access to the internet for downloading the required OCI/rocks and charms.
2222

2323
## Supported architectures
2424

25-
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](/t/12177) if you are interested in new architecture!
25+
The charm is based on [rock](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](/t/12177) if you are interested in new architecture!
2626

2727
<a name="mysql-gr-limits"></a>
2828
## Charmed MySQL K8s requirements

src/abstract_charm.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ def _subordinate_relation_endpoint_names(self) -> typing.Optional[typing.Iterabl
7777
@property
7878
@abc.abstractmethod
7979
def _container(self) -> container.Container:
80-
"""Workload container (snap or ROCK)"""
80+
"""Workload container (snap or rock)"""
8181

8282
@property
8383
@abc.abstractmethod

src/container.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Copyright 2023 Canonical Ltd.
22
# See LICENSE file for licensing details.
33

4-
"""Workload container (snap or ROCK/OCI)"""
4+
"""Workload container (snap or rock/OCI)"""
55

66
import abc
77
import pathlib
@@ -15,7 +15,7 @@
1515

1616

1717
class Path(pathlib.PurePosixPath, abc.ABC):
18-
"""Workload container (snap or ROCK) filesystem path"""
18+
"""Workload container (snap or rock) filesystem path"""
1919

2020
@property
2121
@abc.abstractmethod
@@ -62,7 +62,7 @@ def __init__(
6262

6363

6464
class Container(abc.ABC):
65-
"""Workload container (snap or ROCK)"""
65+
"""Workload container (snap or rock)"""
6666

6767
@property
6868
def router_config_directory(self) -> Path:

src/rock.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Copyright 2023 Canonical Ltd.
22
# See LICENSE file for licensing details.
33

4-
"""Workload ROCK or OCI container"""
4+
"""Workload rock or OCI container"""
55

66
import logging
77
import typing
@@ -20,7 +20,7 @@
2020

2121

2222
class _Path(container.Path):
23-
"""ROCK filesystem path"""
23+
"""Rock filesystem path"""
2424

2525
def __new__(cls, *args, container_: ops.Container):
2626
path = super().__new__(cls, *args)
@@ -72,7 +72,7 @@ def exists(self) -> bool:
7272

7373

7474
class Rock(container.Container):
75-
"""Workload ROCK or OCI container"""
75+
"""Workload rock or OCI container"""
7676

7777
_SERVICE_NAME = "mysql_router"
7878
_EXPORTER_SERVICE_NAME = "mysql_router_exporter"

0 commit comments

Comments
 (0)