Skip to content

Commit 6a476ba

Browse files
committed
Included minimal viable readme
1 parent 89ba9ac commit 6a476ba

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,35 @@
1-
<!--
2-
Avoid using this README file for information that is maintained or published elsewhere, e.g.:
1+
# MySQL Test Application
32

4-
* metadata.yaml > published on Charmhub
5-
* documentation > published on (or linked to from) Charmhub
6-
* detailed contribution guide > documentation or CONTRIBUTING.md
3+
MySQL stack tester charm - this is a simple application used exclusively for integrations test of
4+
[mysql-k8s][mysql-k8s], [mysql][mysql], [mysql-router-k8s][mysql-router-k8s],
5+
[mysql-router][mysql-router], [mysql-bundle-k8s][mysql-bundle-k8s] and
6+
[mysql-bundle][mysql-bundle].
77

8-
Use links instead.
9-
-->
8+
## Relations
109

11-
# mysql-test-app
10+
This charm implements relations interfaces:
11+
* database
12+
* mysql (legacy)
1213

13-
Charmhub package name: operator-template
14-
More information: https://charmhub.io/mysql-test-app
14+
On using the `mysql` legacy relation interface with either [mysql] or [mysql-k8s] charms, its
15+
necessary to config the database name with:
1516

16-
Describe your charm in one or two sentences.
17+
```shell
18+
> juju config mysql-k8s mysql-interface-database=continuous_writes_database
19+
```
1720

18-
## Other resources
21+
## Actions
1922

20-
<!-- If your charm is documented somewhere else other than Charmhub, provide a link separately. -->
23+
Actions are listed on [actions page](https://charmhub.io/mysql-test-app/actions)
2124

22-
- [Read more](https://example.com)
2325

24-
- [Contributing](CONTRIBUTING.md) <!-- or link to other contribution documentation -->
26+
[mysql-k8s]: https://charmhub.io/mysql-k8s
27+
[mysql]: https://charmhub.io/mysql
28+
[mysql-router-k8s]: https://charmhub.io/mysql-router-k8s
29+
[mysql-router]: https://charmhub.io/mysql-router?channel=dpe/edge
30+
[mysql-bundle-k8s]: https://charmhub.io/mysql-bundle-k8s
31+
[mysql-bundle]: https://charmhub.io/mysql-bundle
2532

26-
- See the [Juju SDK documentation](https://juju.is/docs/sdk) for more information about developing and improving charms.
33+
## References
34+
35+
* [MySQL Test App at Charmhub](https://charmhub.io/mysql-test-app)

0 commit comments

Comments
 (0)