Skip to content

Commit d183cd4

Browse files
Sync docs from Discourse (#609)
Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 088c170 commit d183cd4

File tree

6 files changed

+176
-19
lines changed

6 files changed

+176
-19
lines changed

docs/explanation.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Explanation
2+
3+
Additional context about key concepts behind the MySQL K8s charm.
4+
5+
## Core concepts and design
6+
* [Architecture]
7+
* [Interfaces and endpoints]
8+
* [Juju]
9+
* [Legacy charm]
10+
11+
## Operational concepts
12+
* [Users]
13+
* [Logs]
14+
* [Audit logs]
15+
16+
## Security and hardening
17+
* [Security hardening guide][Security]
18+
* [Cryptography]
19+
20+
## Development
21+
* [Charm event flowcharts][Flowcharts]
22+
23+
<!-- Links -->
24+
25+
[Architecture]: /t/11757
26+
[Interfaces and endpoints]: /t/10249
27+
[Juju]: /t/11984
28+
[Legacy charm]: /t/11236
29+
30+
[Users]: /t/10791
31+
[Logs]: /t/12080
32+
[Audit logs]: /t/15423
33+
34+
[Security]: /t/16782
35+
[Cryptography]: /t/16783
36+
37+
[Flowcharts]: /t/10031

docs/how-to.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# How-to guides
2+
3+
Key processes and common tasks for managing and using Charmed MySQL on Kubernetes.
4+
5+
## Deployment and setup
6+
7+
Guidance for different cloud services:
8+
* [Canonical K8s]
9+
* [MicroK8s]
10+
* [GKE]
11+
* [EKS]
12+
* [AKS]
13+
* [Multi-AZ]
14+
15+
Specific deployment scenarios and architectures:
16+
* [Terraform]
17+
* [Air-gapped]
18+
19+
## Usage and maintenance
20+
* [Integrate with another application]
21+
* [External network access]
22+
* [Scale replicas]
23+
* [Enable TLS]
24+
25+
## Back up and restore
26+
* [Configure S3 AWS]
27+
* [Configure S3 RadosGW]
28+
* [Create a backup]
29+
* [Restore a backup]
30+
* [Migrate a cluster]
31+
32+
## Monitoring (COS)
33+
* [Enable monitoring]
34+
* [Enable alert rules]
35+
* [Enable tracing]
36+
37+
## Upgrades
38+
See the [Upgrades landing page] for more details.
39+
* [Upgrade Juju]
40+
* [Perform a minor upgrade]
41+
* [Perform a minor rollback]
42+
43+
## Cross-regional (cluster-cluster) async replication
44+
* [Deploy]
45+
* [Clients]
46+
* [Switchover / Failover]
47+
* [Recovery]
48+
* [Removal]
49+
50+
## Development
51+
* [Integrate with your charm]
52+
* [Migrate data via mysqldump]
53+
* [Migrate data via mydumper]
54+
* [Migrate data via backup/restore]
55+
* [Troubleshooting]
56+
57+
<!--Links-->
58+
59+
[Canonical K8s]: /t/15939
60+
[MicroK8s]: /t/11869
61+
[GKE]: /t/10875
62+
[EKS]: /t/12105
63+
[AKS]: /t/14306
64+
[Multi-AZ]: /t/15727
65+
[Terraform]: /t/14926
66+
[Air-gapped]: /t/15729
67+
68+
[Integrate with another application]: /t/9657
69+
[External network access]: /t/15728
70+
[Scale replicas]: /t/9659
71+
[Enable TLS]: /t/9655
72+
73+
[Configure S3 AWS]: /t/9651
74+
[Configure S3 RadosGW]: /t/10319
75+
[Create a backup]: /t/9653
76+
[Restore a backup]: /t/9663
77+
[Migrate a cluster]: /t/9661
78+
79+
[Enable monitoring]: /t/9981
80+
[Enable alert rules]: /t/15488
81+
[Enable tracing]: /t/14448
82+
83+
[Upgrades landing page]: /t/11754
84+
[Upgrade Juju]: /t/14333
85+
[Perform a minor upgrade]: /t/11752
86+
[Perform a minor rollback]: /t/11753
87+
88+
[Deploy]: /t/13458
89+
[Clients]: /t/13459
90+
[Switchover / Failover]: /t/13460
91+
[Recovery]: /t/13467
92+
[Removal]: /t/13468
93+
94+
[Integrate with your charm]: /t/11885
95+
[Migrate data via mysqldump]: /t/11992
96+
[Migrate data via mydumper]: /t/12006
97+
[Migrate data via backup/restore]: /t/12007
98+
[Troubleshooting]: /t/11886

docs/how-to/h-deploy-airgapped.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Canonical does not prescribe how you should set up your specific air-gapped envi
2626
## Air-gapped day-to-day example
2727

2828
**1.** Exporting K8s Charms and OCI Resources are currently independent processes.
29-
> Sseveral improvements are planned: [#1](https://warthogs.atlassian.net/browse/PF-5369), [#2](https://warthogs.atlassian.net/browse/PF-5185)
29+
> Several improvements are planned: [#1](https://warthogs.atlassian.net/browse/PF-5369), [#2](https://warthogs.atlassian.net/browse/PF-5185)
3030
3131
**1.1.** Charm. The necessary charm(s) can be exported as bundle OR independently (charm-by-charm). The special store-admin tool is designed to simplify the process. At the moment exporting of Charms and OCI resources are separated, but in the future the `store-admin export` [could](https://documentation.ubuntu.com/snap-store-proxy/en/airgap-charmhub/#export-charms) export all necessary OCI resource(s)) from official CharmHub.
3232

docs/overview.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,15 @@ Charmed MySQL K8s is an official distribution of MySQL. It’s an open-source pr
3232

3333
| Level | Path | Navlink |
3434
|---------|---------|-------------|
35-
| 1 | tutorial | [Tutorial]() |
36-
| 2 | t-overview | [Overview](/t/9677) |
35+
| 1 | tutorial | [Tutorial](/t/9677) |
3736
| 2 | t-set-up | [1. Set up the environment](/t/9679) |
3837
| 2 | t-deploy | [2. Deploy MySQL](/t/9667) |
3938
| 2 | t-scale | [3. Scale replicas](/t/9675) |
4039
| 2 | t-manage-passwords | [4. Manage passwords](/t/9673) |
4140
| 2 | t-integrate | [5. Integrate applications](/t/9671) |
4241
| 2 | t-enable-tls | [6. Enable TLS encryption](/t/9669) |
4342
| 2 | t-clean-up | [7. Clean up the environment](/t/9665) |
44-
| 1 | how-to | [How To]() |
43+
| 1 | how-to | [How-to guides](/t/17234) |
4544
| 2 | h-setup | [Deploy]() |
4645
| 3 | h-deploy-canonical-k8s | [Canonical K8s](/t/15939) |
4746
| 3 | h-deploy-microk8s | [MicroK8s](/t/11869) |
@@ -52,7 +51,7 @@ Charmed MySQL K8s is an official distribution of MySQL. It’s an open-source pr
5251
| 3 | h-deploy-terraform | [Terraform](/t/14926) |
5352
| 3 | h-deploy-airgapped | [Air-gapped](/t/15729) |
5453
| 2 | h-integrate| [Integrate with another application](/t/9657) |
55-
| 2 | h-external-access | [External access](/t/15728) |
54+
| 2 | h-external-access | [External network access](/t/15728) |
5655
| 2 | h-scale | [Scale replicas](/t/9659) |
5756
| 2 | h-enable-tls | [Enable TLS](/t/9655) |
5857
| 2 | h-backups | [Back up and restore]() |
@@ -69,39 +68,39 @@ Charmed MySQL K8s is an official distribution of MySQL. It’s an open-source pr
6968
| 3 | h-upgrade-juju | [Upgrade Juju](/t/14333) |
7069
| 3 | h-upgrade-minor | [Perform a minor upgrade](/t/11752) |
7170
| 3 | h-rollback-minor | [Perform a minor rollback](/t/11753) |
72-
| 2 | h-development| [Development]() |
73-
| 3 | h-development-integrate | [Integrate with your charm](/t/11885) |
74-
| 3 | h-migrate-mysqldump | [Migrate data via mysqldump](/t/11992) |
75-
| 3 | h-migrate-mydumper | [Migrate data via mydumper](/t/12006) |
76-
| 3 | h-migrate-backup-restore | [Migrate data via backup/restore](/t/12007) |
77-
| 3 | h-troubleshooting | [Troubleshooting](/t/11886) |
7871
| 2 | h-async | [Cross-regional async replication]() |
7972
| 3 | h-async-deployment | [Deploy](/t/13458) |
8073
| 3 | h-async-clients | [Clients](/t/13459) |
8174
| 3 | h-async-failover | [Switchover / Failover](/t/13460) |
8275
| 3 | h-async-recovery | [Recovery](/t/13467) |
8376
| 3 | h-async-removal | [Removal](/t/13468) |
77+
| 2 | h-development| [Development]() |
78+
| 3 | h-development-integrate | [Integrate with your charm](/t/11885) |
79+
| 3 | h-migrate-mysqldump | [Migrate data via mysqldump](/t/11992) |
80+
| 3 | h-migrate-mydumper | [Migrate data via mydumper](/t/12006) |
81+
| 3 | h-migrate-backup-restore | [Migrate data via backup/restore](/t/12007) |
82+
| 3 | h-troubleshooting | [Troubleshooting](/t/11886) |
8483
| 2 | h-contribute | [Contribute](/t/14655) |
85-
| 1 | reference | [Reference]() |
84+
| 1 | reference | [Reference](/t/17236) |
8685
| 2 | r-releases | [Releases](/t/11878) |
8786
| 2 | r-system-requirements | [System requirements](/t/11421) |
88-
| 2 | r-testing | [Testing](/t/11772) |
87+
| 2 | r-testing | [Software testing](/t/11772) |
8988
| 2 | r-profiles | [Profiles](/t/11892) |
9089
| 2 | r-plugins-extensions | [Plugins/extensions](/t/15482) |
9190
| 2 | r-alert-rules | [Alert rules](/t/15838) |
92-
| 2 | r-statuses | [Statuses](/t/11866) |
91+
| 2 | r-statuses | [Charm statuses](/t/11866) |
9392
| 2 | r-contacts | [Contacts](/t/11868) |
94-
| 1 | explanation | [Explanation]() |
93+
| 1 | explanation | [Explanation](/t/17238) |
9594
| 2 | e-architecture | [Architecture](/t/11757) |
9695
| 2 | e-interfaces-endpoints | [Interfaces/endpoints](/t/10249) |
96+
| 2 | e-juju | [Juju](/t/11984) |
97+
| 2 | e-legacy-charm | [Legacy charm](/t/11236) |
9798
| 2 | e-users | [Users](/t/10791) |
98-
| 2 | e-security | [Security](/t/16782) |
99-
| 2 | e-cryptography | [Cryptography](/t/16783) |
10099
| 2 | e-logs | [Logs](/t/12080) |
101100
| 3 | e-audit-logs | [Audit Logs](/t/15423) |
102-
| 2 | e-juju | [Juju](/t/11984) |
101+
| 2 | e-security | [Security](/t/16782) |
102+
| 2 | e-cryptography | [Cryptography](/t/16783) |
103103
| 2 | e-flowcharts | [Flowcharts](/t/10031) |
104-
| 2 | e-legacy-charm | [Legacy charm](/t/11236) |
105104
| 1 | search | [Search](https://canonical.com/data/docs/mysql/k8s) |
106105

107106
[/details]

docs/reference.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Reference
2+
3+
Technical specifications, APIs, release notes, and other reference material for fast lookup.
4+
5+
| Page | Description |
6+
|-------------------------|-------------------------------------------------|
7+
| [Releases](/t/11878) | Overview of all Charmed MySQL K8s releases |
8+
| [System requirements](/t/11421) | Software and hardware requirements |
9+
| [Software testing](/t/11772) | Software tests performed on this charm |
10+
| [Profiles](/t/11892) | Configurations related to performance |
11+
| [Plugins/extensions](/t/15482) | Supported plugins/extensions |
12+
| [Alert rules](/t/15838) | Pre-configured Prometheus alert rules |
13+
| [Charm statuses](/t/11866) | Juju application statuses |
14+
| [Contacts](/t/11868) | Contact information |
15+
16+
17+
In the tabs at the top of this charm's [CharmHub page](https://charmhub.io/mysql-k8s/), you will find the following automatically generated references:
18+
19+
| Page | Description |
20+
|----------|-------------------|
21+
| [Integrations](https://charmhub.io/mysql-k8s/integrations) | Integration/relation interfaces supported by this charm |
22+
| [Configuration](https://charmhub.io/mysql-k8s/configuration) | Configuration parameters specific to this charm |
23+
| [Actions](https://charmhub.io/mysql-k8s/actions) | Juju actions supported by this charm |
File renamed without changes.

0 commit comments

Comments
 (0)