From 4ff2058b23bbacbc6a5739fcb10bd6fc05029e09 Mon Sep 17 00:00:00 2001 From: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 8 Sep 2024 01:18:59 +0000 Subject: [PATCH] Sync docs from Discourse --- .../how-to/{h-setup => }/h-deploy-microk8s.md | 0 .../{h-setup => }/h-enable-encryption.md | 0 .../{h-monitor => }/h-enable-monitoring.md | 0 .../{h-monitor => }/h-enable-tracing.md | 2 +- docs/how-to/{h-setup => }/h-manage-app.md | 0 docs/how-to/{h-setup => }/h-manage-units.md | 0 .../{h-upgrade => }/h-rollback-major.md | 0 .../{h-upgrade => }/h-rollback-minor.md | 0 .../how-to/{h-upgrade => }/h-upgrade-intro.md | 0 .../how-to/{h-upgrade => }/h-upgrade-major.md | 0 .../how-to/{h-upgrade => }/h-upgrade-minor.md | 4 +- docs/{index.md => overview.md} | 94 ++++++++++-------- .../r-releases-rev117.md | 5 +- docs/reference/r-releases-rev155.md | 98 +++++++++++++++++++ .../r-releases-rev69.md | 0 .../r-releases-rev82.md | 0 .../r-releases-rev96.md | 0 .../{r-releases-group => }/r-releases.md | 3 +- ...t-cleanup-environment.md => t-clean-up.md} | 0 .../{t-deploy-charm.md => t-deploy.md} | 0 .../{t-enable-security.md => t-enable-tls.md} | 0 .../{t-overview.md => t-introduction.md} | 0 ...{t-managing-units.md => t-manage-units.md} | 0 .../{t-setup-environment.md => t-set-up.md} | 2 +- 24 files changed, 162 insertions(+), 46 deletions(-) rename docs/how-to/{h-setup => }/h-deploy-microk8s.md (100%) rename docs/how-to/{h-setup => }/h-enable-encryption.md (100%) rename docs/how-to/{h-monitor => }/h-enable-monitoring.md (100%) rename docs/how-to/{h-monitor => }/h-enable-tracing.md (99%) rename docs/how-to/{h-setup => }/h-manage-app.md (100%) rename docs/how-to/{h-setup => }/h-manage-units.md (100%) rename docs/how-to/{h-upgrade => }/h-rollback-major.md (100%) rename docs/how-to/{h-upgrade => }/h-rollback-minor.md (100%) rename docs/how-to/{h-upgrade => }/h-upgrade-intro.md (100%) rename docs/how-to/{h-upgrade => }/h-upgrade-major.md (100%) rename docs/how-to/{h-upgrade => }/h-upgrade-minor.md (98%) rename docs/{index.md => overview.md} (55%) rename docs/reference/{r-releases-group => }/r-releases-rev117.md (98%) create mode 100644 docs/reference/r-releases-rev155.md rename docs/reference/{r-releases-group => }/r-releases-rev69.md (100%) rename docs/reference/{r-releases-group => }/r-releases-rev82.md (100%) rename docs/reference/{r-releases-group => }/r-releases-rev96.md (100%) rename docs/reference/{r-releases-group => }/r-releases.md (83%) rename docs/tutorial/{t-cleanup-environment.md => t-clean-up.md} (100%) rename docs/tutorial/{t-deploy-charm.md => t-deploy.md} (100%) rename docs/tutorial/{t-enable-security.md => t-enable-tls.md} (100%) rename docs/tutorial/{t-overview.md => t-introduction.md} (100%) rename docs/tutorial/{t-managing-units.md => t-manage-units.md} (100%) rename docs/tutorial/{t-setup-environment.md => t-set-up.md} (98%) diff --git a/docs/how-to/h-setup/h-deploy-microk8s.md b/docs/how-to/h-deploy-microk8s.md similarity index 100% rename from docs/how-to/h-setup/h-deploy-microk8s.md rename to docs/how-to/h-deploy-microk8s.md diff --git a/docs/how-to/h-setup/h-enable-encryption.md b/docs/how-to/h-enable-encryption.md similarity index 100% rename from docs/how-to/h-setup/h-enable-encryption.md rename to docs/how-to/h-enable-encryption.md diff --git a/docs/how-to/h-monitor/h-enable-monitoring.md b/docs/how-to/h-enable-monitoring.md similarity index 100% rename from docs/how-to/h-monitor/h-enable-monitoring.md rename to docs/how-to/h-enable-monitoring.md diff --git a/docs/how-to/h-monitor/h-enable-tracing.md b/docs/how-to/h-enable-tracing.md similarity index 99% rename from docs/how-to/h-monitor/h-enable-tracing.md rename to docs/how-to/h-enable-tracing.md index 5c4492b1a..a39ef7af7 100644 --- a/docs/how-to/h-monitor/h-enable-tracing.md +++ b/docs/how-to/h-enable-tracing.md @@ -49,7 +49,7 @@ Integrate `tempo-k8s` with the COS charms as follows: ```shell juju integrate tempo-k8s:grafana-dashboard grafana:grafana-dashboard juju integrate tempo-k8s:grafana-source grafana:grafana-source -juju integrate tempo-k8s:ingress traefik:traefik +juju integrate tempo-k8s:ingress traefik:traefik-route juju integrate tempo-k8s:metrics-endpoint prometheus:metrics-endpoint juju integrate tempo-k8s:logging loki:logging ``` diff --git a/docs/how-to/h-setup/h-manage-app.md b/docs/how-to/h-manage-app.md similarity index 100% rename from docs/how-to/h-setup/h-manage-app.md rename to docs/how-to/h-manage-app.md diff --git a/docs/how-to/h-setup/h-manage-units.md b/docs/how-to/h-manage-units.md similarity index 100% rename from docs/how-to/h-setup/h-manage-units.md rename to docs/how-to/h-manage-units.md diff --git a/docs/how-to/h-upgrade/h-rollback-major.md b/docs/how-to/h-rollback-major.md similarity index 100% rename from docs/how-to/h-upgrade/h-rollback-major.md rename to docs/how-to/h-rollback-major.md diff --git a/docs/how-to/h-upgrade/h-rollback-minor.md b/docs/how-to/h-rollback-minor.md similarity index 100% rename from docs/how-to/h-upgrade/h-rollback-minor.md rename to docs/how-to/h-rollback-minor.md diff --git a/docs/how-to/h-upgrade/h-upgrade-intro.md b/docs/how-to/h-upgrade-intro.md similarity index 100% rename from docs/how-to/h-upgrade/h-upgrade-intro.md rename to docs/how-to/h-upgrade-intro.md diff --git a/docs/how-to/h-upgrade/h-upgrade-major.md b/docs/how-to/h-upgrade-major.md similarity index 100% rename from docs/how-to/h-upgrade/h-upgrade-major.md rename to docs/how-to/h-upgrade-major.md diff --git a/docs/how-to/h-upgrade/h-upgrade-minor.md b/docs/how-to/h-upgrade-minor.md similarity index 98% rename from docs/how-to/h-upgrade/h-upgrade-minor.md rename to docs/how-to/h-upgrade-minor.md index ba62e590c..0dfe276c9 100644 --- a/docs/how-to/h-upgrade/h-upgrade-minor.md +++ b/docs/how-to/h-upgrade-minor.md @@ -88,8 +88,8 @@ juju refresh mysql-router-k8s --channel 8.0/edge # example with channel selection and juju 3.x juju refresh mysql-router-k8s --channel 8.0/edge --trust -# example with specific revision selection -juju refresh mysql-router-k8s --revision=89 +# example with specific revision selection (do NOT miss OCI resource!) +juju refresh mysql-router-k8s --revision=89 --resource mysql-router-image=... ``` After the Router upgrade is completed, upgrade the Server: diff --git a/docs/index.md b/docs/overview.md similarity index 55% rename from docs/index.md rename to docs/overview.md index 293713786..a53c172ce 100644 --- a/docs/index.md +++ b/docs/overview.md @@ -24,42 +24,58 @@ This MySQL Router K8s charm is an official distribution of MySQL Router. It’s | [Tutorials](/t/12176)
Get started - a hands-on introduction to using Charmed MySQL operator for new users
| [How-to guides](/t/12233)
Step-by-step guides covering key operations and common tasks | | [Reference](/t/12201)
Technical information - specifications, APIs, architecture | [Explanation](/t/12223)
Concepts - discussion and clarification of key topics | -# Contents - -1. [Tutorial](tutorial) - 1. [1. Introduction](tutorial/t-overview.md) - 1. [2. Set up the environment](tutorial/t-setup-environment.md) - 1. [3. Deploy MySQL Router](tutorial/t-deploy-charm.md) - 1. [4. Manage units](tutorial/t-managing-units.md) - 1. [5. Enable security](tutorial/t-enable-security.md) - 1. [6. Cleanup environment](tutorial/t-cleanup-environment.md) -1. [How To](how-to) - 1. [Setup](how-to/h-setup) - 1. [Deploy on MicroK8s](how-to/h-setup/h-deploy-microk8s.md) - 1. [Manage units](how-to/h-setup/h-manage-units.md) - 1. [Enable encryption](how-to/h-setup/h-enable-encryption.md) - 1. [Manage applications](how-to/h-setup/h-manage-app.md) - 1. [Monitor (COS)](how-to/h-monitor) - 1. [Enable monitoring](how-to/h-monitor/h-enable-monitoring.md) - 1. [Enable tracing](how-to/h-monitor/h-enable-tracing.md) - 1. [Upgrade](how-to/h-upgrade) - 1. [Intro](how-to/h-upgrade/h-upgrade-intro.md) - 1. [Major upgrade](how-to/h-upgrade/h-upgrade-major.md) - 1. [Major rollback](how-to/h-upgrade/h-rollback-major.md) - 1. [Minor upgrade](how-to/h-upgrade/h-upgrade-minor.md) - 1. [Minor rollback](how-to/h-upgrade/h-rollback-minor.md) - 1. [Contribute](how-to/h-contribute.md) -1. [Reference](reference) - 1. [Release Notes](reference/r-releases-group) - 1. [All releases](reference/r-releases-group/r-releases.md) - 1. [Revision 117](reference/r-releases-group/r-releases-rev117.md) - 1. [Revision 96](reference/r-releases-group/r-releases-rev96.md) - 1. [Revision 82](reference/r-releases-group/r-releases-rev82.md) - 1. [Revision 69](reference/r-releases-group/r-releases-rev69.md) - 1. [Requirements](reference/r-requirements.md) - 1. [Testing](reference/r-testing.md) - 1. [Contacts](reference/r-contacts.md) -1. [Explanation](explanation) - 1. [Interfaces/endpoints](explanation/e-interfaces.md) - 1. [Statuses](explanation/e-statuses.md) - 1. [Juju](explanation/e-juju-details.md) \ No newline at end of file +# Navigation + +[details=Navigation] + +| Level | Path | Navlink | +|---------|---------|-------------| +| 1 | tutorial | [Tutorial]() | +| 2 | t-introduction | [1. Introduction](/t/12176) | +| 2 | t-set-up| [2. Set up the environment](/t/12178) | +| 2 | t-deploy | [3. Deploy MySQL Router](/t/12180) | +| 2 | t-manage-units | [4. Manage units](/t/12182) | +| 2 | t-enable-tls | [5. Enable TLS encryption](/t/12203) | +| 2 | t-clean-up | [6. Cleanup environment](/t/12204) | +| 1 | how-to | [How To]() | +| 2 | h-setup | [Setup]() | +| 3 | h-deploy-microk8s | [Deploy on MicroK8s](/t/12233) | +| 3 | h-manage-units | [Manage units](/t/12240) | +| 3 | h-enable-encryption | [Enable encryption](/t/12241) | +| 3 | h-manage-app | [Manage applications](/t/12242) | +| 2 | h-monitor | [Monitor (COS)]() | +| 3 | h-enable-monitoring | [Enable monitoring](/t/14101) | +| 3 | h-enable-tracing | [Enable tracing](/t/14553) | +| 2 | h-upgrade | [Upgrade]() | +| 3 | h-upgrade-intro | [Intro](/t/12235) | +| 3 | h-upgrade-major | [Major upgrade](/t/12236) | +| 3 | h-rollback-major | [Major rollback](/t/12237) | +| 3 | h-upgrade-minor | [Minor upgrade](/t/12238) | +| 3 | h-rollback-minor | [Minor rollback](/t/12239) | +| 2 | h-contribute | [Contribute](/t/14528) | +| 1 | reference | [Reference]() | +| 2 | r-releases-group | [Release Notes]() | +| 3 | r-releases | [All releases](/t/12201) | +| 3 | r-releases-rev155 | [Revision 154/155](/t/15354) | +| 3 | r-releases-rev117 | [Revision 117](/t/14074) | +| 3 | r-releases-rev96 | [Revision 96](/t/13523) | +| 3 | r-releases-rev82 | [Revision 82](/t/12796) | +| 3 | r-releases-rev69 | [Revision 69](/t/12202) | +| 2 | r-requirements | [Requirements](/t/12179) | +| 2 | r-testing | [Testing](/t/12234) | +| 2 | r-contacts | [Contacts](/t/12177) | +| 1 | explanation | [Explanation]() | +| 2 | e-interfaces | [Interfaces/endpoints](/t/12223) | +| 2 | e-statuses | [Statuses](/t/12231) | +| 2 | e-juju-details | [Juju](/t/12273) | + +[/details] + + + +# Redirects + +[details=Mapping table] +| Path | Location | +| ---- | -------- | +[/details] \ No newline at end of file diff --git a/docs/reference/r-releases-group/r-releases-rev117.md b/docs/reference/r-releases-rev117.md similarity index 98% rename from docs/reference/r-releases-group/r-releases-rev117.md rename to docs/reference/r-releases-rev117.md index adab141ab..05460b8ce 100644 --- a/docs/reference/r-releases-group/r-releases-rev117.md +++ b/docs/reference/r-releases-rev117.md @@ -1,7 +1,8 @@ >Reference > Release Notes > [All revisions](/t/12201) > Revision 117 -# Revision 117 (`8.0/candidate` only) -TODO: DD, MM, YYYY +# Revision 117 + +Aug 20, 2024 Dear community, diff --git a/docs/reference/r-releases-rev155.md b/docs/reference/r-releases-rev155.md new file mode 100644 index 000000000..2f03f1b75 --- /dev/null +++ b/docs/reference/r-releases-rev155.md @@ -0,0 +1,98 @@ +> Reference > Release Notes > [All releases] > Revision 154/155 + +# Revision 154/155 +September 2, 2024 + +Dear community, + +Canonical's newest Charmed MySQL Router K8s operator has been published in the [8.0/stable channel]. + +Due to the newly added support for arm64 architecture, the MySQL Router K8s charm now releases two revisions simultaneously: +* Revision 155 is built for `amd64` +* Revision 154 is built for `arm64` + +To make sure you deploy for the right architecture, we recommend setting an [architecture constraint](https://juju.is/docs/juju/constraint#heading--arch) for your entire Juju model. + +Otherwise, you can specify the architecture at deploy time with the `--constraints` flag as follows: + +```shell +juju deploy mysql-router-k8s --constraints arch= --trust +``` +where `` can be `amd64` or `arm64`. + +## Highlights + +Below is an overview of the major highlights, enhancements, and bugfixes in this revision. For a detailed list of all commits since the last stable release, see the [GitHub release notes]. + +* Upgraded MySQL Router from `v8.0.36` -> `v8.0.37` (see [Packaging](#packaging)) +* Added support for ARM architecture + +### Bugfixes + +* [[DPE-4173](https://warthogs.atlassian.net/browse/DPE-4173)] Stabilize exporter tests by using listen-port to avoid ephemeral ports in [#277](https://github.com/canonical/mysql-router-k8s-operator/pull/277) +* [[DPE-3881](https://warthogs.atlassian.net/browse/DPE-3881)] Use ruff as a linter and formatter in [#292](https://github.com/canonical/mysql-router-k8s-operator/pull/292) +* Use poetry package-mode=false in [#296](https://github.com/canonical/mysql-router-k8s-operator/pull/296) +* [[DPE-4739](https://warthogs.atlassian.net/browse/DPE-4739)] Avoid using time.sleep in rollback integration tests in [#298](https://github.com/canonical/mysql-router-k8s-operator/pull/298) +* [[DPE-4817](https://warthogs.atlassian.net/browse/DPE-4817)] Upgrade to use lok_push_api v1 and capture rotated log files in [#283](https://github.com/canonical/mysql-router-k8s-operator/pull/283) +* Update Python dependencies + +## Technical details +This section contains some technical details about the charm's contents and dependencies. + +* The K8s NodePort used to expose the DB service will change after every refresh which might lead to disconnections of clients sitting outside Juju. Check more details in [DPE-5276](https://warthogs.atlassian.net/browse/DPE-5276). + +If you are jumping over several stable revisions, check [previous release notes][All releases] before upgrading. + +### Requirements +See the [system requirements][] page for more details about software and hardware prerequisites. + +### Packaging +This charm is based on the [`charmed-mysql` rock] Revision TODO. It packages: +- mysql-router `v8.0.37` + - [8.0.37-0ubuntu0.22.04.1] +- mysql-shell `v8.0.37` + - [8.0.37+dfsg-0ubuntu0.22.04.1~ppa3] +- prometheus-mysqlrouter-exporter `v5.0.1` + - [5.0.1-0ubuntu0.22.04.1~ppa1] + +### Libraries and interfaces +* **mysql `v0`** + * See the [Libraries tab] in MySQL VM for the API reference. +* **grafana_agent `v0`** for integration with Grafana + * Implements `cos_agent` interface +* **rolling_ops `v0`** for rolling operations across units + * Implements `rolling_op` interface +* **tempo_k8s `v1`, `v2`** for integration with Tempo charm + * Implements `tracing` interface +* **tls_certificates_interface `v2`** for integration with TLS charms + * Implements `tls-certificates` interface + +See the [`/lib/charms` directory on GitHub][] for a full list of supported libraries. + +See the [Integrations tab][] for a full list of supported integrations/interfaces/endpoints + +## Contact us + +Charmed MySQL K8s is an open source project that warmly welcomes community contributions, suggestions, fixes, and constructive feedback. +* Raise software issues or feature requests on [**GitHub**](https://github.com/canonical/mysql-k8s-operator/issues) +* Report security issues through [**Launchpad**](https://wiki.ubuntu.com/DebuggingSecurity#How%20to%20File) +* Contact the Canonical Data Platform team through our [Matrix](https://matrix.to/#/#charmhub-data-platform:ubuntu.com) channel. + + +[8.0/stable channel]: https://charmhub.io/mysql-router-k8s?channel=8.0/stable +[GitHub release notes]: https://github.com/canonical/mysql-router-k8s-operator/releases/tag/rev155 + +[All releases]: /t/12201 +[system requirements]: /t/12179 + +[Integrations tab]: https://charmhub.io/mysql-router-k8s/integrations +[Libraries tab]: https://charmhub.io/mysql-router-k8s/libraries + +[`/lib/charms` directory on GitHub]: https://github.com/canonical/mysql-router-k8s-operator/tree/main/lib/charms + +[`charmed-mysql` rock]: https://snapcraft.io/charmed-mysql +[8.0.37-0ubuntu0.22.04.1]: https://launchpad.net/ubuntu/+source/mysql-8.0/8.0.37-0ubuntu0.24.04.1 +[8.0.37+dfsg-0ubuntu0.22.04.1~ppa3]: https://launchpad.net/~data-platform/+archive/ubuntu/mysql-shell +[0.14.0-0ubuntu0.22.04.1~ppa2]: https://launchpad.net/~data-platform/+archive/ubuntu/mysqld-exporter +[5.0.1-0ubuntu0.22.04.1~ppa1]: https://launchpad.net/~data-platform/+archive/ubuntu/mysqlrouter-exporter +[8.0.35-31-0ubuntu0.22.04.1~ppa3]: https://launchpad.net/~data-platform/+archive/ubuntu/xtrabackup \ No newline at end of file diff --git a/docs/reference/r-releases-group/r-releases-rev69.md b/docs/reference/r-releases-rev69.md similarity index 100% rename from docs/reference/r-releases-group/r-releases-rev69.md rename to docs/reference/r-releases-rev69.md diff --git a/docs/reference/r-releases-group/r-releases-rev82.md b/docs/reference/r-releases-rev82.md similarity index 100% rename from docs/reference/r-releases-group/r-releases-rev82.md rename to docs/reference/r-releases-rev82.md diff --git a/docs/reference/r-releases-group/r-releases-rev96.md b/docs/reference/r-releases-rev96.md similarity index 100% rename from docs/reference/r-releases-group/r-releases-rev96.md rename to docs/reference/r-releases-rev96.md diff --git a/docs/reference/r-releases-group/r-releases.md b/docs/reference/r-releases.md similarity index 83% rename from docs/reference/r-releases-group/r-releases.md rename to docs/reference/r-releases.md index 0ff426f9a..13b539136 100644 --- a/docs/reference/r-releases-group/r-releases.md +++ b/docs/reference/r-releases.md @@ -2,7 +2,8 @@ Canonical publishes here release notes for production ready revisions available in [CharmHub](https://charmhub.io) [channels](https://juju.is/docs/sdk/channel): -* [revision 117](/t/14074) in `8.0/candidate` (WIP) +* [revision 154/155](/t/15354) in `8.0/stable` +* [revision 117](/t/14074) in `8.0/stable` * [revision 96](/t/13523) in `8.0/stable` * [revision 82](/t/12796) in `8.0/stable` * [revision 69](/t/12202) in `8.0/stable` diff --git a/docs/tutorial/t-cleanup-environment.md b/docs/tutorial/t-clean-up.md similarity index 100% rename from docs/tutorial/t-cleanup-environment.md rename to docs/tutorial/t-clean-up.md diff --git a/docs/tutorial/t-deploy-charm.md b/docs/tutorial/t-deploy.md similarity index 100% rename from docs/tutorial/t-deploy-charm.md rename to docs/tutorial/t-deploy.md diff --git a/docs/tutorial/t-enable-security.md b/docs/tutorial/t-enable-tls.md similarity index 100% rename from docs/tutorial/t-enable-security.md rename to docs/tutorial/t-enable-tls.md diff --git a/docs/tutorial/t-overview.md b/docs/tutorial/t-introduction.md similarity index 100% rename from docs/tutorial/t-overview.md rename to docs/tutorial/t-introduction.md diff --git a/docs/tutorial/t-managing-units.md b/docs/tutorial/t-manage-units.md similarity index 100% rename from docs/tutorial/t-managing-units.md rename to docs/tutorial/t-manage-units.md diff --git a/docs/tutorial/t-setup-environment.md b/docs/tutorial/t-set-up.md similarity index 98% rename from docs/tutorial/t-setup-environment.md rename to docs/tutorial/t-set-up.md index 9061b3fd9..15a4f0b86 100644 --- a/docs/tutorial/t-setup-environment.md +++ b/docs/tutorial/t-set-up.md @@ -1,4 +1,4 @@ -# Environment Setup +# Set up your environment This is part of the [MySQL Router K8s Tutorial](/t/12176). Please refer to this page for more information and the overview of the content.